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

Enum Class DynamicArchiverConnectorsAuditCode

java.lang.Object

java.lang.Enum<DynamicArchiverConnectorsAuditCode>

org.odpi.openmetadata.adapters.connectors.dynamicarchivers.ffdc.DynamicArchiverConnectorsAuditCode

All Implemented Interfaces:

Serializable, Comparable<DynamicArchiverConnectorsAuditCode>, Constable, AuditLogMessageSet

public enum DynamicArchiverConnectorsAuditCode
extends Enum<DynamicArchiverConnectorsAuditCode>
implements AuditLogMessageSet

The DynamicArchiveConnectorsAuditCode 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
COPY_FILE
CREATED_LINEAGE
DELETE_FILE
ENDPOINT_EXCEPTION
INITIATE_PROCESS
INITIATE_PROCESS_EXCEPTION
MOVE_FILE
NO_LINKED_CONNECTION
NO_LINKED_ENDPOINT
NO_NETWORK_ADDRESS
NO_RELATED_ASSET
NO_SOURCE_FILE_NAME
NO_TARGETS
NO_ZONES
PROVISIONING_EXCEPTION
PROVISIONING_FAILURE
QUALIFIED_NAME_PATH_NAME
SETTING_ZONES
TOO_MANY_CONNECTIONS
TOO_MANY_ENDPOINTS
UNABLE_TO_REGISTER_LISTENER
UNABLE_TO_SET_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 DynamicArchiverConnectorsAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DynamicArchiverConnectorsAuditCode[]	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 DynamicArchiverConnectorsAuditCode COPY_FILE

MOVE_FILE

public static final DynamicArchiverConnectorsAuditCode MOVE_FILE

DELETE_FILE

public static final DynamicArchiverConnectorsAuditCode DELETE_FILE

CREATED_LINEAGE

public static final DynamicArchiverConnectorsAuditCode CREATED_LINEAGE

NO_SOURCE_FILE_NAME

public static final DynamicArchiverConnectorsAuditCode NO_SOURCE_FILE_NAME

PROVISIONING_FAILURE

public static final DynamicArchiverConnectorsAuditCode PROVISIONING_FAILURE

PROVISIONING_EXCEPTION

public static final DynamicArchiverConnectorsAuditCode PROVISIONING_EXCEPTION

ENDPOINT_EXCEPTION

public static final DynamicArchiverConnectorsAuditCode ENDPOINT_EXCEPTION

QUALIFIED_NAME_PATH_NAME

public static final DynamicArchiverConnectorsAuditCode QUALIFIED_NAME_PATH_NAME

NO_LINKED_CONNECTION

public static final DynamicArchiverConnectorsAuditCode NO_LINKED_CONNECTION

TOO_MANY_CONNECTIONS

public static final DynamicArchiverConnectorsAuditCode TOO_MANY_CONNECTIONS

NO_RELATED_ASSET

public static final DynamicArchiverConnectorsAuditCode NO_RELATED_ASSET

NO_LINKED_ENDPOINT

public static final DynamicArchiverConnectorsAuditCode NO_LINKED_ENDPOINT

TOO_MANY_ENDPOINTS

public static final DynamicArchiverConnectorsAuditCode TOO_MANY_ENDPOINTS

NO_NETWORK_ADDRESS

public static final DynamicArchiverConnectorsAuditCode NO_NETWORK_ADDRESS

UNABLE_TO_SET_COMPLETION_STATUS

public static final DynamicArchiverConnectorsAuditCode UNABLE_TO_SET_COMPLETION_STATUS

UNABLE_TO_REGISTER_LISTENER

public static final DynamicArchiverConnectorsAuditCode UNABLE_TO_REGISTER_LISTENER

NO_TARGETS

public static final DynamicArchiverConnectorsAuditCode NO_TARGETS

NO_ZONES

public static final DynamicArchiverConnectorsAuditCode NO_ZONES

SETTING_ZONES

public static final DynamicArchiverConnectorsAuditCode SETTING_ZONES

INITIATE_PROCESS

public static final DynamicArchiverConnectorsAuditCode INITIATE_PROCESS

INITIATE_PROCESS_EXCEPTION

public static final DynamicArchiverConnectorsAuditCode INITIATE_PROCESS_EXCEPTION

Method Details

values

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

Returns:

string of property names and values for this enum