OpenMetadataSecurityErrorCode (Metadata Security Connectors 2.8 API)

java.lang.Object
- java.lang.Enum<OpenMetadataSecurityErrorCode>
- - org.odpi.openmetadata.metadatasecurity.ffdc.OpenMetadataSecurityErrorCode

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataSecurityErrorCode>, 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 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
`BAD_PLATFORM_SECURITY_CONNECTION`
`BAD_SERVER_SECURITY_CONNECTION`
`INCOMPLETE_ASSET`
`UNAUTHORIZED_ASSET_ACCESS`
`UNAUTHORIZED_ASSET_CHANGE`
`UNAUTHORIZED_ASSET_CREATE`
`UNAUTHORIZED_ASSET_FEEDBACK`
`UNAUTHORIZED_CONNECTION_ACCESS`
`UNAUTHORIZED_INSTANCE_ACCESS`
`UNAUTHORIZED_INSTANCE_CHANGE`
`UNAUTHORIZED_PLATFORM_ACCESS`
`UNAUTHORIZED_SERVER_ACCESS`
`UNAUTHORIZED_SERVICE_ACCESS`
`UNAUTHORIZED_TYPE_ACCESS`
`UNAUTHORIZED_TYPE_CHANGE`
`UNAUTHORIZED_ZONE_CHANGE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 type with the specified name.
`static OpenMetadataSecurityErrorCode[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - BAD_PLATFORM_SECURITY_CONNECTION
```
public static final OpenMetadataSecurityErrorCode BAD_PLATFORM_SECURITY_CONNECTION
```
  - BAD_SERVER_SECURITY_CONNECTION
```
public static final OpenMetadataSecurityErrorCode BAD_SERVER_SECURITY_CONNECTION
```
  - UNAUTHORIZED_PLATFORM_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_PLATFORM_ACCESS
```
  - UNAUTHORIZED_SERVER_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_SERVER_ACCESS
```
  - UNAUTHORIZED_SERVICE_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_SERVICE_ACCESS
```
  - UNAUTHORIZED_ASSET_FEEDBACK
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_FEEDBACK
```
  - UNAUTHORIZED_ZONE_CHANGE
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ZONE_CHANGE
```
  - UNAUTHORIZED_CONNECTION_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_CONNECTION_ACCESS
```
  - UNAUTHORIZED_ASSET_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_ACCESS
```
  - UNAUTHORIZED_ASSET_CREATE
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_CREATE
```
  - UNAUTHORIZED_ASSET_CHANGE
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_ASSET_CHANGE
```
  - INCOMPLETE_ASSET
```
public static final OpenMetadataSecurityErrorCode INCOMPLETE_ASSET
```
  - UNAUTHORIZED_TYPE_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_TYPE_ACCESS
```
  - UNAUTHORIZED_TYPE_CHANGE
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_TYPE_CHANGE
```
  - UNAUTHORIZED_INSTANCE_ACCESS
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_INSTANCE_ACCESS
```
  - UNAUTHORIZED_INSTANCE_CHANGE
```
public static final OpenMetadataSecurityErrorCode UNAUTHORIZED_INSTANCE_CHANGE
```
- Method Detail
  - values
```
public static OpenMetadataSecurityErrorCode[] 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 (OpenMetadataSecurityErrorCode c : OpenMetadataSecurityErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OpenMetadataSecurityErrorCode valueOf(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:
    
    IllegalArgumentException - if this enum type 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

Enum OpenMetadataSecurityErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BAD_PLATFORM_SECURITY_CONNECTION

BAD_SERVER_SECURITY_CONNECTION

UNAUTHORIZED_PLATFORM_ACCESS

UNAUTHORIZED_SERVER_ACCESS

UNAUTHORIZED_SERVICE_ACCESS

UNAUTHORIZED_ASSET_FEEDBACK

UNAUTHORIZED_ZONE_CHANGE

UNAUTHORIZED_CONNECTION_ACCESS

UNAUTHORIZED_ASSET_ACCESS

UNAUTHORIZED_ASSET_CREATE

UNAUTHORIZED_ASSET_CHANGE

INCOMPLETE_ASSET

UNAUTHORIZED_TYPE_ACCESS

UNAUTHORIZED_TYPE_CHANGE

UNAUTHORIZED_INSTANCE_ACCESS

UNAUTHORIZED_INSTANCE_CHANGE

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString