Package org.odpi.openmetadata.adapters.connectors.integration.apacheatlas.ffdc

Enum Class ApacheAtlasAuditCode

java.lang.Object
java.lang.Enum<ApacheAtlasAuditCode>
org.odpi.openmetadata.adapters.connectors.integration.apacheatlas.ffdc.ApacheAtlasAuditCode
All Implemented Interfaces:
Serializable, Comparable<ApacheAtlasAuditCode>, Constable, org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
public enum ApacheAtlasAuditCode extends Enum<ApacheAtlasAuditCode> implements org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
The ApacheAtlasAuditCode is used to define the message content for the OMRS 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
    BAD_CONFIGURATION
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0005 - The {0} integration connector encountered an {1} exception when connecting to {2} during the {3} method.
    CATEGORY_ALREADY_EXISTS
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0033 - Glossary category {0} already exists in Apache Atlas; trying a different name
    CLIENT_SIDE_REST_API_ERROR
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0031 - A client-side exception was received from API call {0} to server {1} at {2}.
    CONNECTOR_CONFIGURATION_ALL_ATLAS_GLOSSARIES
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0003 - The {0} integration connector has been initialized to publish all glossary terms from the Apache Atlas server at URL {1} to the open metadata ecosystem
    CONNECTOR_CONFIGURATION_ALL_EGERIA_GLOSSARIES
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0001 - The {0} integration connector has been initialized to publish all glossary terms to the Apache Atlas server at URL {1}
    CONNECTOR_CONFIGURATION_SPECIFIC_ATLAS_GLOSSARIES
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0004 - The {0} integration connector has been initialized to publish glossary terms from glossary {2} to the Apache Atlas server at URL {1}
    CONNECTOR_CONFIGURATION_SPECIFIC_EGERIA_GLOSSARIES
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0002 - The {0} integration connector has been initialized to publish glossary terms from glossary {2} in the Apache Atlas server at URL {1} to the open metadata ecosystem
    CONNECTOR_STOPPING
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0009 - The {0} integration connector has stopped its monitoring of Apache Atlas at {1} and is shutting down
    EGERIA_GLOSSARY_CATEGORY_DELETED
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0012 - The open metadata glossary category {0} equivalent for Apache Atlas glossary category {1} is missing
    EGERIA_GLOSSARY_DELETED
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0010 - The open metadata glossary {0} equivalent for Apache Atlas glossary {1} is missing
    EGERIA_GLOSSARY_TERM_DELETED
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0011 - The open metadata glossary term {0} equivalent for Apache Atlas glossary term {1} is missing
    EGERIA_GUID_MISSING
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0013 - The equivalent Apache Atlas GUID for {0} open metadata element {1} is not stored as an external identifier
    REPLACING_EGERIA_GLOSSARY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0014 - The open metadata glossary {0} for equivalent Apache Atlas glossary {1} has been unilaterally deleted; connector {2} is putting it back
    REPLACING_EGERIA_GLOSSARY_CATEGORY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0016 - The open metadata glossary category {0} for equivalent Apache Atlas glossary category {1} has been unilaterally deleted; connector {2} is putting it back
    REPLACING_EGERIA_GLOSSARY_TERM
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0015 - The open metadata glossary term {0} for equivalent Apache Atlas glossary term {1} has been unilaterally deleted; connector {2} is putting it back
    SYNC_ATLAS_GLOSSARY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0020 - The {0} integration connector is copying the Apache Atlas glossary called {1} into the {2} ({3}) open metadata glossary
    SYNC_ATLAS_GLOSSARY_CATEGORY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0022 - The {0} integration connector is copying the Apache Atlas glossary category called {1} into the {2} ({3}) open metadata glossary category
    SYNC_ATLAS_GLOSSARY_TERM
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0021 - The {0} integration connector is copying the Apache Atlas glossary term called {1} into the {2} ({3}) open metadata glossary term
    SYNC_EGERIA_GLOSSARY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0025 - The {0} integration connector is copying the open metadata glossary {1} ({2}) into the Apache Atlas glossary called {3}
    SYNC_EGERIA_GLOSSARY_CATEGORY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0027 - The {0} integration connector is copying the open metadata glossary category {1} ({2}) into the Apache Atlas glossary category called {3}
    SYNC_EGERIA_GLOSSARY_TERM
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0026 - The {0} integration connector is copying the open metadata glossary term {1} ({2}) into the Apache Atlas glossary term called {3}
    TERM_ALREADY_EXISTS
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0034 - Glossary term {0} already exists in Apache Atlas; trying a different name
    UNABLE_TO_REGISTER_LISTENER
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0032 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem.
    UNABLE_TO_RETRIEVE_ATLAS_GLOSSARY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0007 - The {0} integration connector us unable to retrieve requested {1} glossary from Apache Atlas
    UNABLE_TO_RETRIEVE_EGERIA_GLOSSARY
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0006 - The {0} integration connector is unable to retrieve the requested {1} glossary from the open metadata ecosystem
    UNEXPECTED_EXCEPTION
    APACHE-ATLAS-INTEGRATION-CONNECTOR-0008 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {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 ApacheAtlasAuditCode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ApacheAtlasAuditCode[]
    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

    • CONNECTOR_CONFIGURATION_ALL_EGERIA_GLOSSARIES

      public static final ApacheAtlasAuditCode CONNECTOR_CONFIGURATION_ALL_EGERIA_GLOSSARIES
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0001 - The {0} integration connector has been initialized to publish all glossary terms to the Apache Atlas server at URL {1}

    • CONNECTOR_CONFIGURATION_SPECIFIC_EGERIA_GLOSSARIES

      public static final ApacheAtlasAuditCode CONNECTOR_CONFIGURATION_SPECIFIC_EGERIA_GLOSSARIES
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0002 - The {0} integration connector has been initialized to publish glossary terms from glossary {2} in the Apache Atlas server at URL {1} to the open metadata ecosystem

    • CONNECTOR_CONFIGURATION_ALL_ATLAS_GLOSSARIES

      public static final ApacheAtlasAuditCode CONNECTOR_CONFIGURATION_ALL_ATLAS_GLOSSARIES
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0003 - The {0} integration connector has been initialized to publish all glossary terms from the Apache Atlas server at URL {1} to the open metadata ecosystem

    • CONNECTOR_CONFIGURATION_SPECIFIC_ATLAS_GLOSSARIES

      public static final ApacheAtlasAuditCode CONNECTOR_CONFIGURATION_SPECIFIC_ATLAS_GLOSSARIES
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0004 - The {0} integration connector has been initialized to publish glossary terms from glossary {2} to the Apache Atlas server at URL {1}

    • BAD_CONFIGURATION

      public static final ApacheAtlasAuditCode BAD_CONFIGURATION
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0005 - The {0} integration connector encountered an {1} exception when connecting to {2} during the {3} method. The exception message included was {4}

    • UNABLE_TO_RETRIEVE_EGERIA_GLOSSARY

      public static final ApacheAtlasAuditCode UNABLE_TO_RETRIEVE_EGERIA_GLOSSARY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0006 - The {0} integration connector is unable to retrieve the requested {1} glossary from the open metadata ecosystem

    • UNABLE_TO_RETRIEVE_ATLAS_GLOSSARY

      public static final ApacheAtlasAuditCode UNABLE_TO_RETRIEVE_ATLAS_GLOSSARY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0007 - The {0} integration connector us unable to retrieve requested {1} glossary from Apache Atlas

    • UNEXPECTED_EXCEPTION

      public static final ApacheAtlasAuditCode UNEXPECTED_EXCEPTION
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0008 - The {0} integration connector received an unexpected exception {1} during method {2}; the error message was: {3}

    • CONNECTOR_STOPPING

      public static final ApacheAtlasAuditCode CONNECTOR_STOPPING
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0009 - The {0} integration connector has stopped its monitoring of Apache Atlas at {1} and is shutting down

    • EGERIA_GLOSSARY_DELETED

      public static final ApacheAtlasAuditCode EGERIA_GLOSSARY_DELETED
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0010 - The open metadata glossary {0} equivalent for Apache Atlas glossary {1} is missing

    • EGERIA_GLOSSARY_TERM_DELETED

      public static final ApacheAtlasAuditCode EGERIA_GLOSSARY_TERM_DELETED
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0011 - The open metadata glossary term {0} equivalent for Apache Atlas glossary term {1} is missing

    • EGERIA_GLOSSARY_CATEGORY_DELETED

      public static final ApacheAtlasAuditCode EGERIA_GLOSSARY_CATEGORY_DELETED
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0012 - The open metadata glossary category {0} equivalent for Apache Atlas glossary category {1} is missing

    • EGERIA_GUID_MISSING

      public static final ApacheAtlasAuditCode EGERIA_GUID_MISSING
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0013 - The equivalent Apache Atlas GUID for {0} open metadata element {1} is not stored as an external identifier

    • REPLACING_EGERIA_GLOSSARY

      public static final ApacheAtlasAuditCode REPLACING_EGERIA_GLOSSARY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0014 - The open metadata glossary {0} for equivalent Apache Atlas glossary {1} has been unilaterally deleted; connector {2} is putting it back

    • REPLACING_EGERIA_GLOSSARY_TERM

      public static final ApacheAtlasAuditCode REPLACING_EGERIA_GLOSSARY_TERM
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0015 - The open metadata glossary term {0} for equivalent Apache Atlas glossary term {1} has been unilaterally deleted; connector {2} is putting it back

    • REPLACING_EGERIA_GLOSSARY_CATEGORY

      public static final ApacheAtlasAuditCode REPLACING_EGERIA_GLOSSARY_CATEGORY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0016 - The open metadata glossary category {0} for equivalent Apache Atlas glossary category {1} has been unilaterally deleted; connector {2} is putting it back

    • SYNC_ATLAS_GLOSSARY

      public static final ApacheAtlasAuditCode SYNC_ATLAS_GLOSSARY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0020 - The {0} integration connector is copying the Apache Atlas glossary called {1} into the {2} ({3}) open metadata glossary

    • SYNC_ATLAS_GLOSSARY_TERM

      public static final ApacheAtlasAuditCode SYNC_ATLAS_GLOSSARY_TERM
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0021 - The {0} integration connector is copying the Apache Atlas glossary term called {1} into the {2} ({3}) open metadata glossary term

    • SYNC_ATLAS_GLOSSARY_CATEGORY

      public static final ApacheAtlasAuditCode SYNC_ATLAS_GLOSSARY_CATEGORY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0022 - The {0} integration connector is copying the Apache Atlas glossary category called {1} into the {2} ({3}) open metadata glossary category

    • SYNC_EGERIA_GLOSSARY

      public static final ApacheAtlasAuditCode SYNC_EGERIA_GLOSSARY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0025 - The {0} integration connector is copying the open metadata glossary {1} ({2}) into the Apache Atlas glossary called {3}

    • SYNC_EGERIA_GLOSSARY_TERM

      public static final ApacheAtlasAuditCode SYNC_EGERIA_GLOSSARY_TERM
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0026 - The {0} integration connector is copying the open metadata glossary term {1} ({2}) into the Apache Atlas glossary term called {3}

    • SYNC_EGERIA_GLOSSARY_CATEGORY

      public static final ApacheAtlasAuditCode SYNC_EGERIA_GLOSSARY_CATEGORY
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0027 - The {0} integration connector is copying the open metadata glossary category {1} ({2}) into the Apache Atlas glossary category called {3}

    • CLIENT_SIDE_REST_API_ERROR

      public static final ApacheAtlasAuditCode CLIENT_SIDE_REST_API_ERROR
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0031 - A client-side exception was received from API call {0} to server {1} at {2}. The error message was {3}

    • UNABLE_TO_REGISTER_LISTENER

      public static final ApacheAtlasAuditCode UNABLE_TO_REGISTER_LISTENER
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0032 - The {0} integration connector encountered an {1} exception when registering a listener to the open metadata ecosystem. The exception message included was {2}

    • CATEGORY_ALREADY_EXISTS

      public static final ApacheAtlasAuditCode CATEGORY_ALREADY_EXISTS
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0033 - Glossary category {0} already exists in Apache Atlas; trying a different name

    • TERM_ALREADY_EXISTS

      public static final ApacheAtlasAuditCode TERM_ALREADY_EXISTS
      APACHE-ATLAS-INTEGRATION-CONNECTOR-0034 - Glossary term {0} already exists in Apache Atlas; trying a different name

  • Method Details

    • values

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