Package org.odpi.openmetadata.commonservices.generichandlers.ffdc

Enum Class GenericHandlersAuditCode

java.lang.Object
java.lang.Enum<GenericHandlersAuditCode>
org.odpi.openmetadata.commonservices.generichandlers.ffdc.GenericHandlersAuditCode
All Implemented Interfaces:
Serializable, Comparable<GenericHandlersAuditCode>, Constable, AuditLogMessageSet
public enum GenericHandlersAuditCode extends Enum<GenericHandlersAuditCode> implements AuditLogMessageSet
The GenericHandlersAuditCode 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
    ACTION_CLAIM_REQUEST
    OMAG-GENERIC-HANDLERS-0023 - Governance engine with {0} userId is claiming engine action {1}
    ADD_ACTION_TARGETS
    OMAG-GENERIC-HANDLERS-0022 - Adding action target {0} ({1}) to engine action {2} ({3})
    ENGINE_ACTION_CANCELLED
    OMAG-GENERIC-HANDLERS-0027 - Engine action {0} has been cancelled by user {1}, it was in {2} status before the cancel request
    ENGINE_ACTION_STATUS_CHANGE
    OMAG-GENERIC-HANDLERS-0025 - Status changed from {0} to {1} for engine action {2} by governance engine with {3} userId
    EXTERNAL_RELATIONSHIP_REMOVED
    OMAG-GENERIC-HANDLERS-0006 - {0} has removed the {1} relationship between {2} {3} and {4} {5} during method {6} on behalf of external metadata manager {7} ({8})
    EXTERNAL_RELATIONSHIP_UPDATED
    OMAG-GENERIC-HANDLERS-0005 - {0} has updated an existing {1} relationship {2} during method {3} on behalf of external metadata manager {4} ({5})
    FAILED_TO_RETRIEVE_ENTITIES
    OMAG-GENERIC-HANDLERS-0028 - Method {0} was unable to receive list of entities due to a {1} exception with message {2}
    IGNORING_UNNECESSARY_CLASSIFICATION_UPDATE
    OMAG-GENERIC-HANDLERS-0010 - Ignoring unnecessary update to {0} classification attached to entity with unique identifier {1} through method {2} by user {3}
    IGNORING_UNNECESSARY_ENTITY_UPDATE
    OMAG-GENERIC-HANDLERS-0008 - Ignoring unnecessary update to {0} entity with unique identifier {1} through method {2} by user {3}
    IGNORING_UNNECESSARY_RELATIONSHIP_UPDATE
    OMAG-GENERIC-HANDLERS-0009 - Ignoring unnecessary update to {0} relationship with unique identifier {1} through method {2} by user {3}
    INITIATE_ENGINE_ACTION
    OMAG-GENERIC-HANDLERS-0020 - Initializing a new engine action {0} for request type {1} to run on governance engine {2} with receivedGuards of {3}, mandatoryGuards of {4}, supplied with request parameters {5} and a start time of {6} at the request of {7}
    INITIATE_ENGINE_ACTION_FROM_PROCESS_STEP
    OMAG-GENERIC-HANDLERS-0021 - Initializing a new engine action {0} from governance action process step {1} for request type {2} to run on governance engine {3} with receivedGuards of {4}, mandatoryGuards of {5}, supplied with request parameters {6} and a start time of {7} as part of process {8}
    NEW_EXTERNAL_RELATIONSHIP
    OMAG-GENERIC-HANDLERS-0004 - {0} has created a new {1} relationship between {2} {3} and {4} {5} during method {6} on behalf of external metadata manager {7} ({8})
    PERMITTED_SYNC_CHANGING
    OMAG-GENERIC-HANDLERS-0003 - The permitted synchronization for {0} {1} ({2}) has changed for identifier {3} from {4} to {5}
    SETTING_UP_EXTERNAL_ID
    OMAG-GENERIC-HANDLERS-0002 - {0} has linked {1} element {2} to external identifier {3} from third party metadata source {4} ({5}) as part of the {6} operation
    SUCCESSFUL_ACTION_CLAIM_REQUEST
    OMAG-GENERIC-HANDLERS-0024 - Governance engine with {0} userId has successfully claimed engine action {1}
    TEMPLATE_MAPPING_SUMMARY
    OMAG-GENERIC-HANDLERS-0011 - Template {0} was used to create new {1} element {2} by mapping the following entities {3} and relationships {4}
    UNABLE_TO_DELETE_UNANCHORED_BEAN
    OMAG-GENERIC-HANDLERS-0007 - The Open Metadata Service {0} has deleted a relationship, resulting in entity {1} of type {2} ({3}) losing its anchor.
    UNABLE_TO_SET_ANCHORS
    OMAG-GENERIC-HANDLERS-0001 - The Open Metadata Service {0} is not able to set the Anchors classification on entity {1} of type {2} ({3}) during method {4}.

  • 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 GenericHandlersAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GenericHandlersAuditCode[]
    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

    • UNABLE_TO_SET_ANCHORS

      public static final GenericHandlersAuditCode UNABLE_TO_SET_ANCHORS
      OMAG-GENERIC-HANDLERS-0001 - The Open Metadata Service {0} is not able to set the Anchors classification on entity {1} of type {2} ({3}) during method {4}. The resulting exception was {5} with error message {6}

    • SETTING_UP_EXTERNAL_ID

      public static final GenericHandlersAuditCode SETTING_UP_EXTERNAL_ID
      OMAG-GENERIC-HANDLERS-0002 - {0} has linked {1} element {2} to external identifier {3} from third party metadata source {4} ({5}) as part of the {6} operation

    • PERMITTED_SYNC_CHANGING

      public static final GenericHandlersAuditCode PERMITTED_SYNC_CHANGING
      OMAG-GENERIC-HANDLERS-0003 - The permitted synchronization for {0} {1} ({2}) has changed for identifier {3} from {4} to {5}

    • NEW_EXTERNAL_RELATIONSHIP

      public static final GenericHandlersAuditCode NEW_EXTERNAL_RELATIONSHIP
      OMAG-GENERIC-HANDLERS-0004 - {0} has created a new {1} relationship between {2} {3} and {4} {5} during method {6} on behalf of external metadata manager {7} ({8})

    • EXTERNAL_RELATIONSHIP_UPDATED

      public static final GenericHandlersAuditCode EXTERNAL_RELATIONSHIP_UPDATED
      OMAG-GENERIC-HANDLERS-0005 - {0} has updated an existing {1} relationship {2} during method {3} on behalf of external metadata manager {4} ({5})

    • EXTERNAL_RELATIONSHIP_REMOVED

      public static final GenericHandlersAuditCode EXTERNAL_RELATIONSHIP_REMOVED
      OMAG-GENERIC-HANDLERS-0006 - {0} has removed the {1} relationship between {2} {3} and {4} {5} during method {6} on behalf of external metadata manager {7} ({8})

    • UNABLE_TO_DELETE_UNANCHORED_BEAN

      public static final GenericHandlersAuditCode UNABLE_TO_DELETE_UNANCHORED_BEAN
      OMAG-GENERIC-HANDLERS-0007 - The Open Metadata Service {0} has deleted a relationship, resulting in entity {1} of type {2} ({3}) losing its anchor. An attempt was made to delete this unanchored entity, which failed. The resulting exception was {5} with error message {6}

    • IGNORING_UNNECESSARY_ENTITY_UPDATE

      public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_ENTITY_UPDATE
      OMAG-GENERIC-HANDLERS-0008 - Ignoring unnecessary update to {0} entity with unique identifier {1} through method {2} by user {3}

    • IGNORING_UNNECESSARY_RELATIONSHIP_UPDATE

      public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_RELATIONSHIP_UPDATE
      OMAG-GENERIC-HANDLERS-0009 - Ignoring unnecessary update to {0} relationship with unique identifier {1} through method {2} by user {3}

    • IGNORING_UNNECESSARY_CLASSIFICATION_UPDATE

      public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_CLASSIFICATION_UPDATE
      OMAG-GENERIC-HANDLERS-0010 - Ignoring unnecessary update to {0} classification attached to entity with unique identifier {1} through method {2} by user {3}

    • TEMPLATE_MAPPING_SUMMARY

      public static final GenericHandlersAuditCode TEMPLATE_MAPPING_SUMMARY
      OMAG-GENERIC-HANDLERS-0011 - Template {0} was used to create new {1} element {2} by mapping the following entities {3} and relationships {4}

    • INITIATE_ENGINE_ACTION

      public static final GenericHandlersAuditCode INITIATE_ENGINE_ACTION
      OMAG-GENERIC-HANDLERS-0020 - Initializing a new engine action {0} for request type {1} to run on governance engine {2} with receivedGuards of {3}, mandatoryGuards of {4}, supplied with request parameters {5} and a start time of {6} at the request of {7}

    • INITIATE_ENGINE_ACTION_FROM_PROCESS_STEP

      public static final GenericHandlersAuditCode INITIATE_ENGINE_ACTION_FROM_PROCESS_STEP
      OMAG-GENERIC-HANDLERS-0021 - Initializing a new engine action {0} from governance action process step {1} for request type {2} to run on governance engine {3} with receivedGuards of {4}, mandatoryGuards of {5}, supplied with request parameters {6} and a start time of {7} as part of process {8}

    • ADD_ACTION_TARGETS

      public static final GenericHandlersAuditCode ADD_ACTION_TARGETS
      OMAG-GENERIC-HANDLERS-0022 - Adding action target {0} ({1}) to engine action {2} ({3})

    • ACTION_CLAIM_REQUEST

      public static final GenericHandlersAuditCode ACTION_CLAIM_REQUEST
      OMAG-GENERIC-HANDLERS-0023 - Governance engine with {0} userId is claiming engine action {1}

    • SUCCESSFUL_ACTION_CLAIM_REQUEST

      public static final GenericHandlersAuditCode SUCCESSFUL_ACTION_CLAIM_REQUEST
      OMAG-GENERIC-HANDLERS-0024 - Governance engine with {0} userId has successfully claimed engine action {1}

    • ENGINE_ACTION_STATUS_CHANGE

      public static final GenericHandlersAuditCode ENGINE_ACTION_STATUS_CHANGE
      OMAG-GENERIC-HANDLERS-0025 - Status changed from {0} to {1} for engine action {2} by governance engine with {3} userId

    • ENGINE_ACTION_CANCELLED

      public static final GenericHandlersAuditCode ENGINE_ACTION_CANCELLED
      OMAG-GENERIC-HANDLERS-0027 - Engine action {0} has been cancelled by user {1}, it was in {2} status before the cancel request

    • FAILED_TO_RETRIEVE_ENTITIES

      public static final GenericHandlersAuditCode FAILED_TO_RETRIEVE_ENTITIES
      OMAG-GENERIC-HANDLERS-0028 - Method {0} was unable to receive list of entities due to a {1} exception with message {2}

  • Method Details

    • values

      public static GenericHandlersAuditCode[] 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 GenericHandlersAuditCode 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<GenericHandlersAuditCode>
      Returns:
      string of property names and values for this enum