Package org.odpi.openmetadata.adapters.connectors.integration.openapis.ffdc

Enum Class OpenAPIIntegrationConnectorAuditCode

java.lang.Object

java.lang.Enum<OpenAPIIntegrationConnectorAuditCode>

org.odpi.openmetadata.adapters.connectors.integration.openapis.ffdc.OpenAPIIntegrationConnectorAuditCode

All Implemented Interfaces:

Serializable, Comparable<OpenAPIIntegrationConnectorAuditCode>, Constable, AuditLogMessageSet

public enum OpenAPIIntegrationConnectorAuditCode
extends Enum<OpenAPIIntegrationConnectorAuditCode>
implements AuditLogMessageSet

The OpenAPIIntegrationConnectorAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:

• Log Message Identifier - 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
• Additional Information - further parameters and data relating to the audit message (optional)
• 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
BAD_ELEMENT
CATALOGUED_OPEN_API_SPEC
CLIENT_SIDE_REST_API_ERROR
CONNECTOR_CONFIGURATION_NO_ENDPOINT
CONNECTOR_CONFIGURATION_WITH_ENDPOINT
CONNECTOR_REFRESH_ALL_ENDPOINTS
CONNECTOR_REFRESH_WITH_ENDPOINT
CONNECTOR_STOPPING
MISSING_TEMPLATE
NEW_ENDPOINT
RETRIEVED_OPEN_API_SPEC
UNABLE_TO_RETRIEVE_OPEN_API_SPEC
UNEXPECTED_EXCEPTION

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

CONNECTOR_CONFIGURATION_WITH_ENDPOINT

public static final OpenAPIIntegrationConnectorAuditCode CONNECTOR_CONFIGURATION_WITH_ENDPOINT

CONNECTOR_CONFIGURATION_NO_ENDPOINT

public static final OpenAPIIntegrationConnectorAuditCode CONNECTOR_CONFIGURATION_NO_ENDPOINT

CONNECTOR_REFRESH_WITH_ENDPOINT

public static final OpenAPIIntegrationConnectorAuditCode CONNECTOR_REFRESH_WITH_ENDPOINT

CONNECTOR_REFRESH_ALL_ENDPOINTS

public static final OpenAPIIntegrationConnectorAuditCode CONNECTOR_REFRESH_ALL_ENDPOINTS

NEW_ENDPOINT

public static final OpenAPIIntegrationConnectorAuditCode NEW_ENDPOINT

RETRIEVED_OPEN_API_SPEC

public static final OpenAPIIntegrationConnectorAuditCode RETRIEVED_OPEN_API_SPEC

CATALOGUED_OPEN_API_SPEC

public static final OpenAPIIntegrationConnectorAuditCode CATALOGUED_OPEN_API_SPEC

UNABLE_TO_RETRIEVE_OPEN_API_SPEC

public static final OpenAPIIntegrationConnectorAuditCode UNABLE_TO_RETRIEVE_OPEN_API_SPEC

CONNECTOR_STOPPING

public static final OpenAPIIntegrationConnectorAuditCode CONNECTOR_STOPPING

MISSING_TEMPLATE

public static final OpenAPIIntegrationConnectorAuditCode MISSING_TEMPLATE

BAD_ELEMENT

public static final OpenAPIIntegrationConnectorAuditCode BAD_ELEMENT

UNEXPECTED_EXCEPTION

public static final OpenAPIIntegrationConnectorAuditCode UNEXPECTED_EXCEPTION

CLIENT_SIDE_REST_API_ERROR

public static final OpenAPIIntegrationConnectorAuditCode CLIENT_SIDE_REST_API_ERROR

Method Details

values

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<OpenAPIIntegrationConnectorAuditCode>

Returns:

string of property names and values for this enum