Package org.odpi.openmetadata.adminservices.ffdc

Enum Class OMAGAdminAuditCode

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

    • MAX_PAGE_SIZE

      public static final OMAGAdminAuditCode MAX_PAGE_SIZE

    • UNLIMITED_MAX_PAGE_SIZE

      public static final OMAGAdminAuditCode UNLIMITED_MAX_PAGE_SIZE

    • INVALID_MAX_PAGE_SIZE

      public static final OMAGAdminAuditCode INVALID_MAX_PAGE_SIZE

    • SERVER_STARTUP_SUCCESS

      public static final OMAGAdminAuditCode SERVER_STARTUP_SUCCESS

    • SERVER_SHUTDOWN_STARTED

      public static final OMAGAdminAuditCode SERVER_SHUTDOWN_STARTED

    • SERVER_SHUTDOWN_SUCCESS

      public static final OMAGAdminAuditCode SERVER_SHUTDOWN_SUCCESS

    • SERVER_SHUTDOWN_ERROR

      public static final OMAGAdminAuditCode SERVER_SHUTDOWN_ERROR

    • STARTING_ACCESS_SERVICES

      public static final OMAGAdminAuditCode STARTING_ACCESS_SERVICES

    • SKIPPING_ACCESS_SERVICE

      public static final OMAGAdminAuditCode SKIPPING_ACCESS_SERVICE

    • ALL_ACCESS_SERVICES_STARTED

      public static final OMAGAdminAuditCode ALL_ACCESS_SERVICES_STARTED

    • STOPPING_ACCESS_SERVICES

      public static final OMAGAdminAuditCode STOPPING_ACCESS_SERVICES

    • ALL_ACCESS_SERVICES_STOPPED

      public static final OMAGAdminAuditCode ALL_ACCESS_SERVICES_STOPPED

    • ACCESS_SERVICE_INSTANCE_FAILURE

      public static final OMAGAdminAuditCode ACCESS_SERVICE_INSTANCE_FAILURE

    • BAD_ACCESS_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode BAD_ACCESS_SERVICE_ADMIN_CLASS

    • ACCESS_SERVICE_FAILURE

      public static final OMAGAdminAuditCode ACCESS_SERVICE_FAILURE

    • NULL_ACCESS_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode NULL_ACCESS_SERVICE_ADMIN_CLASS

    • STARTING_VIEW_SERVICES

      public static final OMAGAdminAuditCode STARTING_VIEW_SERVICES

    • SKIPPING_VIEW_SERVICE

      public static final OMAGAdminAuditCode SKIPPING_VIEW_SERVICE

    • ALL_VIEW_SERVICES_STARTED

      public static final OMAGAdminAuditCode ALL_VIEW_SERVICES_STARTED

    • STOPPING_VIEW_SERVICES

      public static final OMAGAdminAuditCode STOPPING_VIEW_SERVICES

    • ALL_VIEW_SERVICES_STOPPED

      public static final OMAGAdminAuditCode ALL_VIEW_SERVICES_STOPPED

    • VIEW_SERVICE_INSTANCE_FAILURE

      public static final OMAGAdminAuditCode VIEW_SERVICE_INSTANCE_FAILURE

    • BAD_VIEW_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode BAD_VIEW_SERVICE_ADMIN_CLASS

    • VIEW_SERVICE_FAILURE

      public static final OMAGAdminAuditCode VIEW_SERVICE_FAILURE

    • NULL_VIEW_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode NULL_VIEW_SERVICE_ADMIN_CLASS

    • STARTING_ENGINE_SERVICES

      public static final OMAGAdminAuditCode STARTING_ENGINE_SERVICES

    • SKIPPING_ENGINE_SERVICE

      public static final OMAGAdminAuditCode SKIPPING_ENGINE_SERVICE

    • ALL_ENGINE_SERVICES_STARTED

      public static final OMAGAdminAuditCode ALL_ENGINE_SERVICES_STARTED

    • STOPPING_ENGINE_SERVICES

      public static final OMAGAdminAuditCode STOPPING_ENGINE_SERVICES

    • ALL_ENGINE_SERVICES_STOPPED

      public static final OMAGAdminAuditCode ALL_ENGINE_SERVICES_STOPPED

    • ENGINE_SERVICE_INSTANCE_FAILURE

      public static final OMAGAdminAuditCode ENGINE_SERVICE_INSTANCE_FAILURE

    • BAD_ENGINE_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode BAD_ENGINE_SERVICE_ADMIN_CLASS

    • ENGINE_SERVICE_FAILURE

      public static final OMAGAdminAuditCode ENGINE_SERVICE_FAILURE

    • NULL_ENGINE_SERVICE_ADMIN_CLASS

      public static final OMAGAdminAuditCode NULL_ENGINE_SERVICE_ADMIN_CLASS

    • STARTING_GOVERNANCE_SERVICES

      public static final OMAGAdminAuditCode STARTING_GOVERNANCE_SERVICES

    • GOVERNANCE_SERVICES_STARTED

      public static final OMAGAdminAuditCode GOVERNANCE_SERVICES_STARTED

    • GOVERNANCE_SERVICE_FAILURE

      public static final OMAGAdminAuditCode GOVERNANCE_SERVICE_FAILURE

    • ALL_ZONES

      public static final OMAGAdminAuditCode ALL_ZONES

    • SUPPORTED_ZONES

      public static final OMAGAdminAuditCode SUPPORTED_ZONES

    • DEFAULT_ZONES

      public static final OMAGAdminAuditCode DEFAULT_ZONES

    • KARMA_POINT_COLLECTION_INCREMENT

      public static final OMAGAdminAuditCode KARMA_POINT_COLLECTION_INCREMENT

    • NO_KARMA_POINT_COLLECTION

      public static final OMAGAdminAuditCode NO_KARMA_POINT_COLLECTION

    • PLATEAU_THRESHOLD

      public static final OMAGAdminAuditCode PLATEAU_THRESHOLD

    • DEFAULT_PLATEAU_THRESHOLD

      public static final OMAGAdminAuditCode DEFAULT_PLATEAU_THRESHOLD

    • BAD_CONFIG_PROPERTY

      public static final OMAGAdminAuditCode BAD_CONFIG_PROPERTY

    • SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

      public static final OMAGAdminAuditCode SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

    • NO_ENTERPRISE_TOPIC

      public static final OMAGAdminAuditCode NO_ENTERPRISE_TOPIC

    • BAD_TOPIC_CONNECTOR

      public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR

    • BAD_TOPIC_CONNECTOR_PROVIDER

      public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR_PROVIDER

    • PUBLISH_ZONES

      public static final OMAGAdminAuditCode PUBLISH_ZONES

    • RESOURCE_ENDPOINTS

      public static final OMAGAdminAuditCode RESOURCE_ENDPOINTS

    • VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW

      public static final OMAGAdminAuditCode VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW

  • Method Details

    • values

      public static OMAGAdminAuditCode[] 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 OMAGAdminAuditCode 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.