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

Enum PostgresConnectorAuditCode

java.lang.Object

java.lang.Enum<PostgresConnectorAuditCode>

org.odpi.openmetadata.adapters.connectors.integration.postgres.ffdc.PostgresConnectorAuditCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PostgresConnectorAuditCode>, org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet

public enum PostgresConnectorAuditCode
extends java.lang.Enum<PostgresConnectorAuditCode>
implements org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTOR_CHECKED_EXCEPTION
ERROR_READING_POSTGRES
INVALID_PARAMETER_EXCEPTION
PROPERTY_SERVER_EXCEPTION
UNEXPECTED_ERROR
USER_NOT_AUTHORIZED_EXCEPTION

Method Summary

Modifier and Type	Method and Description
org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition	getMessageDefinition() Retrieve a message definition object for logging.
org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition	getMessageDefinition(java.lang.String... params) Retrieve a message definition object for logging.
static PostgresConnectorAuditCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PostgresConnectorAuditCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ERROR_READING_POSTGRES

public static final PostgresConnectorAuditCode ERROR_READING_POSTGRES

USER_NOT_AUTHORIZED_EXCEPTION

public static final PostgresConnectorAuditCode USER_NOT_AUTHORIZED_EXCEPTION

PROPERTY_SERVER_EXCEPTION

public static final PostgresConnectorAuditCode PROPERTY_SERVER_EXCEPTION

INVALID_PARAMETER_EXCEPTION

public static final PostgresConnectorAuditCode INVALID_PARAMETER_EXCEPTION

CONNECTOR_CHECKED_EXCEPTION

public static final PostgresConnectorAuditCode CONNECTOR_CHECKED_EXCEPTION

UNEXPECTED_ERROR

public static final PostgresConnectorAuditCode UNEXPECTED_ERROR

Method Detail

values

public static PostgresConnectorAuditCode[] 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 (PostgresConnectorAuditCode c : PostgresConnectorAuditCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static PostgresConnectorAuditCode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition()

Retrieve a message definition object for logging. This method is used when there are no message inserts.

Specified by:

getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet

Returns:

message definition object.

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition(java.lang.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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.