Package org.odpi.openmetadata.frameworks.opensurvey.ffdc

Enum Class OSFAuditCode

java.lang.Object
java.lang.Enum<OSFAuditCode>
org.odpi.openmetadata.frameworks.opensurvey.ffdc.OSFAuditCode
All Implemented Interfaces:
Serializable, Comparable<OSFAuditCode>, Constable, AuditLogMessageSet
public enum OSFAuditCode extends Enum<OSFAuditCode> implements AuditLogMessageSet
The OSFAuditCode is used to define the message content for the 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

    • DISCONNECT_DETECTED

      public static final OSFAuditCode DISCONNECT_DETECTED
      OPEN-SURVEY-0001 - The {0} survey action service has been disconnected - either due to its own actions or a cancel request

    • WRONG_TYPE_OF_CONNECTOR

      public static final OSFAuditCode WRONG_TYPE_OF_CONNECTOR
      OPEN-SURVEY-0002 - The {0} Survey Action Service has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

    • CREATING_LOG_FILE

      public static final OSFAuditCode CREATING_LOG_FILE
      OPEN-SURVEY-0003 - The survey action service {0} is creating log file {1}

    • REUSING_LOG_FILE

      public static final OSFAuditCode REUSING_LOG_FILE
      OPEN-SURVEY-0004 - The survey action service {0} is overriding log file {1}

    • NO_ASSET

      public static final OSFAuditCode NO_ASSET
      OPEN-SURVEY-0005 - No information about the asset {0} has been returned from the asset store for survey action service {1}

    • WRONG_TYPE_OF_ASSET

      public static final OSFAuditCode WRONG_TYPE_OF_ASSET
      OPEN-SURVEY-0006 - Asset {0} is of type {1} but survey action service {2} only supports the following asset type(s): {3}

    • INVALID_ROOT_SCHEMA_TYPE

      public static final OSFAuditCode INVALID_ROOT_SCHEMA_TYPE
      OPEN-SURVEY-0007 - Asset {0} has a root schema of type {1} but survey action service {2} only supports the following root schema type(s): {3}

    • NO_SCHEMA

      public static final OSFAuditCode NO_SCHEMA
      OPEN-SURVEY-0008 - The {0} Survey Acton Service has been supplied with asset {1} which does not have a schema attached

    • NO_SCHEMA_ATTRIBUTES

      public static final OSFAuditCode NO_SCHEMA_ATTRIBUTES
      OPEN-SURVEY-0009 - The {0} Survey Acton Service has been supplied with asset {1} which does not have any schema attributes attached

  • Method Details

    • values

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