Package org.odpi.openmetadata.adapters.repositoryservices.cohortregistrystore.file.ffdc

Enum Class FileBasedRegistryStoreConnectorAuditCode

java.lang.Object

java.lang.Enum<FileBasedRegistryStoreConnectorAuditCode>

org.odpi.openmetadata.adapters.repositoryservices.cohortregistrystore.file.ffdc.FileBasedRegistryStoreConnectorAuditCode

All Implemented Interfaces:

Serializable, Comparable<FileBasedRegistryStoreConnectorAuditCode>, Constable, AuditLogMessageSet

public enum FileBasedRegistryStoreConnectorAuditCode
extends Enum<FileBasedRegistryStoreConnectorAuditCode>
implements AuditLogMessageSet

The FileBasedRegistryStoreConnectorAuditCode 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
CREATE_REGISTRY_FILE
DUPLICATE_REGISTERED_MC_ID
DUPLICATE_REGISTERED_SERVER_ADDR
DUPLICATE_REGISTERED_SERVER_NAME
MISSING_MEMBER_REGISTRATION
NULL_MEMBER_REGISTRATION
NULL_REGISTERED_MC_ID
NULL_REGISTERED_SERVER_ADDR
NULL_REGISTERED_SERVER_CONNECTION
NULL_REGISTERED_SERVER_NAME
UNUSABLE_REGISTRY_FILE

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATE_REGISTRY_FILE

public static final FileBasedRegistryStoreConnectorAuditCode CREATE_REGISTRY_FILE

UNUSABLE_REGISTRY_FILE

public static final FileBasedRegistryStoreConnectorAuditCode UNUSABLE_REGISTRY_FILE

NULL_MEMBER_REGISTRATION

public static final FileBasedRegistryStoreConnectorAuditCode NULL_MEMBER_REGISTRATION

MISSING_MEMBER_REGISTRATION

public static final FileBasedRegistryStoreConnectorAuditCode MISSING_MEMBER_REGISTRATION

DUPLICATE_REGISTERED_MC_ID

public static final FileBasedRegistryStoreConnectorAuditCode DUPLICATE_REGISTERED_MC_ID

NULL_REGISTERED_MC_ID

public static final FileBasedRegistryStoreConnectorAuditCode NULL_REGISTERED_MC_ID

DUPLICATE_REGISTERED_SERVER_NAME

public static final FileBasedRegistryStoreConnectorAuditCode DUPLICATE_REGISTERED_SERVER_NAME

NULL_REGISTERED_SERVER_NAME

public static final FileBasedRegistryStoreConnectorAuditCode NULL_REGISTERED_SERVER_NAME

DUPLICATE_REGISTERED_SERVER_ADDR

public static final FileBasedRegistryStoreConnectorAuditCode DUPLICATE_REGISTERED_SERVER_ADDR

NULL_REGISTERED_SERVER_ADDR

public static final FileBasedRegistryStoreConnectorAuditCode NULL_REGISTERED_SERVER_ADDR

NULL_REGISTERED_SERVER_CONNECTION

public static final FileBasedRegistryStoreConnectorAuditCode NULL_REGISTERED_SERVER_CONNECTION

Method Details

values

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