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

  • 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
    ALL_SEARCH_TYPES
    OMAG-ADMIN-0216 - The {0} Open Metadata View Service (OMAS) is supporting the access to all types of assets
    ALL_ZONES
    OMAG-ADMIN-0201 - The {0} Open Metadata Access Service (OMAS) is supporting the access to assets for all governance zones
    BAD_CONFIG_PROPERTY
    OMAG-ADMIN-0208 - The {0} Open Metadata Access Service (OMAS) has been passed an invalid value of {1} in the {2} property
    BAD_TOPIC_CONNECTOR
    OMAG-ADMIN-0211 - Method {0} called on behalf of the {1} service detected a {2} exception when creating an open metadata topic connector.
    BAD_TOPIC_CONNECTOR_PROVIDER
    OMAG-ADMIN-0212 - 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.
    DEFAULT_PLATEAU_THRESHOLD
    OMAG-ADMIN-0207 - The {0} Open Metadata Access Service (OMAS) is using the default threshold for reporting Karma Point Plateaus: {1}
    DEFAULT_ZONES
    OMAG-ADMIN-0203 - The {0} Open Metadata Access Service (OMAS) is using the following governance zones as a default value for new Assets: {1}
    IGNORING_UNREGISTERED_SERVICE
    OMAG-ADMIN-0001 - The {0} service is being ignored in the startup of server {1} because it is not registered to this platform
    KARMA_POINT_COLLECTION_INCREMENT
    OMAG-ADMIN-0204 - The {0} Open Metadata Access Service (OMAS) is awarding {1} karma point(s) to each person who contributes to open metadata
    NO_ENTERPRISE_TOPIC
    OMAG-ADMIN-0210 - The {0} Open Metadata Access Service (OMAS) is unable to register a listener with the enterprise OMRS Topic for server {1} because it is null
    NO_KARMA_POINT_COLLECTION
    OMAG-ADMIN-0205 - The {0} Open Metadata Access Service (OMAS) is not collecting karma points in this server
    PLATEAU_THRESHOLD
    OMAG-ADMIN-0206 - The {0} Open Metadata Access Service (OMAS) is using the following threshold for reporting Karma Point Plateaus: {1}
    PUBLISH_ZONES
    OMAG-ADMIN-0213 - The {0} Open Metadata Access Service (OMAS) is using the following governance zones to determine when to publish completed Assets: {1}
    RESOURCE_ENDPOINTS
    OMAG-ADMIN-0214 - The {0} Open Metadata View Service (OMVS) is using the following resource endpoints as permitted endpoints: {1}
    SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC
    OMAG-ADMIN-0209 - The {0} Open Metadata Access Service (OMAS) is registering a listener with the enterprise OMRS Topic for server {1}
    SUPPORTED_SEARCH_TYPES
    OMAG-ADMIN-0217 - The {0} Open Metadata Access Service (OMAS) is supporting the following governance zones: {1}
    SUPPORTED_ZONES
    OMAG-ADMIN-0202 - The {0} Open Metadata Access Service (OMAS) is supporting the following governance zones: {1}
    VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW
    OMAG-ADMIN-0215 - The {0} Open Metadata View Service (OMVS) for server {1} requires a max page size of at least {2}, but was configured with {3}

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • IGNORING_UNREGISTERED_SERVICE

      public static final OMAGAdminAuditCode IGNORING_UNREGISTERED_SERVICE
      OMAG-ADMIN-0001 - The {0} service is being ignored in the startup of server {1} because it is not registered to this platform

    • ALL_ZONES

      public static final OMAGAdminAuditCode ALL_ZONES
      OMAG-ADMIN-0201 - The {0} Open Metadata Access Service (OMAS) is supporting the access to assets for all governance zones

    • SUPPORTED_ZONES

      public static final OMAGAdminAuditCode SUPPORTED_ZONES
      OMAG-ADMIN-0202 - The {0} Open Metadata Access Service (OMAS) is supporting the following governance zones: {1}

    • DEFAULT_ZONES

      public static final OMAGAdminAuditCode DEFAULT_ZONES
      OMAG-ADMIN-0203 - The {0} Open Metadata Access Service (OMAS) is using the following governance zones as a default value for new Assets: {1}

    • KARMA_POINT_COLLECTION_INCREMENT

      public static final OMAGAdminAuditCode KARMA_POINT_COLLECTION_INCREMENT
      OMAG-ADMIN-0204 - The {0} Open Metadata Access Service (OMAS) is awarding {1} karma point(s) to each person who contributes to open metadata

    • NO_KARMA_POINT_COLLECTION

      public static final OMAGAdminAuditCode NO_KARMA_POINT_COLLECTION
      OMAG-ADMIN-0205 - The {0} Open Metadata Access Service (OMAS) is not collecting karma points in this server

    • PLATEAU_THRESHOLD

      public static final OMAGAdminAuditCode PLATEAU_THRESHOLD
      OMAG-ADMIN-0206 - The {0} Open Metadata Access Service (OMAS) is using the following threshold for reporting Karma Point Plateaus: {1}

    • DEFAULT_PLATEAU_THRESHOLD

      public static final OMAGAdminAuditCode DEFAULT_PLATEAU_THRESHOLD
      OMAG-ADMIN-0207 - The {0} Open Metadata Access Service (OMAS) is using the default threshold for reporting Karma Point Plateaus: {1}

    • BAD_CONFIG_PROPERTY

      public static final OMAGAdminAuditCode BAD_CONFIG_PROPERTY
      OMAG-ADMIN-0208 - The {0} Open Metadata Access Service (OMAS) has been passed an invalid value of {1} in the {2} property

    • SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC

      public static final OMAGAdminAuditCode SERVICE_REGISTERED_WITH_ENTERPRISE_TOPIC
      OMAG-ADMIN-0209 - The {0} Open Metadata Access Service (OMAS) is registering a listener with the enterprise OMRS Topic for server {1}

    • NO_ENTERPRISE_TOPIC

      public static final OMAGAdminAuditCode NO_ENTERPRISE_TOPIC
      OMAG-ADMIN-0210 - The {0} Open Metadata Access Service (OMAS) is unable to register a listener with the enterprise OMRS Topic for server {1} because it is null

    • BAD_TOPIC_CONNECTOR

      public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR
      OMAG-ADMIN-0211 - Method {0} called on behalf of the {1} service detected a {2} exception when creating an open metadata topic connector. The error message was {3}

    • BAD_TOPIC_CONNECTOR_PROVIDER

      public static final OMAGAdminAuditCode BAD_TOPIC_CONNECTOR_PROVIDER
      OMAG-ADMIN-0212 - 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}

    • PUBLISH_ZONES

      public static final OMAGAdminAuditCode PUBLISH_ZONES
      OMAG-ADMIN-0213 - The {0} Open Metadata Access Service (OMAS) is using the following governance zones to determine when to publish completed Assets: {1}

    • RESOURCE_ENDPOINTS

      public static final OMAGAdminAuditCode RESOURCE_ENDPOINTS
      OMAG-ADMIN-0214 - The {0} Open Metadata View Service (OMVS) is using the following resource endpoints as permitted endpoints: {1}

    • VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW

      public static final OMAGAdminAuditCode VIEW_SERVICE_MAX_PAGE_SIZE_TOO_LOW
      OMAG-ADMIN-0215 - The {0} Open Metadata View Service (OMVS) for server {1} requires a max page size of at least {2}, but was configured with {3}

    • ALL_SEARCH_TYPES

      public static final OMAGAdminAuditCode ALL_SEARCH_TYPES
      OMAG-ADMIN-0216 - The {0} Open Metadata View Service (OMAS) is supporting the access to all types of assets

    • SUPPORTED_SEARCH_TYPES

      public static final OMAGAdminAuditCode SUPPORTED_SEARCH_TYPES
      OMAG-ADMIN-0217 - The {0} Open Metadata Access Service (OMAS) is supporting the following governance zones: {1}

  • 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.