Package org.odpi.openmetadata.commonservices.multitenant.ffdc

Enum Class OMAGServerInstanceErrorCode

java.lang.Object
java.lang.Enum<OMAGServerInstanceErrorCode>
org.odpi.openmetadata.commonservices.multitenant.ffdc.OMAGServerInstanceErrorCode
All Implemented Interfaces:
Serializable, Comparable<OMAGServerInstanceErrorCode>, Constable, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
public enum OMAGServerInstanceErrorCode extends Enum<OMAGServerInstanceErrorCode> implements org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
The OMAGServerInstanceErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OMAG Server instances within the OMAG Server Platform It is used in conjunction with all multi-tenant exceptions, both Checked and Runtime (unchecked).

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    BAD_SERVER_SECURITY_CONNECTION
    OMAG-MULTI-TENANT-400-001 - The OMAG server {0} has been configured with a bad connection to its security connector.
    BAD_TOPIC_CONNECTOR_PROVIDER
    OMAG-MULTI-TENANT-500-003 - Method {0} called on behalf of the {1} service detected a {2} exception when creating an open metadata topic connection because the connector provider is incorrect.
    NO_TOPIC_INFORMATION
    OMAG-MULTI-TENANT-400-003 - Method {0} called on behalf of the {1} service is unable to create a client-side open metadata topic connection because the topic name is not configured in the configuration for this service.
    NOT_CORRECT_CONNECTOR_PROVIDER
    OMAG-MULTI-TENANT-400-004 - The connector provider class name {0} does not create a connector of class {1} which is required for the {2}
    OMRS_NOT_AVAILABLE
    OMAG-MULTI-TENANT-404-005 - The open metadata repository services are not available for the {0} operation
    OMRS_NOT_INITIALIZED
    OMAG-MULTI-TENANT-404-004 - The open metadata repository services are not initialized for the {0} operation
    SERVER_NAME_NOT_AVAILABLE
    OMAG-MULTI-TENANT-404-003 - The server name is not available for the {0} operation
    SERVER_NOT_AVAILABLE
    OMAG-MULTI-TENANT-404-001 - The OMAG Server {0} is not available to service a request from user {1}
    SERVICE_NOT_AVAILABLE
    OMAG-MULTI-TENANT-404-002 - The {0} service is not available on OMAG Server {1} to handle a request from user {2}
    SERVICES_NOT_SHUTDOWN
    OMAG-MULTI-TENANT-400-002 - The OMAG server {0} has been requested to shut down but the following services are still running: {1}

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for an exception.
    org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for an exception.
    String
    toString()
    JSON-style toString
    static OMAGServerInstanceErrorCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OMAGServerInstanceErrorCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • BAD_SERVER_SECURITY_CONNECTION

      public static final OMAGServerInstanceErrorCode BAD_SERVER_SECURITY_CONNECTION
      OMAG-MULTI-TENANT-400-001 - The OMAG server {0} has been configured with a bad connection to its security connector. Error message is {1}. Connection is {2}

    • SERVICES_NOT_SHUTDOWN

      public static final OMAGServerInstanceErrorCode SERVICES_NOT_SHUTDOWN
      OMAG-MULTI-TENANT-400-002 - The OMAG server {0} has been requested to shut down but the following services are still running: {1}

    • NO_TOPIC_INFORMATION

      public static final OMAGServerInstanceErrorCode NO_TOPIC_INFORMATION
      OMAG-MULTI-TENANT-400-003 - Method {0} called on behalf of the {1} service is unable to create a client-side open metadata topic connection because the topic name is not configured in the configuration for this service.

    • NOT_CORRECT_CONNECTOR_PROVIDER

      public static final OMAGServerInstanceErrorCode NOT_CORRECT_CONNECTOR_PROVIDER
      OMAG-MULTI-TENANT-400-004 - The connector provider class name {0} does not create a connector of class {1} which is required for the {2}

    • SERVER_NOT_AVAILABLE

      public static final OMAGServerInstanceErrorCode SERVER_NOT_AVAILABLE
      OMAG-MULTI-TENANT-404-001 - The OMAG Server {0} is not available to service a request from user {1}

    • SERVICE_NOT_AVAILABLE

      public static final OMAGServerInstanceErrorCode SERVICE_NOT_AVAILABLE
      OMAG-MULTI-TENANT-404-002 - The {0} service is not available on OMAG Server {1} to handle a request from user {2}

    • SERVER_NAME_NOT_AVAILABLE

      public static final OMAGServerInstanceErrorCode SERVER_NAME_NOT_AVAILABLE
      OMAG-MULTI-TENANT-404-003 - The server name is not available for the {0} operation

    • OMRS_NOT_INITIALIZED

      public static final OMAGServerInstanceErrorCode OMRS_NOT_INITIALIZED
      OMAG-MULTI-TENANT-404-004 - The open metadata repository services are not initialized for the {0} operation

    • OMRS_NOT_AVAILABLE

      public static final OMAGServerInstanceErrorCode OMRS_NOT_AVAILABLE
      OMAG-MULTI-TENANT-404-005 - The open metadata repository services are not available for the {0} operation

    • BAD_TOPIC_CONNECTOR_PROVIDER

      public static final OMAGServerInstanceErrorCode BAD_TOPIC_CONNECTOR_PROVIDER
      OMAG-MULTI-TENANT-500-003 - Method {0} called on behalf of the {1} service detected a {2} exception when creating an open metadata topic connection because the connector provider is incorrect. The error message was {3}

  • Method Details

    • values

      public static OMAGServerInstanceErrorCode[] 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 OMAGServerInstanceErrorCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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<OMAGServerInstanceErrorCode>
      Returns:
      string of property names and values for this enum