Enum AuditCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<AuditCode>, org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet

    public enum AuditCode
    extends java.lang.Enum<AuditCode>
    implements org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
    The AuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
    • Log Message Id - 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 Detail

      • REPOSITORY_SERVICE_STARTING

        public static final AuditCode REPOSITORY_SERVICE_STARTING
      • CONNECTING_TO_CATALOG

        public static final AuditCode CONNECTING_TO_CATALOG
      • CONNECTED_TO_CATALOG

        public static final AuditCode CONNECTED_TO_CATALOG
      • REPOSITORY_SERVICE_STARTED

        public static final AuditCode REPOSITORY_SERVICE_STARTED
      • REPOSITORY_SERVICE_SHUTDOWN

        public static final AuditCode REPOSITORY_SERVICE_SHUTDOWN
      • EVENT_MAPPER_INITIALIZING

        public static final AuditCode EVENT_MAPPER_INITIALIZING
      • EVENT_MAPPER_INITIALIZED

        public static final AuditCode EVENT_MAPPER_INITIALIZED
      • EVENT_MAPPER_SHUTDOWN

        public static final AuditCode EVENT_MAPPER_SHUTDOWN
      • EVENT_MAPPER_STARTING

        public static final AuditCode EVENT_MAPPER_STARTING
      • EVENT_MAPPER_RUNNING

        public static final AuditCode EVENT_MAPPER_RUNNING
      • EVENT_MAPPER_CONSUMER_FAILURE

        public static final AuditCode EVENT_MAPPER_CONSUMER_FAILURE
    • Method Detail

      • values

        public static AuditCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (AuditCode c : AuditCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static AuditCode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getMessageDefinition

        public org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition()
        Specified by:
        getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
      • getMessageDefinition

        public org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition​(java.lang.String... params)
        Specified by:
        getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet