openecomp-be/lib/openecomp-common-lib/src/main/java/org/openecomp/sdc/common/errors/Messages.java

   1 /*
   2  * Copyright © 2016-2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.openecomp.sdc.common.errors;
  17
  18 import lombok.AllArgsConstructor;
  19 import lombok.Getter;
  20
  21 @AllArgsConstructor
  22 @Getter
  23 public enum Messages {
  24     // @formatter:off
  25     CANT_LOAD_HEALING_CLASS("Can't load healing class %s."),
  26     VERSION_UPGRADE("Item %s is of old version. A check out was made in order to get new " + "functionalities"),
  27     PACKAGE_PROCESS_ERROR("Could not process package '%s'"),
  28     PACKAGE_INVALID_EXTENSION("Invalid package '%s' extension. Expecting %s."),
  29     PACKAGE_EMPTY_ERROR("The given package is empty '%s'"),
  30     PACKAGE_PROCESS_INTERNAL_PACKAGE_ERROR("Could not process internal package '%s'"),
  31     PACKAGE_INVALID_ERROR("Invalid package content '%s'"),
  32     PACKAGE_MISSING_INTERNAL_PACKAGE("Missing expected internal package"),
  33     COULD_NOT_READ_MANIFEST_FILE("Could not read manifest file: %s [%s]"),
  34     INVALID_ZIP_FILE("Invalid zip file"),
  35     INVALID_CSAR_FILE("Invalid csar file"),
  36     CSAR_FILE_NOT_FOUND("Each CSAR file must contain %s file."),
  37     CSAR_DIRECTORIES_NOT_ALLOWED("Directory : %s , is not allowed."),
  38     CSAR_FILES_NOT_ALLOWED("File : %s , are not allowed."),
  39     MANIFEST_INVALID_LINE("Manifest contains invalid line: %s: %s"),
  40     MANIFEST_START_METADATA("Manifest must starts with 'metadata:'"),
  41     MANIFEST_NO_METADATA("Manifest must contain metadata"),
  42     MANIFEST_NO_SOURCES("Manifest must contain Source"),
  43     MANIFEST_METADATA_MISSING_ENTRY("Manifest metadata missing entry %s"),
  44     MANIFEST_INVALID_NAME("Manifest file %s and TOSCA definitions file %s must have the same name"),
  45     MANIFEST_INVALID_EXT("Manifest file must have extension \".mf\" "),
  46     MANIFEST_METADATA_INVALID_ENTRY("Manifest metadata should only have pnf or vnf entries"),
  47     MANIFEST_METADATA_INVALID_ENTRY1("Invalid Manifest metadata entry: '%s'."),
  48     MANIFEST_METADATA_DUPLICATED_ENTRY("Duplicated Manifest metadata entry: '%s'."),
  49     MANIFEST_METADATA_UNEXPECTED_ENTRY_TYPE("Manifest metadata should have either pnf or vnf entries, not both together"),
  50     MANIFEST_INVALID_PNF_METADATA("%s TOSCA.meta file is applicable for VF only"),
  51     MANIFEST_INVALID_NON_MANO_KEY("Invalid non mano key '%s'"),
  52     MANIFEST_EMPTY_NON_MANO_KEY("Expecting a 'Source' entry for the non mano key '%s'"),
  53     MANIFEST_EMPTY_NON_MANO_SOURCE("Empty non mano source"),
  54     MANIFEST_EXPECTED_HASH_ENTRY("Expected Hash entry"),
  55     MANIFEST_EXPECTED_HASH_VALUE("Expected Hash entry value"),
  56     MANIFEST_EXPECTED_SOURCE_PATH("Expected Source entry path"),
  57     MANIFEST_EXPECTED_ALGORITHM_VALUE("Expected Algorithm entry value"),
  58     MANIFEST_EXPECTED_ALGORITHM_BEFORE_HASH("Expected 'Algorithm' entry before 'Hash' entry"),
  59     MANIFEST_EXPECTED_SIGNATURE_VALUE("Expected 'Signature' entry value"),
  60     MANIFEST_EXPECTED_CERTIFICATE_VALUE("Expected 'Certificate' entry value"),
  61     MANIFEST_EXPECTED_SIGNATURE_BEFORE_CERTIFICATE("Expected 'Signature' entry before 'Certificate' entry"),
  62     MANIFEST_DUPLICATED_CMS_SIGNATURE("Duplicated CMS signature"),
  63     MANIFEST_SIGNATURE_DUPLICATED("Duplicated manifest signature"),
  64     MANIFEST_SIGNATURE_LAST_ENTRY("The manifest signature must be the last entry of the manifest."),
  65     MANIFEST_METADATA_DOES_NOT_MATCH_LIMIT("Manifest metadata must only have the required number [%s] of " + "entries"),
  66     MANIFEST_EMPTY("The manifest is empty"),
  67     MANIFEST_ERROR_WITH_LINE("%s;%nAt line %s: '%s'."),
  68     MANIFEST_PARSER_INTERNAL("Invalid manifest file"),
  69     MANIFEST_UNEXPECTED_ERROR("An unexpected error occurred while validating manifest '%s': %s"),
  70     MANIFEST_VALIDATION_HELM_IS_BASE_MISSING("Definition of 'isBase' is missing in %d charts."),
  71     MANIFEST_VALIDATION_HELM_IS_BASE_NOT_UNIQUE("More than one chart is marked as 'isBase'."),
  72     MANIFEST_VALIDATION_HELM_IS_BASE_NOT_SET("None of charts is marked as 'isBase'."),
  73     METADATA_PARSER_INTERNAL("Invalid Metadata file"),
  74     METADATA_MISSING_OPTIONAL_FOLDERS("Missing folder %s in package"),
  75     METADATA_UNSUPPORTED_ENTRY("Following entry not supported in TOSCA.meta %s"),
  76     METADATA_INVALID_VERSION("Invalid entry %s value %s"),
  77     METADATA_INVALID_VALUE("Invalid value %s in TOSCA.meta file"),
  78     METADATA_MISSING_ENTRY("TOSCA.meta file in TOSCA-metadata directory missing entry %s"),
  79     METADATA_NO_ENTRY_DEFINITIONS("TOSCA.meta must contain Entry Definitions"),
  80     METADATA_INVALID_ENTRY_DEFINITIONS("TOSCA.meta must contain key:value entries"),
  81     EMPTY_SW_INFORMATION_NON_MANO_ERROR("Non-mano Software Information artifact was declared in the manifest, but not provided"),
  82     UNIQUE_SW_INFORMATION_NON_MANO_ERROR("Only one software information non-mano artifact is allowed. " + "Found %s."),
  83     INVALID_SW_INFORMATION_NON_MANO_ERROR("Invalid software information non-mano artifact: '%s'"),
  84     INCORRECT_SW_INFORMATION_NON_MANO_ERROR("Incorrect software information non-mano artifact. The software version information is missing or it has "
  85         + "one or more incorrect software version entries: '%s'"),
  86     EMPTY_ONAP_CNF_HELM_NON_MANO_ERROR("Non-mano onap_cnf_helm artifact was declared in the manifest, but not provided"),
  87     UNIQUE_ONAP_CNF_HELM_NON_MANO_ERROR("Only one onap_cnf_helm non-mano artifact is allowed. " + "Found %s."),
  88     FAILED_TO_VALIDATE_METADATA("Failed to validate metadata file"),
  89     ARTIFACT_INVALID_SIGNATURE("Invalid signature '%s' provided for artifact '%s'"),
  90     ARTIFACT_SIGNATURE_VALIDATION_ERROR("Could not validate signature '%s' provided for artifact '%s' with certificate '%s': %s"),
  91     FAILED_TO_TRANSLATE_ZIP_FILE("Failed to translate zip file"),
  92     ZIP_NOT_EXIST("Zip file doesn't exist"),
  93     PERMISSIONS_ERROR("Permissions Error. The user does not have permission to perform this action."),
  94     PERMISSIONS_OWNER_ERROR("Permissions Error. Only one owner is allowed."),
  95     ENTITY_NOT_FOUND("Incorrect item/version details provided."),
  96     SUB_ENTITY_NOT_FOUND("Incorrect sub entity details provided."),
  97     FAILED_TO_SYNC("Non existing version cannot be synced."),
  98     FAILED_TO_PUBLISH_OUT_OF_SYNC("Publish is not allowed since the version status is Out of sync"),
  99     DELETE_VSP_ERROR("VSP has been certified and cannot be deleted."),
 100     DELETE_VLM_ERROR("VLM has been certified and cannot be deleted."),
 101     ZIP_SHOULD_NOT_CONTAIN_FOLDERS("Zip file should not contain folders"),
 102     VES_ZIP_SHOULD_CONTAIN_YML_ONLY("Wrong VES EVENT Artifact was uploaded - all files contained in Artifact must be YAML files"
 103         + " (using .yaml/.yml extensions)"),
 104     MANIFEST_NOT_EXIST("Manifest doesn't exist"),
 105     MANIFEST_NOT_FOUND("Manifest file %s referenced in TOSCA.meta does not exist"),
 106     FILE_TYPE_NOT_LEGAL("File type not legal as data for other file"),
 107     MODULE_IN_MANIFEST_NO_YAML("Module '%s', has no yaml file reference"),
 108     NO_MODULES_IN_MANIFEST("At least one Base/Module must be defined \n"),
 109     MODULE_IN_MANIFEST_VOL_ENV_NO_VOL("Module '%s', has volume Env. reference with no Volume " + "reference"),
 110     ILLEGAL_MANIFEST("Illegal Manifest"),
 111     NO_FILE_WAS_UPLOADED_OR_FILE_NOT_EXIST("no %s file was uploaded or file doesn't exist"),
 112     MAPPING_OBJECTS_FAILURE("Failed to map object %s to %s. Exception message: %s"),
 113     MORE_THEN_ONE_VOL_FOR_HEAT("heat contains more then one vol. selecting only first vol"),
 114     FILE_LOAD_CONTENT_ERROR("Failed to load file '%s' content"),
 115     CREATE_MANIFEST_FROM_ZIP("cannot create manifest from the attached zip file"),
 116     CANDIDATE_PROCESS_FAILED("Candidate zip file process failed"),
 117     FOUND_UNASSIGNED_FILES("cannot process zip since it has unassigned files"),
 118     GENERATED_ARTIFACT_IN_USE("Artifact with file name %s is generated by SDC. " + "Please remove this artifact from manifest and zip files"),
 119     /* Monitor uploads related errors*/
 120     ILLEGAL_MONITORING_ARTIFACT_TYPE("Illegal monitoring artifact type for component id %s, vsp id %s"),
 121     /* manifest errors*/
 122     MISSING_FILE_IN_ZIP("Missing file in zip"),
 123     MISSING_FILE_IN_MANIFEST("Missing file in manifest"),
 124     MISSING_FILE_NAME_IN_MANIFEST("Missing file name in manifest"),
 125     MISSING_NESTED_FILE("Missing nested file - %s"),
 126     MISSING_ARTIFACT("Missing artifact - %s"),
 127     MISSING_MANIFEST_SOURCE("%s artifact %s referenced in manifest file does not exist"),
 128     MISSING_MANIFEST_REFERENCE("'%s' artifact is not being referenced in manifest file"),
 129     MISSING_METADATA_FILES("%s file referenced in TOSCA.meta does not exist"),
 130     WRONG_HEAT_FILE_EXTENSION("Wrong HEAT file extension - %s"),
 131     WRONG_ENV_FILE_EXTENSION("Wrong ENV file extension - %s"),
 132     INVALID_MANIFEST_FILE("invalid manifest file"),
 133     INVALID_FILE_TYPE("Missing or Unknown file type in Manifest"),
 134     ENV_NOT_ASSOCIATED_TO_HEAT("ENV file must be associated to a HEAT file"),
 135     CSAR_MANIFEST_FILE_NOT_EXIST("CSAR manifest file does not exist"),
 136     CSAR_FAILED_TO_READ("CSAR file is not readable"),
 137     TOSCA_PARSING_FAILURE("Invalid tosca file. Error code : %s, Error message : %s/"),
 138     /*definition errors*/
 139     MISSING_DEFINITION_FILE("Definition file %s referenced in TOSCA.meta does not exist"),
 140     MISSING_IMPORT_FILE("Package must contain the referenced import file '%s'"),
 141     MISSING_MAIN_DEFINITION_FILE("Package must contain the given main definition file '%s'"),
 142     INVALID_IMPORT_STATEMENT("Definition file '%s' contains an invalid import statement: '%s'"),
 143     INVALID_YAML_EXTENSION("Expecting yaml or yml extension for file: %s"),
 144     /* content errors*/
 145     INVALID_YAML_FORMAT("Invalid YAML format: %s"),
 146     INVALID_YAML_FORMAT_1("Invalid YAML format in file '%s'. Format error:%n%s"),
 147     INVALID_YAML_FORMAT_REASON("Invalid YAML format Problem - [%s]"),
 148     EMPTY_YAML_FILE("empty yaml"),
 149     EMPTY_YAML_FILE_1("The yaml file '%s' is empty"),
 150     GENERAL_YAML_PARSER_ERROR("general parser error"),
 151     GENERAL_HEAT_PARSER_ERROR("general parser error"),
 152     INVALID_HEAT_FORMAT_REASON("Invalid HEAT format problem - [%s]"),
 153     MISSING_RESOURCE_IN_DEPENDS_ON("a Missing resource in depend On, Missing Resource ID [%s]"),
 154     REFERENCED_PARAMETER_NOT_FOUND("Referenced parameter - %s - not found, used in resource [%s]"),
 155     GET_ATTR_NOT_FOUND("get_attr attribute not found, Attribute name [%s], Resource ID [%s]"),
 156     MISSING_PARAMETER_IN_NESTED("Referenced parameter not found in nested file - %s, parameter name [%s], Resource ID [%s]"),
 157     NESTED_LOOP("Nested files loop - %s"),
 158     MORE_THAN_ONE_BIND_FROM_NOVA_TO_PORT("Resource Port %s exceed allowed relations from NovaServer"),
 159     SERVER_NOT_DEFINED_FROM_NOVA("Missing server group definition - %s, %s"),
 160     WRONG_POLICY_IN_SERVER_GROUP("Wrong policy in server group - %s"),
 161     MISSING_IMAGE_AND_FLAVOR("Missing both Image and Flavor in NOVA Server, Resource ID [%s]"),
 162     ENV_INCLUDES_PARAMETER_NOT_IN_HEAT("Env file %s includes a parameter not in HEAT - %s"),
 163     PARAMETER_ENV_VALUE_NOT_ALIGN_WITH_TYPE("Parameter env value %s not align with type"),
 164     PARAMETER_DEFAULT_VALUE_NOT_ALIGN_WITH_TYPE("Parameter - %s default value not align with type %s"),
 165     INVALID_RESOURCE_TYPE("A resource has an invalid or unsupported type - %s, Resource ID [%s]"),
 166     ARTIFACT_FILE_NOT_REFERENCED("Artifact file is not referenced."),
 167     RESOURCE_NOT_IN_USE("%s not in use, Resource Id [%s]"),
 168     PORT_NO_BIND_TO_ANY_NOVA_SERVER("Port not bind to any NOVA Server, Resource Id [%s]"),
 169     INVALID_GET_RESOURCE_SYNTAX("invalid get_resource syntax is in use - %s , get_resource function should get the resource id of the "
 170         + "referenced resource"),
 171     INVALID_RESOURCE_GROUP_TYPE("OS::Heat::ResourceGroup resource with resource_def which is not pointing to nested heat file is not supported, "
 172         + "Resource ID [%s], resource_def type [%s]"),
 173     WRONG_VALUE_TYPE_ASSIGNED_NESTED_INPUT("Wrong value type assigned to a nested input parameter, nested resource [%s], property name [%s], "
 174         + "nested file [%s]"),
 175     NOVA_NAME_IMAGE_FLAVOR_NOT_CONSISTENT("Nova Server naming convention in image, flavor and name properties is not consistent, Resource ID [%s]"),
 176     RESOURCE_GROUP_INVALID_INDEX_VAR("Wrong value assigned to a ResourceGroup index_var property (functions are not allowed but only strings),"
 177         + " Resource ID [%s]"),
 178     CONTRAIL_2_IN_USE("Contrail 2.x deprecated resource is in use, Resource ID [%s]"),
 179     /* warnings */
 180     REFERENCED_RESOURCE_NOT_FOUND("Referenced resource - %s not found"),
 181     MISSING_GET_PARAM("Missing get_param in %s, Resource Id [%s]"),
 182     /*OPENECOMP Guide lines*/
 183     MISSING_NOVA_SERVER_METADATA("Missing Nova Server Metadata property, Resource ID [%s]"),
 184     MISSING_NOVA_SERVER_VNF_ID("Missing VNF_ID in Metadata property, Resource ID [%s]"),
 185     MISSING_NOVA_SERVER_VF_MODULE_ID("Missing VF_MODULE_ID in Metadata property, Resource id [%s]"),
 186     NETWORK_PARAM_NOT_ALIGNED_WITH_GUIDE_LINE("Network Parameter Name not aligned with Guidelines, Parameter Name [%s] Resource ID [%s]"),
 187     MISSIN_BASE_HEAT_FILE("Missing Base HEAT. Pay attention that without Base HEAT, there will be no shared resources"),
 188     MULTI_BASE_HEAT_FILE("Multi Base HEAT. Expected only one. Files %s."),
 189     RESOURCE_NOT_DEFINED_IN_OUTPUT("Resource is not defined as output and thus cannot be Shared, Resource ID [%s]"),
 190     RESOURCE_CONNECTED_TO_TWO_EXTERNAL_NETWORKS_WITH_SAME_ROLE("A resource is connected twice to the same network role, Network Role [%s], "
 191         + "Resource ID [%s]"),
 192     VOLUME_HEAT_NOT_EXPOSED("Volume is not defined as output and thus cannot be attached %s"),
 193     FORBIDDEN_RESOURCE_IN_USE("%s is in use, Resource ID [%s]"),
 194     PARAMETER_NAME_NOT_ALIGNED_WITH_GUIDELINES("%s '%s' Parameter Name not aligned with Guidelines, Parameter Name [%s], Resource ID [%s]."
 195         + " As a result, VF/VFC Profile may miss this information"),
 196     /* Contrail validator messages*/
 197     MERGE_OF_CONTRAIL2_AND_CONTRAIL3_RESOURCES("HEAT Package includes both Contrail 2 and Contrail 3 resources. "
 198         + "Contrail 2 resources can be found in %s. Contrail 3 resources can be found in %s"),
 199     CONTRAIL_VM_TYPE_NAME_NOT_ALIGNED_WITH_NAMING_CONVENSION("Service Template naming convention in Image and Flavor "
 200         + "properties is not consistent in Resource, Resource ID %s"),
 201     /* Notifications */
 202     FAILED_TO_MARK_NOTIFICATION_AS_READ("Failed to mark notifications as read"),
 203     FAILED_TO_UPDATE_LAST_SEEN_NOTIFICATION("Failed to update last seen notification for user %s"),
 204     FAILED_TO_VERIFY_SIGNATURE("Could not verify signature of signed package."),
 205     EXTERNAL_CSAR_STORE_CONFIGURATION_FAILURE_MISSING("externalCsarStore configuration failure, missing '%s'"),
 206     ERROR_HAS_OCCURRED_WHILE_PERSISTING_THE_ARTIFACT("An error has occurred while persisting the artifact: %s"),
 207     ERROR_HAS_OCCURRED_WHILE_REDUCING_THE_ARTIFACT_SIZE("An error has occurred while reducing the artifact's size: %s"),
 208     UNEXPECTED_PROBLEM_HAPPENED_WHILE_GETTING("An unexpected problem happened while getting '%s'");
 209     // @formatter:on
 210
 211     private String errorMessage;
 212
 213     /**
 214      * Formats the message with the given parameters.
 215      *
 216      * @param params The message string parameters to apply
 217      * @return The formatted message.
 218      */
 219     public String formatMessage(final Object... params) {
 220         return String.format(errorMessage, params);
 221     }
 222 }