Package org.odpi.openmetadata.engineservices.repositorygovernance.ffdc

Enum Class RepositoryGovernanceAuditCode

java.lang.Object
java.lang.Enum<RepositoryGovernanceAuditCode>
org.odpi.openmetadata.engineservices.repositorygovernance.ffdc.RepositoryGovernanceAuditCode
All Implemented Interfaces:
Serializable, Comparable<RepositoryGovernanceAuditCode>, Constable, AuditLogMessageSet
public enum RepositoryGovernanceAuditCode extends Enum<RepositoryGovernanceAuditCode> implements AuditLogMessageSet
The RepositoryGovernanceAuditCode 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

  • Enum Constant Details

    • ENGINE_SERVICE_INITIALIZING

      public static final RepositoryGovernanceAuditCode ENGINE_SERVICE_INITIALIZING
      OMES-REPOSITORY-GOVERNANCE-0001 - The Repository Governance engine services are initializing in server {0}

    • SERVICE_INSTANCE_FAILURE

      public static final RepositoryGovernanceAuditCode SERVICE_INSTANCE_FAILURE
      OMES-REPOSITORY-GOVERNANCE-0012 - The Repository Governance OMES is unable to initialize a new instance of itself in server {0}; error message is {1}

    • SERVER_SHUTTING_DOWN

      public static final RepositoryGovernanceAuditCode SERVER_SHUTTING_DOWN
      OMES-REPOSITORY-GOVERNANCE-0014 - The Repository Governance OMES in server {0} is shutting down

    • SERVER_SHUTDOWN

      public static final RepositoryGovernanceAuditCode SERVER_SHUTDOWN
      OMES-REPOSITORY-GOVERNANCE-0015 - The Repository Governance OMES in server {0} has completed shutdown

    • REPOSITORY_GOVERNANCE_SERVICE_STARTING

      public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_STARTING
      OMES-REPOSITORY-GOVERNANCE-0016 - The repository governance service {0} is starting with repository governance request type {1} in repository governance engine {2} (guid={3})

    • REPOSITORY_GOVERNANCE_SERVICE_RETURNED

      public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_RETURNED
      OMES-REPOSITORY-GOVERNANCE-0017 - The repository governance service {0} for request type {1} is continuing to run in a background thread

    • REPOSITORY_GOVERNANCE_SERVICE_FAILED

      public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_FAILED
      OMES-REPOSITORY-GOVERNANCE-0018 - The repository governance service {0} threw a {1} exception during repository governance request type {2} in repository governance engine {3} (guid={4}). The error message was {5}

    • REPOSITORY_GOVERNANCE_SERVICE_COMPLETE

      public static final RepositoryGovernanceAuditCode REPOSITORY_GOVERNANCE_SERVICE_COMPLETE
      OMES-REPOSITORY-GOVERNANCE-0019 - The repository governance service {0} has completed repository governance request type {1} in {2} milliseconds

    • NO_REPOSITORY_GOVERNANCE_ENGINES_STARTED

      public static final RepositoryGovernanceAuditCode NO_REPOSITORY_GOVERNANCE_ENGINES_STARTED
      OMES-REPOSITORY-GOVERNANCE-0020 - Repository Governance OMES in server {0} is unable to start any repository governance engines

    • EXC_ON_ERROR_STATUS_UPDATE

      public static final RepositoryGovernanceAuditCode EXC_ON_ERROR_STATUS_UPDATE
      OMES-REPOSITORY-GOVERNANCE-0021 - RepositoryGovernance engine {0} is unable to update the status for repository governance service {1}. The exception was {2} with error message {3}

    • INVALID_REPOSITORY_GOVERNANCE_SERVICE

      public static final RepositoryGovernanceAuditCode INVALID_REPOSITORY_GOVERNANCE_SERVICE
      OMES-REPOSITORY-GOVERNANCE-0029 - The repository governance service {0} linked to repository governance request type {1} can not be started. The {2} exception was returned with message {3}

  • Method Details

    • values

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