Package org.odpi.openmetadata.adapters.connectors.simon.ffdc

Enum Class SimonAuditCode

java.lang.Object
java.lang.Enum<SimonAuditCode>
org.odpi.openmetadata.adapters.connectors.simon.ffdc.SimonAuditCode
All Implemented Interfaces:
Serializable, Comparable<SimonAuditCode>, Constable, AuditLogMessageSet
public enum SimonAuditCode extends Enum<SimonAuditCode> implements AuditLogMessageSet
The SimonAuditCode 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 for 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
    INVALID_USER_ID_PATTERN
    SIMON-CONTRIBUTION-RECORDER-0007 - The {0} integration connector has skipped ignored userId pattern {1} because it is not a valid regular expression: {2}
    KARMA_POINTS_DEFERRED
    SIMON-CONTRIBUTION-RECORDER-0004 - The {0} integration connector is unable to update the contribution record of user {1} because of exception {2} with message {3}; {4} karma points will be retried on the next refresh
    KARMA_POINTS_DISCARDED
    SIMON-CONTRIBUTION-RECORDER-0005 - The {0} integration connector has discarded {1} karma points for user {2} because their contribution record can not be updated: exception {3} with message {4}
    KARMA_POINTS_RECORDED
    SIMON-CONTRIBUTION-RECORDER-0003 - The {0} integration connector has added {1} karma points to the contribution records of {2} users
    NO_ACTOR_PROFILE
    SIMON-CONTRIBUTION-RECORDER-0006 - The {0} integration connector has discarded {1} karma points for users {2} because they do not have an actor profile
    STARTING_CONNECTOR
    SIMON-CONTRIBUTION-RECORDER-0002 - The {0} integration connector is starting to award karma points for the changes made through server {1} on platform {2}; users matching {3} are not awarded karma points
    UNEXPECTED_EXCEPTION
    SIMON-CONTRIBUTION-RECORDER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {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.
    String
    toString()
    JSON-style toString
    static SimonAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SimonAuditCode[]
    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, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • UNEXPECTED_EXCEPTION

      public static final SimonAuditCode UNEXPECTED_EXCEPTION
      SIMON-CONTRIBUTION-RECORDER-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • STARTING_CONNECTOR

      public static final SimonAuditCode STARTING_CONNECTOR
      SIMON-CONTRIBUTION-RECORDER-0002 - The {0} integration connector is starting to award karma points for the changes made through server {1} on platform {2}; users matching {3} are not awarded karma points

    • KARMA_POINTS_RECORDED

      public static final SimonAuditCode KARMA_POINTS_RECORDED
      SIMON-CONTRIBUTION-RECORDER-0003 - The {0} integration connector has added {1} karma points to the contribution records of {2} users

    • KARMA_POINTS_DEFERRED

      public static final SimonAuditCode KARMA_POINTS_DEFERRED
      SIMON-CONTRIBUTION-RECORDER-0004 - The {0} integration connector is unable to update the contribution record of user {1} because of exception {2} with message {3}; {4} karma points will be retried on the next refresh

    • KARMA_POINTS_DISCARDED

      public static final SimonAuditCode KARMA_POINTS_DISCARDED
      SIMON-CONTRIBUTION-RECORDER-0005 - The {0} integration connector has discarded {1} karma points for user {2} because their contribution record can not be updated: exception {3} with message {4}

    • NO_ACTOR_PROFILE

      public static final SimonAuditCode NO_ACTOR_PROFILE
      SIMON-CONTRIBUTION-RECORDER-0006 - The {0} integration connector has discarded {1} karma points for users {2} because they do not have an actor profile

    • INVALID_USER_ID_PATTERN

      public static final SimonAuditCode INVALID_USER_ID_PATTERN
      SIMON-CONTRIBUTION-RECORDER-0007 - The {0} integration connector has skipped ignored userId pattern {1} because it is not a valid regular expression: {2}

  • Method Details

    • values

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