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

Enum PostgresConnectorErrorCode

java.lang.Object

java.lang.Enum<PostgresConnectorErrorCode>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PostgresConnectorErrorCode>, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

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

The PostgresConnectorErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Postgres connector. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. The 5 fields in the enum are:

• HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
• • 500 - internal error
  • 400 - invalid parameters
  • 404 - not found
  • 409 - data conflict errors - eg item already defined
• Error Message Id - to uniquely identify the message
• Error Message Text - includes placeholder to allow additional values to be captured
• SystemAction - describes the result of the error
• UserAction - describes how a consumer should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALREADY_HANDLED_EXCEPTION
CONNECTOR_CHECKED_EXCEPTION
ERROR_READING_FROM_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.ExceptionMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition	getMessageDefinition(java.lang.String... params) Retrieve a message definition object for an exception.
static PostgresConnectorErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PostgresConnectorErrorCode[]	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_FROM_POSTGRES

public static final PostgresConnectorErrorCode ERROR_READING_FROM_POSTGRES

USER_NOT_AUTHORIZED_EXCEPTION

public static final PostgresConnectorErrorCode USER_NOT_AUTHORIZED_EXCEPTION

INVALID_PARAMETER_EXCEPTION

public static final PostgresConnectorErrorCode INVALID_PARAMETER_EXCEPTION

UNEXPECTED_ERROR

public static final PostgresConnectorErrorCode UNEXPECTED_ERROR

PROPERTY_SERVER_EXCEPTION

public static final PostgresConnectorErrorCode PROPERTY_SERVER_EXCEPTION

CONNECTOR_CHECKED_EXCEPTION

public static final PostgresConnectorErrorCode CONNECTOR_CHECKED_EXCEPTION

ALREADY_HANDLED_EXCEPTION

public static final PostgresConnectorErrorCode ALREADY_HANDLED_EXCEPTION

Method Detail

values

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

Returns:

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

valueOf

public static PostgresConnectorErrorCode 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.ExceptionMessageDefinition getMessageDefinition()

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

Specified by:

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

Returns:

message definition object.

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition getMessageDefinition(java.lang.String... params)

Retrieve a message definition object for an exception. 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.ExceptionMessageSet

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.