Package org.odpi.openmetadata.commonservices.repositoryhandler

Enum Class RepositoryHandlerAuditCode

java.lang.Object
java.lang.Enum<RepositoryHandlerAuditCode>
org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandlerAuditCode
All Implemented Interfaces:
Serializable, Comparable<RepositoryHandlerAuditCode>, Constable, AuditLogMessageSet
public enum RepositoryHandlerAuditCode extends Enum<RepositoryHandlerAuditCode> implements AuditLogMessageSet
The RepositoryHandlerAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
  • Log Message Identifier - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • 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_ENTITY
    OMAG-REPOSITORY-HANDLER-0006 - A {0} entity has been retrieved by method {1} from service {2} that has an invalid header: {3}
    BAD_ENTITY_PROXY
    OMAG-REPOSITORY-HANDLER-0007 - A relationship {0} has been retrieved by method {1} from service {2} that has an invalid entity proxy at end {3}: {4
    BAD_RELATIONSHIP
    OMAG-REPOSITORY-HANDLER-0008 - A {0} relationship has been retrieved by method {1} from service {2} that has an invalid header: {3}
    ENTITY_DELETED
    OMAG-REPOSITORY-HANDLER-0011 - The Open Metadata Service has soft-deleted entity {0} of type {1} ({2}) during method {3}
    ENTITY_PURGED
    OMAG-REPOSITORY-HANDLER-0001 - The Open Metadata Service has purged entity {0} of type {1} ({2}) during method {3} because its home repository {4} does not support soft-delete
    FUNCTION_NOT_SUPPORTED
    OMAG-REPOSITORY-HANDLER-0010 - Method {0} called from {1} for service {2} is using function that not supported by any of the metadata repositories connected to {3} - error message is: {4}
    NULL_INSTANCE
    OMAG-REPOSITORY-HANDLER-0005 - A null instance of type {0} has been retrieved by method {1} from service {2}
    PROPERTY_SERVER_ERROR
    OMAG-REPOSITORY-HANDLER-0003 - An unexpected error {4} was returned to {5} by the metadata server during {1} request for open metadata access service {2} on server {3}; message was {0}
    RELATIONSHIP_DELETED
    OMAG-REPOSITORY-HANDLER-0012 - The Open Metadata Service has soft-deleted relationship {0} of type {1} ({2}) between entity {3} of type {4} ({5}) and entity {6} of type {7} ({8}) during method {9}
    RELATIONSHIP_PURGED
    OMAG-REPOSITORY-HANDLER-0002 - The Open Metadata Service has purged relationship {0} of type {1} ({2}) during method {3} because its home repository {4} does not support soft-delete
    UNABLE_TO_SET_ANCHORS
    OMAG-REPOSITORY-HANDLER-0004 - The Open Metadata Service {0} is not able to set the Anchors classification on a new entity of type {1} during method {2}.
    UNAVAILABLE_ENTITY
    OMAG-REPOSITORY-HANDLER-0009 - A {0} entity with unique identifier {1} has been retrieved by method {2} from service {3} but it is not visible to the caller {4}: effective time is {5}; entity is effective from {6} to {7} with classifications {8} and call parameters of forLineage={9} and forDuplicateProcessing={10}

  • Method Summary

    Modifier and Type
    Method
    Description
    AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static RepositoryHandlerAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static RepositoryHandlerAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ENTITY_PURGED

      public static final RepositoryHandlerAuditCode ENTITY_PURGED
      OMAG-REPOSITORY-HANDLER-0001 - The Open Metadata Service has purged entity {0} of type {1} ({2}) during method {3} because its home repository {4} does not support soft-delete

    • RELATIONSHIP_PURGED

      public static final RepositoryHandlerAuditCode RELATIONSHIP_PURGED
      OMAG-REPOSITORY-HANDLER-0002 - The Open Metadata Service has purged relationship {0} of type {1} ({2}) during method {3} because its home repository {4} does not support soft-delete

    • PROPERTY_SERVER_ERROR

      public static final RepositoryHandlerAuditCode PROPERTY_SERVER_ERROR
      OMAG-REPOSITORY-HANDLER-0003 - An unexpected error {4} was returned to {5} by the metadata server during {1} request for open metadata access service {2} on server {3}; message was {0}

    • UNABLE_TO_SET_ANCHORS

      public static final RepositoryHandlerAuditCode UNABLE_TO_SET_ANCHORS
      OMAG-REPOSITORY-HANDLER-0004 - The Open Metadata Service {0} is not able to set the Anchors classification on a new entity of type {1} during method {2}. The resulting exception was {3} with error message {4}

    • NULL_INSTANCE

      public static final RepositoryHandlerAuditCode NULL_INSTANCE
      OMAG-REPOSITORY-HANDLER-0005 - A null instance of type {0} has been retrieved by method {1} from service {2}

    • BAD_ENTITY

      public static final RepositoryHandlerAuditCode BAD_ENTITY
      OMAG-REPOSITORY-HANDLER-0006 - A {0} entity has been retrieved by method {1} from service {2} that has an invalid header: {3}

    • BAD_ENTITY_PROXY

      public static final RepositoryHandlerAuditCode BAD_ENTITY_PROXY
      OMAG-REPOSITORY-HANDLER-0007 - A relationship {0} has been retrieved by method {1} from service {2} that has an invalid entity proxy at end {3}: {4

    • BAD_RELATIONSHIP

      public static final RepositoryHandlerAuditCode BAD_RELATIONSHIP
      OMAG-REPOSITORY-HANDLER-0008 - A {0} relationship has been retrieved by method {1} from service {2} that has an invalid header: {3}

    • UNAVAILABLE_ENTITY

      public static final RepositoryHandlerAuditCode UNAVAILABLE_ENTITY
      OMAG-REPOSITORY-HANDLER-0009 - A {0} entity with unique identifier {1} has been retrieved by method {2} from service {3} but it is not visible to the caller {4}: effective time is {5}; entity is effective from {6} to {7} with classifications {8} and call parameters of forLineage={9} and forDuplicateProcessing={10}

    • FUNCTION_NOT_SUPPORTED

      public static final RepositoryHandlerAuditCode FUNCTION_NOT_SUPPORTED
      OMAG-REPOSITORY-HANDLER-0010 - Method {0} called from {1} for service {2} is using function that not supported by any of the metadata repositories connected to {3} - error message is: {4}

    • ENTITY_DELETED

      public static final RepositoryHandlerAuditCode ENTITY_DELETED
      OMAG-REPOSITORY-HANDLER-0011 - The Open Metadata Service has soft-deleted entity {0} of type {1} ({2}) during method {3}

    • RELATIONSHIP_DELETED

      public static final RepositoryHandlerAuditCode RELATIONSHIP_DELETED
      OMAG-REPOSITORY-HANDLER-0012 - The Open Metadata Service has soft-deleted relationship {0} of type {1} ({2}) between entity {3} of type {4} ({5}) and entity {6} of type {7} ({8}) during method {9}

  • Method Details

    • values

      public static RepositoryHandlerAuditCode[] 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 RepositoryHandlerAuditCode 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 AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      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<RepositoryHandlerAuditCode>
      Returns:
      string of property names and values for this enum