Package org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.directory.ffdc

Enum Class DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode

java.lang.Object

java.lang.Enum<DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode>

org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.directory.ffdc.DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode

All Implemented Interfaces:

Serializable, Comparable<DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode>, Constable, AuditLogMessageSet

public enum DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode
extends Enum<DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode>
implements AuditLogMessageSet

The DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode 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
BAD_FILE	OCF-DIRECTORY-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0002 - Unable to open directory "{0}".
OPENING_FILE	OCF-DIRECTORY-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0001 - Opening directory "{0}" for Open Metadata Archive Store

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

OPENING_FILE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode OPENING_FILE

OCF-DIRECTORY-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0001 - Opening directory "{0}" for Open Metadata Archive Store

BAD_FILE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorAuditCode BAD_FILE

OCF-DIRECTORY-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0002 - Unable to open directory "{0}". Message from {1} exception was {2}

Method Details

values

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

Returns:

string of property names and values for this enum