Package org.odpi.openmetadata.metadatasecurity.ffdc

Enum Class OpenMetadataSecurityErrorCode

java.lang.Object

java.lang.Enum<OpenMetadataSecurityErrorCode>

org.odpi.openmetadata.metadatasecurity.ffdc.OpenMetadataSecurityErrorCode

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataSecurityErrorCode>, Constable, ExceptionMessageSet

public enum OpenMetadataSecurityErrorCode
extends Enum<OpenMetadataSecurityErrorCode>
implements ExceptionMessageSet

The OpenMetadataSecurityErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with open metadata security connectors. 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
  • 403 - forbidden
  • 404 - not found
  • 409 - data conflict errors - eg item already defined
• Error Message Identifier - 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

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_PLATFORM_SECURITY_CONNECTION	OMAG-PLATFORM-SECURITY-400-001 - The OMAG server platform has been configured with a bad connection to its platform security connector.
BAD_SERVER_SECURITY_CONNECTION	OMAG-PLATFORM-SECURITY-400-002 - The OMAG server {0} has been configured with a bad connection to its security connector.
FAILED_TO_RETRIEVE_USER	OPEN-METADATA-SECURITY-403-018 - Exception {0} occurred when retrieving user {1}; message was {2}
INCOMPLETE_ASSET	OMAG-SERVER-SECURITY-403-010 - User {0} is not authorized to change asset {1} because it has missing properties: {2}
MULTIPLE_CONNECTIONS_FOUND	OMAG-SERVER-SECURITY-403-015 - {0} connections are connected to the asset with unique identifier {1} but there is no security connector to select a connection for user {2}; the calling method is {3}
NO_CONNECTIONS_ALLOWED	OMAG-SERVER-SECURITY-403-016 - {0} connections are connected to the asset with unique identifier {1} but the user {2} is not permitted to use any of them; the calling method is {3}
NULL_GLOSSARY	OMAG-SERVER-SECURITY-500-002 - User {0} is not authorized to iss operation {1} because the glossary is null
UNAUTHORIZED_ASSET_ACCESS	OMAG-SERVER-SECURITY-403-007 - User {0} is not authorized to access asset {1}
UNAUTHORIZED_ASSET_CHANGE	OMAG-SERVER-SECURITY-403-009 - User {0} is not authorized to change asset {1}
UNAUTHORIZED_ASSET_CREATE	OMAG-SERVER-SECURITY-403-008 - User {0} is not authorized to create an asset of type {1}
UNAUTHORIZED_ASSET_FEEDBACK	OMAG-SERVER-SECURITY-403-004 - User {0} is not authorized to attach feedback to asset {1}
UNAUTHORIZED_CONNECTION_ACCESS	OMAG-SERVER-SECURITY-403-006 - User {0} is not authorized to access connection {1}
UNAUTHORIZED_GLOSSARY_ACCESS	OMAG-SERVER-SECURITY-403-020 - User {0} is not authorized to issue an operation {1} on glossary {2}
UNAUTHORIZED_INSTANCE_ACCESS	OMAG-SERVER-SECURITY-403-013 - User {0} is not authorized to access open metadata instance {1} of type {2} on server {3}
UNAUTHORIZED_INSTANCE_CHANGE	OMAG-SERVER-SECURITY-403-014 - User {0} is not authorized to change open metadata instance {1} of type {2} on server {3}
UNAUTHORIZED_PLATFORM_ACCESS	OMAG-PLATFORM-SECURITY-403-001 - User {0} is not authorized to issue request to {1}
UNAUTHORIZED_SERVER_ACCESS	OMAG-SERVER-SECURITY-403-002 - User {0} is not authorized to issue a request to server {1}
UNAUTHORIZED_SERVICE_ACCESS	OMAG-SERVER-SECURITY-403-003 - User {0} is not authorized to issue {1} requests
UNAUTHORIZED_TYPE_ACCESS	OMAG-SERVER-SECURITY-403-011 - User {0} is not authorized to access open metadata type {1} ({2}) on server {3}
UNAUTHORIZED_TYPE_CHANGE	OMAG-SERVER-SECURITY-403-012 - User {0} is not authorized to change open metadata type {1} ({2}) on server {3}
UNAUTHORIZED_ZONE_CHANGE	OMAG-SERVER-SECURITY-403-005 - User {0} is not authorized to change the zone membership for asset {1} from {2} to {3}
UNKNOWN_CONNECTION_RETURNED	OMAG-PLATFORM-SECURITY-500-001 - {0} connections are connected to the asset with unique identifier {1} but the connector selecting the connection for user {2} has returned an unrecognized connection; the calling method is {3}
UNKNOWN_USER	OPEN-METADATA-SECURITY-403-017 - User {0} is not recognized

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

BAD_PLATFORM_SECURITY_CONNECTION

public static final OpenMetadataSecurityErrorCode BAD_PLATFORM_SECURITY_CONNECTION

OMAG-PLATFORM-SECURITY-400-001 - The OMAG server platform has been configured with a bad connection to its platform security connector. Error message is {0}. Connection is {1}

BAD_SERVER_SECURITY_CONNECTION

