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

Enum Class PasteurAuditCode

java.lang.Object
java.lang.Enum<PasteurAuditCode>
org.odpi.openmetadata.adapters.connectors.pasteur.ffdc.PasteurAuditCode
All Implemented Interfaces:
Serializable, Comparable<PasteurAuditCode>, Constable, AuditLogMessageSet
public enum PasteurAuditCode extends Enum<PasteurAuditCode> implements AuditLogMessageSet
The PasteurAuditCode 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
    ACTIONS_DELETED
    PASTEUR-ACTION-HISTORY-CLEANUP-0003 - The {0} integration connector has deleted {1} finished actions of type {2} that completed more than {3} days ago using delete method {4}
    DELETE_FAILED
    PASTEUR-ACTION-HISTORY-CLEANUP-0004 - The {0} integration connector is unable to delete action {1} of type {2} because of exception {3} with message {4}
    INVALID_COMPLETION_STATUSES
    PASTEUR-ACTION-HISTORY-CLEANUP-0006 - The {0} integration connector is ignoring the values {1} in its completionStatuses configuration property because they are not activity statuses
    INVALID_DAYS_TO_CLEAN_UP
    PASTEUR-ACTION-HISTORY-CLEANUP-0005 - The {0} integration connector is ignoring the entries {1} in its daysToCleanUp configuration property because they do not map a type name to a number of days that is zero or more
    INVALID_DELETE_METHOD
    PASTEUR-ACTION-HISTORY-CLEANUP-0008 - The {0} integration connector is ignoring the value {1} of its deleteMethod configuration property because it is not a delete method; it is using {2}
    NOTHING_TO_CLEAN_UP
    PASTEUR-ACTION-HISTORY-CLEANUP-0007 - The {0} integration connector has nothing to clean up because its configuration properties give no types of action to clean up, or no completion statuses
    STARTING_CONNECTOR
    PASTEUR-ACTION-HISTORY-CLEANUP-0002 - The {0} integration connector is starting to clean up the action history through server {1} on platform {2}; the days to clean up are {3}, the completion statuses are {4} and the delete method is {5}
    UNEXPECTED_EXCEPTION
    PASTEUR-ACTION-HISTORY-CLEANUP-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 PasteurAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static PasteurAuditCode[]
    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 PasteurAuditCode UNEXPECTED_EXCEPTION
      PASTEUR-ACTION-HISTORY-CLEANUP-0001 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • STARTING_CONNECTOR

      public static final PasteurAuditCode STARTING_CONNECTOR
      PASTEUR-ACTION-HISTORY-CLEANUP-0002 - The {0} integration connector is starting to clean up the action history through server {1} on platform {2}; the days to clean up are {3}, the completion statuses are {4} and the delete method is {5}

    • ACTIONS_DELETED

      public static final PasteurAuditCode ACTIONS_DELETED
      PASTEUR-ACTION-HISTORY-CLEANUP-0003 - The {0} integration connector has deleted {1} finished actions of type {2} that completed more than {3} days ago using delete method {4}

    • DELETE_FAILED

      public static final PasteurAuditCode DELETE_FAILED
      PASTEUR-ACTION-HISTORY-CLEANUP-0004 - The {0} integration connector is unable to delete action {1} of type {2} because of exception {3} with message {4}

    • INVALID_DAYS_TO_CLEAN_UP

      public static final PasteurAuditCode INVALID_DAYS_TO_CLEAN_UP
      PASTEUR-ACTION-HISTORY-CLEANUP-0005 - The {0} integration connector is ignoring the entries {1} in its daysToCleanUp configuration property because they do not map a type name to a number of days that is zero or more

    • INVALID_COMPLETION_STATUSES

      public static final PasteurAuditCode INVALID_COMPLETION_STATUSES
      PASTEUR-ACTION-HISTORY-CLEANUP-0006 - The {0} integration connector is ignoring the values {1} in its completionStatuses configuration property because they are not activity statuses

    • NOTHING_TO_CLEAN_UP

      public static final PasteurAuditCode NOTHING_TO_CLEAN_UP
      PASTEUR-ACTION-HISTORY-CLEANUP-0007 - The {0} integration connector has nothing to clean up because its configuration properties give no types of action to clean up, or no completion statuses

    • INVALID_DELETE_METHOD

      public static final PasteurAuditCode INVALID_DELETE_METHOD
      PASTEUR-ACTION-HISTORY-CLEANUP-0008 - The {0} integration connector is ignoring the value {1} of its deleteMethod configuration property because it is not a delete method; it is using {2}

  • Method Details

    • values

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