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

Enum Class JDBCIntegrationConnectorAuditCode

java.lang.Object

java.lang.Enum<JDBCIntegrationConnectorAuditCode>

org.odpi.openmetadata.adapters.connectors.integration.jdbc.ffdc.JDBCIntegrationConnectorAuditCode

All Implemented Interfaces:

Serializable, Comparable<JDBCIntegrationConnectorAuditCode>, Constable, AuditLogMessageSet

public enum JDBCIntegrationConnectorAuditCode
extends Enum<JDBCIntegrationConnectorAuditCode>
implements AuditLogMessageSet

The JDBCIntegrationConnectorAuditCode is used to define the message content for the 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
• 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
CONNECTION_FAILED	JDBC-INTEGRATION-CONNECTOR-0002 - Connector {0} is unable to extract metadata for database {1}
EXCEPTION_ON_CONTEXT_RETRIEVAL
EXCEPTION_READING_JDBC
EXCEPTION_READING_OMAS
EXCEPTION_WHEN_REMOVING_ELEMENT_IN_OMAS
EXCEPTION_WRITING_OMAS
EXITING_ON_COMPLETE	JDBC-INTEGRATION-CONNECTOR-0003 - Connector {0} has successfully extracted metadata from database {1}
EXITING_ON_CONNECTION_FAIL	JDBC-INTEGRATION-CONNECTOR-0001 - Connector {0} is unable to extract metadata for database {1}
EXITING_ON_DATABASE_TRANSFER_FAIL
EXITING_ON_INTEGRATION_CONTEXT_FAIL
EXITING_ON_METADATA_TEST
PARTIAL_TRANSFER_COMPLETE_FOR_DB_OBJECTS
STARTING_METADATA_TRANSFER	JDBC-INTEGRATION-CONNECTOR-0001 - Connector {0} is preparing to extract metadata from database {1}
TRANSFER_COMPLETE_FOR_DB_OBJECT
TRANSFER_EXCEPTIONS_FOR_DB_OBJECT
UNEXPECTED_EXCEPTION	JDBC-INTEGRATION-CONNECTOR-0003 - The JDBC Integration Connector {0} received an unexpected {1} exception 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 JDBCIntegrationConnectorAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JDBCIntegrationConnectorAuditCode[]	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

STARTING_METADATA_TRANSFER

public static final JDBCIntegrationConnectorAuditCode STARTING_METADATA_TRANSFER

JDBC-INTEGRATION-CONNECTOR-0001 - Connector {0} is preparing to extract metadata from database {1}

CONNECTION_FAILED

public static final JDBCIntegrationConnectorAuditCode CONNECTION_FAILED

JDBC-INTEGRATION-CONNECTOR-0002 - Connector {0} is unable to extract metadata for database {1}

EXITING_ON_CONNECTION_FAIL

public static final JDBCIntegrationConnectorAuditCode EXITING_ON_CONNECTION_FAIL

JDBC-INTEGRATION-CONNECTOR-0001 - Connector {0} is unable to extract metadata for database {1}

EXITING_ON_COMPLETE

public static final JDBCIntegrationConnectorAuditCode EXITING_ON_COMPLETE

JDBC-INTEGRATION-CONNECTOR-0003 - Connector {0} has successfully extracted metadata from database {1}

UNEXPECTED_EXCEPTION

public static final JDBCIntegrationConnectorAuditCode UNEXPECTED_EXCEPTION

JDBC-INTEGRATION-CONNECTOR-0003 - The JDBC Integration Connector {0} received an unexpected {1} exception during method {2}; the error message was: {3}

EXITING_ON_INTEGRATION_CONTEXT_FAIL

public static final JDBCIntegrationConnectorAuditCode EXITING_ON_INTEGRATION_CONTEXT_FAIL

EXCEPTION_READING_JDBC

public static final JDBCIntegrationConnectorAuditCode EXCEPTION_READING_JDBC

EXCEPTION_WRITING_OMAS

public static final JDBCIntegrationConnectorAuditCode EXCEPTION_WRITING_OMAS

EXITING_ON_DATABASE_TRANSFER_FAIL

public static final JDBCIntegrationConnectorAuditCode EXITING_ON_DATABASE_TRANSFER_FAIL

EXCEPTION_READING_OMAS

public static final JDBCIntegrationConnectorAuditCode EXCEPTION_READING_OMAS

PARTIAL_TRANSFER_COMPLETE_FOR_DB_OBJECTS

public static final JDBCIntegrationConnectorAuditCode PARTIAL_TRANSFER_COMPLETE_FOR_DB_OBJECTS

EXCEPTION_WHEN_REMOVING_ELEMENT_IN_OMAS

public static final JDBCIntegrationConnectorAuditCode EXCEPTION_WHEN_REMOVING_ELEMENT_IN_OMAS

EXCEPTION_ON_CONTEXT_RETRIEVAL

public static final JDBCIntegrationConnectorAuditCode EXCEPTION_ON_CONTEXT_RETRIEVAL

TRANSFER_COMPLETE_FOR_DB_OBJECT

public static final JDBCIntegrationConnectorAuditCode TRANSFER_COMPLETE_FOR_DB_OBJECT

TRANSFER_EXCEPTIONS_FOR_DB_OBJECT

public static final JDBCIntegrationConnectorAuditCode TRANSFER_EXCEPTIONS_FOR_DB_OBJECT

EXITING_ON_METADATA_TEST

public static final JDBCIntegrationConnectorAuditCode EXITING_ON_METADATA_TEST

Method Details

values

public static JDBCIntegrationConnectorAuditCode[] 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 JDBCIntegrationConnectorAuditCode 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<JDBCIntegrationConnectorAuditCode>

Returns:

string of property names and values for this enum