Enum Class FileBasedOpenMetadataArchiveStoreConnectorAuditCode
java.lang.Object
java.lang.Enum<FileBasedOpenMetadataArchiveStoreConnectorAuditCode>
org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.file.ffdc.FileBasedOpenMetadataArchiveStoreConnectorAuditCode
- All Implemented Interfaces:
Serializable
,Comparable<FileBasedOpenMetadataArchiveStoreConnectorAuditCode>
,Constable
,AuditLogMessageSet
public enum FileBasedOpenMetadataArchiveStoreConnectorAuditCode
extends Enum<FileBasedOpenMetadataArchiveStoreConnectorAuditCode>
implements AuditLogMessageSet
The FileBasedOpenMetadataArchiveStoreConnectorAuditCode 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 ConstantDescriptionFILE-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0002 - Unable to open file {0}.FILE-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0001 - Opening file {0} for Open Metadata Archive Store -
Method Summary
Modifier and TypeMethodDescriptionRetrieve a message definition object for logging.getMessageDefinition
(String... params) Retrieve a message definition object for logging.toString()
JSON-style toStringReturns the enum constant of this class with the specified name.values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OPENING_FILE
FILE-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0001 - Opening file {0} for Open Metadata Archive Store -
BAD_FILE
FILE-OPEN-METADATA-ARCHIVE-STORE-CONNECTOR-0002 - Unable to open file {0}. Message from {1} exception was {2}
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getMessageDefinition
Retrieve a message definition object for logging. This method is used when there are no message inserts.- Specified by:
getMessageDefinition
in interfaceAuditLogMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
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 interfaceAuditLogMessageSet
- 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
JSON-style toString- Overrides:
toString
in classEnum<FileBasedOpenMetadataArchiveStoreConnectorAuditCode>
- Returns:
- string of property names and values for this enum
-