Package org.odpi.openmetadata.frameworks.surveyaction.ffdc

Enum Class SAFAuditCode

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

  • 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
    CREATING_LOG_FILE
    SAF-CONNECTOR-0003 - The survey action service {0} is creating log file {1}
    DISCONNECT_DETECTED
    SAF-CONNECTOR-0001 - The {0} survey action service has been disconnected - either due to its own actions or a cancel request
    INVALID_ROOT_SCHEMA_TYPE
    SAF-CONNECTOR-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_ASSET
    SAF-CONNECTOR-0005 - No information about the asset {0} has been returned from the asset store for survey action service {1}
    NO_SCHEMA
    SAF-CONNECTOR-0008 - The {0} Survey Acton Service has been supplied with asset {1} which does not have a schema attached
    NO_SCHEMA_ATTRIBUTES
    SAF-CONNECTOR-0009 - The {0} Survey Acton Service has been supplied with asset {1} which does not have any schema attributes attached
    REUSING_LOG_FILE
    SAF-CONNECTOR-0004 - The survey action service {0} is overriding log file {1}
    WRONG_TYPE_OF_ASSET
    SAF-CONNECTOR-0006 - Asset {0} is of type {1} but survey action service {2} only supports the following asset type(s): {3}
    WRONG_TYPE_OF_CONNECTOR
    SAF-CONNECTOR-0002 - The {0} Survey Action Service has been supplied with a resource connector of class {1} rather than class {2} for asset {3}

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition
    getMessageDefinition()
    Retrieve a message definition object for logging.
    org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition
    getMessageDefinition(String... params)
    Retrieve a message definition object for logging.
    String
    toString()
    JSON-style toString
    static SAFAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SAFAuditCode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DISCONNECT_DETECTED

      public static final SAFAuditCode DISCONNECT_DETECTED
      SAF-CONNECTOR-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 SAFAuditCode WRONG_TYPE_OF_CONNECTOR
      SAF-CONNECTOR-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 SAFAuditCode CREATING_LOG_FILE
      SAF-CONNECTOR-0003 - The survey action service {0} is creating log file {1}

    • REUSING_LOG_FILE

      public static final SAFAuditCode REUSING_LOG_FILE
      SAF-CONNECTOR-0004 - The survey action service {0} is overriding log file {1}

    • NO_ASSET

      public static final SAFAuditCode NO_ASSET
      SAF-CONNECTOR-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 SAFAuditCode WRONG_TYPE_OF_ASSET
      SAF-CONNECTOR-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 SAFAuditCode INVALID_ROOT_SCHEMA_TYPE
      SAF-CONNECTOR-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 SAFAuditCode NO_SCHEMA
      SAF-CONNECTOR-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 SAFAuditCode NO_SCHEMA_ATTRIBUTES
      SAF-CONNECTOR-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 SAFAuditCode[] 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 SAFAuditCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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<SAFAuditCode>
      Returns:
      string of property names and values for this enum