org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc

Enum BasicFilesIntegrationConnectorsAuditCode

java.lang.Object

java.lang.Enum<BasicFilesIntegrationConnectorsAuditCode>

org.odpi.openmetadata.adapters.connectors.integration.basicfiles.ffdc.BasicFilesIntegrationConnectorsAuditCode

All Implemented Interfaces:

Serializable, Comparable<BasicFilesIntegrationConnectorsAuditCode>, AuditLogMessageSet

public enum BasicFilesIntegrationConnectorsAuditCode
extends Enum<BasicFilesIntegrationConnectorsAuditCode>
implements AuditLogMessageSet

The BasicFilesIntegrationConnectorsAuditCode 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

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_CONFIGURATION
BAD_FILE_ELEMENT
BAD_FOLDER_ELEMENT
CONNECTOR_CONFIGURATION
CONNECTOR_STOPPING
DATA_FILE_ARCHIVED
DATA_FILE_CREATED
DATA_FILE_CREATED_FROM_TEMPLATE
DATA_FILE_DELETED
DATA_FILE_UPDATED
DATA_FOLDER_UPDATED
DATA_FOLDER_UPDATED_FOR_FILE
DIRECTORY_MONITORING_STARTING
DIRECTORY_MONITORING_STOPPING
MISSING_TEMPLATE
UNEXPECTED_EXC_DATA_FILE_UPDATE
UNEXPECTED_EXC_FOLDER_UPDATE
UNEXPECTED_EXC_MONITOR_START
UNEXPECTED_EXC_MONITOR_STOP
UNEXPECTED_EXC_RETRIEVING_FOLDER

Method Summary

Modifier and Type	Method and 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 BasicFilesIntegrationConnectorsAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static BasicFilesIntegrationConnectorsAuditCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONNECTOR_CONFIGURATION

public static final BasicFilesIntegrationConnectorsAuditCode CONNECTOR_CONFIGURATION

BAD_CONFIGURATION

public static final BasicFilesIntegrationConnectorsAuditCode BAD_CONFIGURATION

BAD_FOLDER_ELEMENT

public static final BasicFilesIntegrationConnectorsAuditCode BAD_FOLDER_ELEMENT

UNEXPECTED_EXC_RETRIEVING_FOLDER

public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_RETRIEVING_FOLDER

DIRECTORY_MONITORING_STARTING

public static final BasicFilesIntegrationConnectorsAuditCode DIRECTORY_MONITORING_STARTING

UNEXPECTED_EXC_MONITOR_START

public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_MONITOR_START

DIRECTORY_MONITORING_STOPPING

public static final BasicFilesIntegrationConnectorsAuditCode DIRECTORY_MONITORING_STOPPING

UNEXPECTED_EXC_MONITOR_STOP

public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_MONITOR_STOP

CONNECTOR_STOPPING

public static final BasicFilesIntegrationConnectorsAuditCode CONNECTOR_STOPPING

DATA_FOLDER_UPDATED

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FOLDER_UPDATED

DATA_FOLDER_UPDATED_FOR_FILE

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FOLDER_UPDATED_FOR_FILE

UNEXPECTED_EXC_FOLDER_UPDATE

public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_FOLDER_UPDATE

BAD_FILE_ELEMENT

public static final BasicFilesIntegrationConnectorsAuditCode BAD_FILE_ELEMENT

UNEXPECTED_EXC_DATA_FILE_UPDATE

public static final BasicFilesIntegrationConnectorsAuditCode UNEXPECTED_EXC_DATA_FILE_UPDATE

MISSING_TEMPLATE

public static final BasicFilesIntegrationConnectorsAuditCode MISSING_TEMPLATE

DATA_FILE_CREATED

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_CREATED

DATA_FILE_CREATED_FROM_TEMPLATE

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_CREATED_FROM_TEMPLATE

DATA_FILE_UPDATED

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_UPDATED

DATA_FILE_DELETED

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_DELETED

DATA_FILE_ARCHIVED

public static final BasicFilesIntegrationConnectorsAuditCode DATA_FILE_ARCHIVED

Method Detail

values

public static BasicFilesIntegrationConnectorsAuditCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BasicFilesIntegrationConnectorsAuditCode c : BasicFilesIntegrationConnectorsAuditCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BasicFilesIntegrationConnectorsAuditCode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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<BasicFilesIntegrationConnectorsAuditCode>

Returns:

string of property names and values for this enum