ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/logging/format/EPAppMessagesEnum.java

   1 /*-\r
   2  * ================================================================================\r
   3  * ECOMP Portal\r
   4  * ================================================================================\r
   5  * Copyright (C) 2017 AT&T Intellectual Property\r
   6  * ================================================================================\r
   7  * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * you may not use this file except in compliance with the License.\r
   9  * You may obtain a copy of the License at\r
  10  * \r
  11  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * \r
  13  * Unless required by applicable law or agreed to in writing, software\r
  14  * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * See the License for the specific language governing permissions and\r
  17  * limitations under the License.\r
  18  * ================================================================================\r
  19  */\r
  20 package org.openecomp.portalapp.portal.logging.format;\r
  21 \r
  22 import org.openecomp.portalsdk.core.logging.format.AlarmSeverityEnum;\r
  23 import org.openecomp.portalsdk.core.logging.format.ErrorSeverityEnum;\r
  24 import org.openecomp.portalsdk.core.logging.format.ErrorTypeEnum;\r
  25 \r
  26 /**\r
  27  * \r
  28  * @author rc580q\r
  29  * Add ECOMP Portal Specific Error Code Enums here, for generic\r
  30  * ones (ones you think are useful not only Portal but also SDK), add it\r
  31  * to the enum class AppMessagesEnum defined in SDK.\r
  32  */\r
  33 public enum EPAppMessagesEnum {\r
  34         /*\r
  35         100-199 Security/Permission Related \r
  36                                                                                 - Authentication problems (from external client, to external server)\r
  37                                                                                 - Certification errors\r
  38                                                                                 - \r
  39                                                                                         \r
  40         200-299 Availability/Timeout Related\r
  41                                                                                 - connectivity error\r
  42                                                                                 - connection timeout\r
  43                                                                                 \r
  44         300-399 Data Access/Integrity Related\r
  45                                                                                 - Data in graph in invalid(E.g. no creator is found for service) \r
  46                                                                                 - Artifact is missing in ES, but exists in graph.\r
  47                                                                                  \r
  48         400-499 Schema Interface Type/Validation\r
  49                                                                                 - received Pay-load checksum is invalid\r
  50                                                                                 - received JSON is not valid\r
  51                                                           \r
  52         500-599 Business/Flow Processing Related  \r
  53                                                                                 -  check out to service is not allowed\r
  54                                                                                 -  Roll-back is done\r
  55                                                                                 -  failed to generate heat file\r
  56                                                                                   \r
  57 \r
  58         600-899 Reserved - do not use\r
  59 \r
  60         900-999 Unknown Errors \r
  61                                                                                 - Unexpected exception\r
  62                                                                                 */\r
  63         \r
  64         BeUebAuthenticationError(EPErrorCodesEnum.BEUEBAUTHENTICATIONERROR_ONE_ARGUMENT, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
  65                                                                 "ERR100E", "An Authentication failure occurred during access to UEB server", "Details: {0}.", "Please check UEB server list and keys configured under Portal.Properties file."),\r
  66         \r
  67         BeRestApiAuthenticationError(EPErrorCodesEnum.BERESTAPIAUTHENTICATIONERROR, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
  68                                                                 "ERR101E", "Rejected an incoming REST API request due to invalid credentials", "", "Please check application credentials defined in Database or properties files."),\r
  69         \r
  70         InternalAuthenticationInfo(EPErrorCodesEnum.INTERNALAUTHENTICATIONINFO_ONE_ARGUMENT, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
  71                                                                 "ERR199I", "Internal authentication problem", "Details: {0}.", "Please check the logs for more information."),\r
  72         \r
  73         InternalAuthenticationWarning(EPErrorCodesEnum.INTERNALAUTHENTICATIONWARNING_ONE_ARGUMENT, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.WARN,\r
  74                                                                 "ERR199W", "Internal authentication problem", "Details: {0}.", "Please check the logs for more information."),\r
  75         \r
  76         InternalAuthenticationError(EPErrorCodesEnum.INTERNALAUTHENTICATIONERROR_ONE_ARGUMENT, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
  77                                                                 "ERR199E", "Internal authentication problem", "Details: {0}.", "Please check the logs for more information."),\r
  78         \r
  79         InternalAuthenticationFatal(EPErrorCodesEnum.INTERNALAUTHENTICATIONFATAL_ONE_ARGUMENT, ErrorTypeEnum.AUTHENTICATION_PROBLEM, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.FATAL,\r
  80                                                                 "ERR199F", "Internal authentication problem", "Details: {0}.", "Please check the logs for more information."),\r
  81         \r
  82         BeHealthCheckError(EPErrorCodesEnum.BeHEALTHCHECKERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
  83                                                                 "ERR200E", "ECOMP-PORTAL Back-end probably lost connectivity to either one of the following components: MySQL DB, UEB Cluster", "", "Please check the logs for more information."),\r
  84 \r
  85         BeHealthCheckMySqlError(EPErrorCodesEnum.BEHEALTHCHECKMYSQLERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
  86                                                                 "ERR201E", "ECOMP-PORTAL Back-end probably lost connectivity to MySQL DB", "", "Check connectivity to MYSQL is configured correctly under system.properties file."),\r
  87 \r
  88         BeHealthCheckUebClusterError(EPErrorCodesEnum.BEHEALTHCHECKUEBCLUSTERERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
  89                                                                 "ERR203E", "ECOMP-PORTAL Back-end probably lost connectivity to UEB Cluster", "", "Check connectivity to UEB cluster which is configured under portal.properties file."),\r
  90         \r
  91         FeHealthCheckError(EPErrorCodesEnum.FEHEALTHCHECKERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
  92                                                                 "ERR204E", "Unable to connect to a valid ECOMP-PORTAL Back-end Server.", "", "Please check connectivity from this FE instance towards BE or BE Load Balancer."),\r
  93         \r
  94         BeHealthCheckRecovery(EPErrorCodesEnum.BEHEALTHCHECKRECOVERY, ErrorTypeEnum.RECOVERY, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
  95                                                                 "ERR205I", "ECOMP-PORTAL Back-end Recovery to either one of the following components: MySQL DB, UEB Cluster", "", "Please check logs for more specific information about the problem."),\r
  96         \r
  97         BeHealthCheckMySqlRecovery(EPErrorCodesEnum.BEHEALTHCHECKMYSQLRECOVERY, ErrorTypeEnum.RECOVERY, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
  98                                                                 "ERR206I", "ECOMP-PORTAL Back-end connection recovery to MySQL DB", "", "Please check logs for more specific information about the problem."),\r
  99         \r
 100         BeHealthCheckUebClusterRecovery(EPErrorCodesEnum.BEHEALTHCHECKUEBCLUSTERRECOVERY, ErrorTypeEnum.RECOVERY, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
 101                                                                 "ERR208I", "ECOMP-PORTAL Back-end connection recovery to UEB Cluster", "", "Please check logs for more specific information about the problem."),\r
 102         \r
 103         FeHealthCheckRecovery(EPErrorCodesEnum.FEHEALTHCHECKRECOVERY, ErrorTypeEnum.RECOVERY, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
 104                                                                 "ERR209I", "Connectivity to ECOMP-PORTAL Front-end Server is recovered", "", "Please check logs for more specific information about the problem."),\r
 105     \r
 106         BeUebConnectionError(EPErrorCodesEnum.BEUEBCONNECTIONERROR_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 107                                                         "ERR210E", "ECOMP-PORTAL Back-end probably lost connectivity to UEB Cluster", "Details: {0}.", "Please check UEB server list and keys configured under Portal.Properties file."),\r
 108     \r
 109     BeUebUnkownHostError(EPErrorCodesEnum.BEUEBUNKOWNHOSTERROR_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 110                                                         "ERR211E", "ECOMP-PORTAL Back-end probably lost connectivity to UEB Cluster", "Cannot reach host: {0}.", "Please check UEB server list and keys configured under Portal.Properties file."),\r
 111         \r
 112     BeUebRegisterOnboardingAppError(EPErrorCodesEnum.BEUEBREGISTERONBOARDINGAPPERROR, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 113                                                         "ERR212E", "Failed to register the On-boarding application with UEB Communication server", "Details: {0}.", "Please check UEB server list and keys configured under Portal.Properties file."),\r
 114     \r
 115     BeHttpConnectionError(EPErrorCodesEnum.BEHTTPCONNECTIONERROR_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 116                                                                 "ERR213E", "It could be that communication to an external application might resulted an exception or failed to reach the external application", \r
 117                                                                 "Details: {0}.", "Please check logs for more information."),\r
 118     \r
 119     InternalConnectionInfo(EPErrorCodesEnum.INTERNALCONNECTIONINFO_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
 120                                                                 "ERR299I", "Internal Connection problem", "Details: {0}.", "Please check logs for more information."),\r
 121     \r
 122         InternalConnectionWarning(EPErrorCodesEnum.INTERNALCONNECTIONWARNING_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.WARN,\r
 123                                                                 "ERR299W", "Internal Connection problem", "Details: {0}.", "Please check logs for more information."),\r
 124     \r
 125     InternalConnectionError(EPErrorCodesEnum.INTERNALCONNECTIONERROR_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 126                                                         "ERR299E", "Internal Connection problem", "Details: {0}.", "Please check logs for more information."),\r
 127     \r
 128     InternalConnectionFatal(EPErrorCodesEnum.INTERNALCONNECTIONFATAL_ONE_ARGUMENT, ErrorTypeEnum.CONNECTION_PROBLEM, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.FATAL,\r
 129                                                         "ERR299F", "Internal Connection problem", "Details: {0}.", "Please check logs for more information."),\r
 130     \r
 131     BeUebObjectNotFoundError(EPErrorCodesEnum.BEUEBOBJECTNOTFOUNDERROR_ONE_ARGUMENT, ErrorTypeEnum.DATA_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 132                                                         "ERR303E", "Error occurred during access to U-EB Server.", "Data not found: {0}.", "An error occurred during access to UEB Server, {1} failed to either register or unregister to/from UEB topic."),\r
 133     \r
 134     BeUserMissingError(EPErrorCodesEnum.BEUSERMISSINGERROR_ONE_ARGUMENT, ErrorTypeEnum.DATA_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 135                                                         "ERR310E", "User is not found", "", "User {0} must be added to the corresponding application with proper user roles."),\r
 136     \r
 137     BeUserInactiveWarning(EPErrorCodesEnum.BEUSERINACTIVEWARNING_ONE_ARGUMENT, ErrorTypeEnum.DATA_ERROR, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.WARN,\r
 138                                                         "ERR313W", "User is found but in-active", "", "User {0} must be added to the corresponding application with proper user roles."),\r
 139     \r
 140     BeUserAdminPrivilegesInfo(EPErrorCodesEnum.BEUSERADMINPRIVILEGESINFO_ONE_ARGUMENT, ErrorTypeEnum.DATA_ERROR, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.WARN,\r
 141                                                         "ERR314W", "User is found but don't have administrative privileges", "", "User {0} should be given administrator role for the corresponding application to perform the necessary actions."),\r
 142     \r
 143     BeInvalidJsonInput(EPErrorCodesEnum.BEINVALIDJSONINPUT, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 144                                                         "ERR405E", "Failed to convert JSON input to object", "", "Please check logs for more information."),\r
 145     \r
 146     BeIncorrectHttpStatusError(EPErrorCodesEnum.BEINCORRECTHTTPSTATUSERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 147                                                         "ERR407E", "Communication to an external application is resulted in with Incorrect Http response code", "", "Please check logs for more information."),\r
 148     \r
 149     BeInitializationError(EPErrorCodesEnum.BEINITIALIZATIONERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
 150                                                         "ERR500E", "ECOMP-PORTAL Back-end was not initialized properly", "", "Please check logs for more information."),\r
 151     \r
 152     BeUebSystemError(EPErrorCodesEnum.BEUEBSYSTEMERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 153                                                         "ERR502E", "Error occurred during access to U-EB Server", "Details: {0}.", "An error occurred in {1} distribution mechanism. Please check the logs for more information."),\r
 154     \r
 155     BeDaoSystemError(EPErrorCodesEnum.BEDAOSYSTEMERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
 156                                                         "ERR505E", "Performing DDL or DML operations on database might have failed", "", "Please check MySQL DB health or look at the logs for more details."),\r
 157     \r
 158     BeSystemError(EPErrorCodesEnum.BESYSTEMERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
 159                                                         "ERR506E", "Unexpected error during operation", "", "Please check logs for more information."),\r
 160     \r
 161     BeExecuteRollbackError(EPErrorCodesEnum.BEEXECUTEROLLBACKERROR, ErrorTypeEnum.DATA_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 162                                                         "ERR507E", "Roll-back operation towards database has failed", "", "Please check MYSQL DB health or look at the logs for more details."),\r
 163     \r
 164     FeHttpLoggingError(EPErrorCodesEnum.FEHTTPLOGGINGERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.ERROR,\r
 165                                                         "ERR517E", "Error when logging FE HTTP request/response", "", "Please check MYSQL DB health or look at the logs for more details."),\r
 166     \r
 167         FePortalServletError(EPErrorCodesEnum.FEPORTALSERVLETERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 168                                                                 "ERR518E", "Error when trying to access FE Portal page.", "", "Please check logs for more information."),\r
 169         \r
 170     BeDaoCloseSessionError(EPErrorCodesEnum.BEDAOCLOSESESSIONERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 171                                                         "ERR519E", "Close local session operation with database failed", "", "Please check MYSQL DB health or look at the logs form more details."),\r
 172     \r
 173     BeRestApiGeneralError(EPErrorCodesEnum.BERESTAPIGENERALERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
 174                                                         "ERR900E", "Unexpected error during ECOMP-PORTAL Back-end REST API execution", "", "Please check error log for more information."),\r
 175     \r
 176     FeHealthCheckGeneralError(EPErrorCodesEnum.FEHEALTHCHECKGENERALERROR, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.ERROR,\r
 177                                                         "ERR901E", "General error during FE Health Check", "", "Please check error log for more information."),\r
 178     \r
 179     InternalUnexpectedInfo(EPErrorCodesEnum.INTERNALUNEXPECTEDINFO_ONE_ARGUMENT, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.INFORMATIONAL, ErrorSeverityEnum.INFO,\r
 180                                                         "ERR999I", "Unexpected error", "Details: {0}.", "Please check logs for more information."),\r
 181     \r
 182     InternalUnexpectedWarning(EPErrorCodesEnum.INTERNALUNEXPECTEDWARNING_ONE_ARGUMENT, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MINOR, ErrorSeverityEnum.WARN,\r
 183                                                         "ERR999W", "Unexpected error", "Details: {0}.", "Please check logs for more information."),\r
 184     \r
 185     InternalUnexpectedError(EPErrorCodesEnum.INTERNALUNEXPECTEDERROR_ONE_ARGUMENT, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.MAJOR, ErrorSeverityEnum.ERROR,\r
 186                                                         "ERR999E", "Unexpected error", "Details: {0}.", "Please check logs for more information."),\r
 187     \r
 188     InternalUnexpectedFatal(EPErrorCodesEnum.INTERNALUNEXPECTEDFATAL_ONE_ARGUMENT, ErrorTypeEnum.SYSTEM_ERROR, AlarmSeverityEnum.CRITICAL, ErrorSeverityEnum.FATAL,\r
 189                                                         "ERR999F", "Unexpected error", "Details: {0}.", "Please check logs for more information."),\r
 190         \r
 191         ;\r
 192         \r
 193         ErrorTypeEnum eType;\r
 194         AlarmSeverityEnum alarmSeverity;\r
 195         EPErrorCodesEnum messageCode;\r
 196         ErrorSeverityEnum errorSeverity;\r
 197         String errorCode;\r
 198         String errorDescription;\r
 199         String details;\r
 200         String resolution;\r
 201         \r
 202         EPAppMessagesEnum(EPErrorCodesEnum messageCode, ErrorTypeEnum eType, AlarmSeverityEnum alarmSeverity, ErrorSeverityEnum errorSeverity, String errorCode, String errorDescription, \r
 203                                                 String details, String resolution) {\r
 204                 this.messageCode = messageCode;\r
 205                 this.eType = eType;\r
 206                 this.alarmSeverity = alarmSeverity;\r
 207                 this.errorSeverity = errorSeverity;\r
 208                 this.errorCode = errorCode;\r
 209                 this.errorDescription = errorDescription;\r
 210                 this.details = details;\r
 211                 this.resolution = resolution;\r
 212         }\r
 213         \r
 214         public String getDetails() {\r
 215                 return this.details;\r
 216         }\r
 217         \r
 218         public String getResolution() {\r
 219                 return this.resolution;\r
 220         }\r
 221         public String getErrorCode() {\r
 222                 return this.errorCode;\r
 223         }\r
 224         \r
 225         public String getErrorDescription() {\r
 226                 return this.errorDescription;\r
 227         }\r
 228         \r
 229         public ErrorSeverityEnum getErrorSeverity() {\r
 230                 return this.errorSeverity;\r
 231         }\r
 232         \r
 233         public void setErrorSeverity(ErrorSeverityEnum errorSeverity) {\r
 234                 this.errorSeverity = errorSeverity;\r
 235         }\r
 236         \r
 237         public EPErrorCodesEnum getMessageCode() {\r
 238                 return messageCode;\r
 239         }\r
 240 \r
 241         public void setMessageCode(EPErrorCodesEnum messageCode) {\r
 242                 this.messageCode = messageCode;\r
 243         }\r
 244         \r
 245         public AlarmSeverityEnum getAlarmSeverity() {\r
 246                 return alarmSeverity;\r
 247         }\r
 248 \r
 249         public void setAlarmSeverity(AlarmSeverityEnum alarmSeverity) {\r
 250                 this.alarmSeverity = alarmSeverity;\r
 251         }\r
 252         \r
 253         public ErrorTypeEnum getErrorType() {\r
 254                 return eType;\r
 255         }\r
 256 \r
 257         public void setErrorType(ErrorTypeEnum eType) {\r
 258                 this.eType = eType;\r
 259         }\r
 260 }\r