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

Enum Class GovernanceActionConnectorsAuditCode

java.lang.Object
java.lang.Enum<GovernanceActionConnectorsAuditCode>
org.odpi.openmetadata.adapters.connectors.governanceactions.ffdc.GovernanceActionConnectorsAuditCode
All Implemented Interfaces:
Serializable, Comparable<GovernanceActionConnectorsAuditCode>, Constable, AuditLogMessageSet
public enum GovernanceActionConnectorsAuditCode extends Enum<GovernanceActionConnectorsAuditCode> implements AuditLogMessageSet
The GovernanceActionConnectorsAuditCode 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

  • 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
    BLANK_INFO_LOG_MESSAGE
    GOVERNANCE-ACTION-CONNECTORS-0024 - {0}
    COPY_FILE
    GOVERNANCE-ACTION-CONNECTORS-0001 - The {0} governance action service is copying source file {1} to destination file {2}
    CREATED_LINEAGE
    GOVERNANCE-ACTION-CONNECTORS-0004 - The {0} governance action service has created lineage from source {1} to process {2} to destination {3}
    DELETE_FILE
    GOVERNANCE-ACTION-CONNECTORS-0003 - The {0} governance action service is deleting file {1}
    ENDPOINT_EXCEPTION
    GOVERNANCE-ACTION-CONNECTORS-0008 - The {0} governance action service encountered an {1} exception when attempting to retrieve the file path name from the attached endpoint.
    INITIATE_PROCESS
    GOVERNANCE-ACTION-CONNECTORS-0021 - The {0} governance action service is initiating governance action process {1} with request parameters {2} for action targets {3}
    INITIATE_PROCESS_EXCEPTION
    GOVERNANCE-ACTION-CONNECTORS-0022 - The {0} governance action service encountered an {1} exception initiating governance action process {2} with request parameters {3} for action targets {4}.
    MISSING_TEMPLATE
    GOVERNANCE-ACTION-CONNECTORS-0023 - The {0} governance action service is unable to retrieve the template {1} configured in property {2}.
    MOVE_FILE
    GOVERNANCE-ACTION-CONNECTORS-0002 - The {0} governance action service is moving source file {1} to destination file {2}
    NO_LINKED_CONNECTION
    GOVERNANCE-ACTION-CONNECTORS-0010 - The {0} governance action service detected that asset {1} has no linked connection
    NO_LINKED_ENDPOINT
    GOVERNANCE-ACTION-CONNECTORS-0013 - The {0} governance action service detected that asset {1} has no endpoint linked to connection {2}
    NO_NETWORK_ADDRESS
    GOVERNANCE-ACTION-CONNECTORS-0015 - The {0} governance action service detected that the endpoint {1} linked to connection {2} for asset {3} has no networkAddressProperty
    NO_RELATED_ASSET
    GOVERNANCE-ACTION-CONNECTORS-0012 - The context for {0} governance action service returned a RelatedMetadataElement with a null related element: {1}
    NO_SOURCE_FILE_NAME
    GOVERNANCE-ACTION-CONNECTORS-0005 - The {0} governance action service has been called without a source file name to work with
    NO_TARGETS
    GOVERNANCE-ACTION-CONNECTORS-0018 - The {0} governance action service has no targets to operate on
    NO_ZONES
    GOVERNANCE-ACTION-CONNECTORS-0019 - The {0} governance action service has publishZones set to null
    PROVISIONING_EXCEPTION
    GOVERNANCE-ACTION-CONNECTORS-0007 - The {0} governance action service encountered an {1} exception when provisioning file {2} to {3} destination folder using the {4} file pattern.
    PROVISIONING_FAILURE
    GOVERNANCE-ACTION-CONNECTORS-0006 - The {0} governance action service is unable to provision file {1} to {2} destination folder using {3} file pattern
    QUALIFIED_NAME_PATH_NAME
    GOVERNANCE-ACTION-CONNECTORS-0009 - The {0} governance action service is using the qualified name from the Folder asset as the path name: {1}
    SETTING_ZONES
    GOVERNANCE-ACTION-CONNECTORS-0020 - The {0} governance action service is publishing asset {1} to the following zones: {2}
    TOO_MANY_CONNECTIONS
    GOVERNANCE-ACTION-CONNECTORS-0011 - The {0} governance action service detected that asset {1} has {2} linked connections for asset {3} and is not sure which one to use since they have inconsistent networkAddress properties in their endpoint
    TOO_MANY_ENDPOINTS
    GOVERNANCE-ACTION-CONNECTORS-0014 - The {0} governance action service detected that asset {1} has a linked connection {2} with {3} linked endpoints which is not valid: {4}
    UNABLE_TO_REGISTER_LISTENER
    GOVERNANCE-ACTION-CONNECTORS-0017 - The {0} governance action service received a {1} exception when it registered a listener with the governance context.
    UNABLE_TO_SET_COMPLETION_STATUS
    GOVERNANCE-ACTION-CONNECTORS-0016 - The {0} governance action service received a {1} exception when it registered its completion status.

  • 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 GovernanceActionConnectorsAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static GovernanceActionConnectorsAuditCode[]
    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

    • COPY_FILE

      public static final GovernanceActionConnectorsAuditCode COPY_FILE
      GOVERNANCE-ACTION-CONNECTORS-0001 - The {0} governance action service is copying source file {1} to destination file {2}

    • MOVE_FILE

      public static final GovernanceActionConnectorsAuditCode MOVE_FILE
      GOVERNANCE-ACTION-CONNECTORS-0002 - The {0} governance action service is moving source file {1} to destination file {2}

    • DELETE_FILE

      public static final GovernanceActionConnectorsAuditCode DELETE_FILE
      GOVERNANCE-ACTION-CONNECTORS-0003 - The {0} governance action service is deleting file {1}

    • CREATED_LINEAGE

      public static final GovernanceActionConnectorsAuditCode CREATED_LINEAGE
      GOVERNANCE-ACTION-CONNECTORS-0004 - The {0} governance action service has created lineage from source {1} to process {2} to destination {3}

    • NO_SOURCE_FILE_NAME

      public static final GovernanceActionConnectorsAuditCode NO_SOURCE_FILE_NAME
      GOVERNANCE-ACTION-CONNECTORS-0005 - The {0} governance action service has been called without a source file name to work with

    • PROVISIONING_FAILURE

      public static final GovernanceActionConnectorsAuditCode PROVISIONING_FAILURE
      GOVERNANCE-ACTION-CONNECTORS-0006 - The {0} governance action service is unable to provision file {1} to {2} destination folder using {3} file pattern

    • PROVISIONING_EXCEPTION

      public static final GovernanceActionConnectorsAuditCode PROVISIONING_EXCEPTION
      GOVERNANCE-ACTION-CONNECTORS-0007 - The {0} governance action service encountered an {1} exception when provisioning file {2} to {3} destination folder using the {4} file pattern. The exception message included was {5}

    • ENDPOINT_EXCEPTION

      public static final GovernanceActionConnectorsAuditCode ENDPOINT_EXCEPTION
      GOVERNANCE-ACTION-CONNECTORS-0008 - The {0} governance action service encountered an {1} exception when attempting to retrieve the file path name from the attached endpoint. The exception message included was {5}

    • QUALIFIED_NAME_PATH_NAME

      public static final GovernanceActionConnectorsAuditCode QUALIFIED_NAME_PATH_NAME
      GOVERNANCE-ACTION-CONNECTORS-0009 - The {0} governance action service is using the qualified name from the Folder asset as the path name: {1}

    • NO_LINKED_CONNECTION

      public static final GovernanceActionConnectorsAuditCode NO_LINKED_CONNECTION
      GOVERNANCE-ACTION-CONNECTORS-0010 - The {0} governance action service detected that asset {1} has no linked connection

    • TOO_MANY_CONNECTIONS

      public static final GovernanceActionConnectorsAuditCode TOO_MANY_CONNECTIONS
      GOVERNANCE-ACTION-CONNECTORS-0011 - The {0} governance action service detected that asset {1} has {2} linked connections for asset {3} and is not sure which one to use since they have inconsistent networkAddress properties in their endpoint

    • NO_LINKED_ENDPOINT

      public static final GovernanceActionConnectorsAuditCode NO_LINKED_ENDPOINT
      GOVERNANCE-ACTION-CONNECTORS-0013 - The {0} governance action service detected that asset {1} has no endpoint linked to connection {2}

    • TOO_MANY_ENDPOINTS

      public static final GovernanceActionConnectorsAuditCode TOO_MANY_ENDPOINTS
      GOVERNANCE-ACTION-CONNECTORS-0014 - The {0} governance action service detected that asset {1} has a linked connection {2} with {3} linked endpoints which is not valid: {4}

    • NO_NETWORK_ADDRESS

      public static final GovernanceActionConnectorsAuditCode NO_NETWORK_ADDRESS
      GOVERNANCE-ACTION-CONNECTORS-0015 - The {0} governance action service detected that the endpoint {1} linked to connection {2} for asset {3} has no networkAddressProperty

    • UNABLE_TO_SET_COMPLETION_STATUS

      public static final GovernanceActionConnectorsAuditCode UNABLE_TO_SET_COMPLETION_STATUS
      GOVERNANCE-ACTION-CONNECTORS-0016 - The {0} governance action service received a {1} exception when it registered its completion status. The exception's message is: {2}

    • UNABLE_TO_REGISTER_LISTENER

      public static final GovernanceActionConnectorsAuditCode UNABLE_TO_REGISTER_LISTENER
      GOVERNANCE-ACTION-CONNECTORS-0017 - The {0} governance action service received a {1} exception when it registered a listener with the governance context. The exception's message is: {2}

    • NO_TARGETS

      public static final GovernanceActionConnectorsAuditCode NO_TARGETS
      GOVERNANCE-ACTION-CONNECTORS-0018 - The {0} governance action service has no targets to operate on

    • NO_ZONES

      public static final GovernanceActionConnectorsAuditCode NO_ZONES
      GOVERNANCE-ACTION-CONNECTORS-0019 - The {0} governance action service has publishZones set to null

    • SETTING_ZONES

      public static final GovernanceActionConnectorsAuditCode SETTING_ZONES
      GOVERNANCE-ACTION-CONNECTORS-0020 - The {0} governance action service is publishing asset {1} to the following zones: {2}

    • INITIATE_PROCESS

      public static final GovernanceActionConnectorsAuditCode INITIATE_PROCESS
      GOVERNANCE-ACTION-CONNECTORS-0021 - The {0} governance action service is initiating governance action process {1} with request parameters {2} for action targets {3}

    • INITIATE_PROCESS_EXCEPTION

      public static final GovernanceActionConnectorsAuditCode INITIATE_PROCESS_EXCEPTION
      GOVERNANCE-ACTION-CONNECTORS-0022 - The {0} governance action service encountered an {1} exception initiating governance action process {2} with request parameters {3} for action targets {4}. The exception message included was {5}

    • MISSING_TEMPLATE

      public static final GovernanceActionConnectorsAuditCode MISSING_TEMPLATE
      GOVERNANCE-ACTION-CONNECTORS-0023 - The {0} governance action service is unable to retrieve the template {1} configured in property {2}. The asset {3} was created without a template

    • BLANK_INFO_LOG_MESSAGE

      public static final GovernanceActionConnectorsAuditCode BLANK_INFO_LOG_MESSAGE
      GOVERNANCE-ACTION-CONNECTORS-0024 - {0}

  • Method Details

    • values

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