public static final OpenMetadataSecurityErrorCode BAD_SERVER_SECURITY_CONNECTION

OMAG-PLATFORM-SECURITY-400-002 - The OMAG server {0} has been configured with a bad connection to its security connector. Error message is {1}. Connection is {2}

UNAUTHORIZED_PLATFORM_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_PLATFORM_ACCESS

OMAG-PLATFORM-SECURITY-403-001 - User {0} is not authorized to issue request to {1}

UNAUTHORIZED_SERVER_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_SERVER_ACCESS

OMAG-SERVER-SECURITY-403-002 - User {0} is not authorized to issue a request to server {1}

UNAUTHORIZED_SERVICE_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_SERVICE_ACCESS

OMAG-SERVER-SECURITY-403-003 - User {0} is not authorized to issue {1} requests

UNAUTHORIZED_ASSET_FEEDBACK

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_FEEDBACK

OMAG-SERVER-SECURITY-403-004 - User {0} is not authorized to attach feedback to asset {1}

UNAUTHORIZED_ZONE_CHANGE

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ZONE_CHANGE

OMAG-SERVER-SECURITY-403-005 - User {0} is not authorized to change the zone membership for asset {1} from {2} to {3}

UNAUTHORIZED_CONNECTION_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_CONNECTION_ACCESS

OMAG-SERVER-SECURITY-403-006 - User {0} is not authorized to access connection {1}

UNAUTHORIZED_ASSET_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_ACCESS

OMAG-SERVER-SECURITY-403-007 - User {0} is not authorized to access asset {1}

UNAUTHORIZED_ASSET_CREATE

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_CREATE

OMAG-SERVER-SECURITY-403-008 - User {0} is not authorized to create an asset of type {1}

UNAUTHORIZED_ASSET_CHANGE

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_CHANGE

OMAG-SERVER-SECURITY-403-009 - User {0} is not authorized to change asset {1}

INCOMPLETE_ASSET

public static final OpenMetadataSecurityErrorCode INCOMPLETE_ASSET

OMAG-SERVER-SECURITY-403-010 - User {0} is not authorized to change asset {1} because it has missing properties: {2}

UNAUTHORIZED_TYPE_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_TYPE_ACCESS

OMAG-SERVER-SECURITY-403-011 - User {0} is not authorized to access open metadata type {1} ({2}) on server {3}

UNAUTHORIZED_TYPE_CHANGE

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_TYPE_CHANGE

OMAG-SERVER-SECURITY-403-012 - User {0} is not authorized to change open metadata type {1} ({2}) on server {3}

UNAUTHORIZED_INSTANCE_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_INSTANCE_ACCESS

OMAG-SERVER-SECURITY-403-013 - User {0} is not authorized to access open metadata instance {1} of type {2} on server {3}

UNAUTHORIZED_INSTANCE_CHANGE

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_INSTANCE_CHANGE

OMAG-SERVER-SECURITY-403-014 - User {0} is not authorized to change open metadata instance {1} of type {2} on server {3}

MULTIPLE_CONNECTIONS_FOUND

public static final OpenMetadataSecurityErrorCode MULTIPLE_CONNECTIONS_FOUND

OMAG-SERVER-SECURITY-403-015 - {0} connections are connected to the asset with unique identifier {1} but there is no security connector to select a connection for user {2}; the calling method is {3}

NO_CONNECTIONS_ALLOWED

public static final OpenMetadataSecurityErrorCode NO_CONNECTIONS_ALLOWED

OMAG-SERVER-SECURITY-403-016 - {0} connections are connected to the asset with unique identifier {1} but the user {2} is not permitted to use any of them; the calling method is {3}

UNKNOWN_USER

public static final OpenMetadataSecurityErrorCode UNKNOWN_USER

OPEN-METADATA-SECURITY-403-017 - User {0} is not recognized

FAILED_TO_RETRIEVE_USER

public static final OpenMetadataSecurityErrorCode FAILED_TO_RETRIEVE_USER

OPEN-METADATA-SECURITY-403-018 - Exception {0} occurred when retrieving user {1}; message was {2}

UNAUTHORIZED_GLOSSARY_ACCESS

public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_GLOSSARY_ACCESS

OMAG-SERVER-SECURITY-403-020 - User {0} is not authorized to issue an operation {1} on glossary {2}

UNKNOWN_CONNECTION_RETURNED

public static final OpenMetadataSecurityErrorCode UNKNOWN_CONNECTION_RETURNED

OMAG-PLATFORM-SECURITY-500-001 - {0} connections are connected to the asset with unique identifier {1} but the connector selecting the connection for user {2} has returned an unrecognized connection; the calling method is {3}

NULL_GLOSSARY

public static final OpenMetadataSecurityErrorCode NULL_GLOSSARY

OMAG-SERVER-SECURITY-500-002 - User {0} is not authorized to iss operation {1} because the glossary is null

Method Details

values

public static OpenMetadataSecurityErrorCode[] 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 OpenMetadataSecurityErrorCode 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()

JSON-style toString

Overrides:

toString in class Enum<OpenMetadataSecurityErrorCode>

Returns:

string of property names and values for this enum