Package org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.ffdc

Enum Class OMAGOCFErrorCode

java.lang.Object
java.lang.Enum<OMAGOCFErrorCode>
org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.ffdc.OMAGOCFErrorCode
All Implemented Interfaces:
Serializable, Comparable<OMAGOCFErrorCode>, Constable, ExceptionMessageSet
public enum OMAGOCFErrorCode extends Enum<OMAGOCFErrorCode> implements ExceptionMessageSet
The OMAGOCFErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OCF Beans. The 5 fields in the enum are:
  • HTTP Error Code - for translating between REST and JAVA Typically the numbers used are:
    • 500 - internal error
    • 400 - invalid parameters
    • 404 - not found
    • 409 - data conflict errors - eg item already defined
  • Error Message Identifier - to uniquely identify the message
  • Error Message Text - includes placeholder to allow additional values to be captured
  • SystemAction - describes the result of the error
  • UserAction - describes how a consumer should correct the error

  • Enum Constant Details

    • NULL_CONNECTION_PARAMETER

      public static final OMAGOCFErrorCode NULL_CONNECTION_PARAMETER
      CONNECTED-ASSET-SERVICES-400-001 - The connection value passed on the {0} parameter of the {1} operation is null

    • NO_ASSET_PROPERTIES

      public static final OMAGOCFErrorCode NO_ASSET_PROPERTIES
      CONNECTED-ASSET-SERVICES-400-002 - The request for the properties of asset {0} failed with the following message returned: {1}

    • NULL_CLASSIFICATION_NAME

      public static final OMAGOCFErrorCode NULL_CLASSIFICATION_NAME
      CONNECTED-ASSET-SERVICES-400-003 - Service {0} is unable to process one of the classifications supplied on the {1} call because the classification name is null

    • BAD_CLASSIFICATION_PROPERTIES

      public static final OMAGOCFErrorCode BAD_CLASSIFICATION_PROPERTIES
      CONNECTED-ASSET-SERVICES-400-004 - Service {0} is unable to process the properties supplied with classification {1}. The associated error message was: {2}

    • INTEGRATOR_NOT_RETURNED

      public static final OMAGOCFErrorCode INTEGRATOR_NOT_RETURNED
      CONNECTED-ASSET-SERVICES-400-005 - Service {0} is unable to process the properties supplied to method {1} because the requested owner {2} ({3}) is not a recognized software server capability. The associated error message is: {4}

    • BAD_INTEGRATOR_NAME

      public static final OMAGOCFErrorCode BAD_INTEGRATOR_NAME
      CONNECTED-ASSET-SERVICES-400-006 - Service {0} is unable to process the properties supplied to method {1} because the unique name {2} given for the requested owner does not match the unique name of {3} returned in software server capability {4}

    • OMRS_NOT_INITIALIZED

      public static final OMAGOCFErrorCode OMRS_NOT_INITIALIZED
      CONNECTED-ASSET-SERVICES-404-001 - The open metadata repository services are not initialized for the {0} operation

    • NULL_CONNECTOR_RETURNED

      public static final OMAGOCFErrorCode NULL_CONNECTOR_RETURNED
      CONNECTED-ASSET-SERVICES-500-001 - The requested connector for connection named {0} has not been created. The connection was provided by the {1} service running in OMAG Server {2} at {3}

    • WRONG_TYPE_OF_CONNECTOR

      public static final OMAGOCFErrorCode WRONG_TYPE_OF_CONNECTOR
      CONNECTED-ASSET-SERVICES-500-002 - The connector generated from the connection named {0} return by the {1} service running in OMAG Server {2} at {3} is not of the required type. It should be an instance of {4}

  • Method Details

    • values

      public static OMAGOCFErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static OMAGOCFErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getMessageDefinition

      public ExceptionMessageDefinition getMessageDefinition()
      Retrieve a message definition object for an exception. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public ExceptionMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface ExceptionMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

      public String toString()
      JSON-style toString
      Overrides:
      toString in class Enum<OMAGOCFErrorCode>
      Returns:
      string of property names and values for this enum