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

Enum Class DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode

java.lang.Object

java.lang.Enum<DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode>

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

All Implemented Interfaces:

Serializable, Comparable<DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode>, Constable, ExceptionMessageSet

public enum DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode
extends Enum<DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode>
implements ExceptionMessageSet

The DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode is used to define first failure data capture (FFDC) for errors that occur within the DirectoryBasedOpenMetadataArchiveStoreConnector. It is used in conjunction with all exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:

• HTTP Error Code for translating between REST and JAVA. Typically the numbers used are:
• • 500: internal error
  • 501: not implemented
  • 503: Service not available
  • 400: invalid parameters
  • 401: unauthorized
  • 404: not found
  • 405: method not allowed
  • 409: data conflict errors, for example an item is 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 user should correct the error

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
ARCHIVE_UNAVAILABLE
BLANK_TYPENAME_IN_ARCHIVE
DUPLICATE_CLASSIFICATION_ATTR_IN_ARCHIVE
DUPLICATE_ENDDEF1_NAME_IN_ARCHIVE
DUPLICATE_ENDDEF2_NAME_IN_ARCHIVE
DUPLICATE_ENTITY_ATTR_IN_ARCHIVE
DUPLICATE_GUID_IN_ARCHIVE
DUPLICATE_INSTANCE_IN_ARCHIVE
DUPLICATE_RELATIONSHIP_ATTR_IN_ARCHIVE
DUPLICATE_TYPE_IN_ARCHIVE
DUPLICATE_TYPENAME_IN_ARCHIVE
MISSING_NAME_FOR_ARCHIVE
MISSING_TYPE_IN_ARCHIVE
UNEXPECTED_EXCEPTION
UNKNOWN_GUID

Method Summary

Modifier and Type	Method	Description
ExceptionMessageDefinition	getMessageDefinition()	Retrieve a message definition object for an exception.
ExceptionMessageDefinition	getMessageDefinition(String... params)	Retrieve a message definition object for an exception.
String	toString()	toString() JSON-style
static DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode[]	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

DUPLICATE_TYPE_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_TYPE_IN_ARCHIVE

DUPLICATE_INSTANCE_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_INSTANCE_IN_ARCHIVE

DUPLICATE_TYPENAME_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_TYPENAME_IN_ARCHIVE

DUPLICATE_GUID_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_GUID_IN_ARCHIVE

MISSING_TYPE_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode MISSING_TYPE_IN_ARCHIVE

MISSING_NAME_FOR_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode MISSING_NAME_FOR_ARCHIVE

DUPLICATE_ENDDEF1_NAME_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_ENDDEF1_NAME_IN_ARCHIVE

DUPLICATE_ENDDEF2_NAME_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_ENDDEF2_NAME_IN_ARCHIVE

DUPLICATE_RELATIONSHIP_ATTR_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_RELATIONSHIP_ATTR_IN_ARCHIVE

DUPLICATE_ENTITY_ATTR_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_ENTITY_ATTR_IN_ARCHIVE

DUPLICATE_CLASSIFICATION_ATTR_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode DUPLICATE_CLASSIFICATION_ATTR_IN_ARCHIVE

BLANK_TYPENAME_IN_ARCHIVE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode BLANK_TYPENAME_IN_ARCHIVE

UNEXPECTED_EXCEPTION

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode UNEXPECTED_EXCEPTION

UNKNOWN_GUID

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode UNKNOWN_GUID

ARCHIVE_UNAVAILABLE

public static final DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode ARCHIVE_UNAVAILABLE

Method Details

values

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

Returns:

message definition object.

getMessageDefinition

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

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<DirectoryBasedOpenMetadataArchiveStoreConnectorErrorCode>

Returns:

string description