SecurityManagerErrorCode (Security Manager OMAS API 2.11 API)

java.lang.Object
- java.lang.Enum<SecurityManagerErrorCode>
- - org.odpi.openmetadata.accessservices.securitymanager.ffdc.SecurityManagerErrorCode

All Implemented Interfaces:

Serializable, Comparable<SecurityManagerErrorCode>, ExceptionMessageSet
```
public enum SecurityManagerErrorCode
extends Enum<SecurityManagerErrorCode>
implements ExceptionMessageSet
```
The SecurityManagerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Security Manager OMAS Services. 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
`ADD_CLASSIFICATION_EXCEPTION`
`ADD_ENTITY_EXCEPTION`
`ADD_RELATIONSHIP_EXCEPTION`
`GET_ENTITY_EXCEPTION`
`GET_RELATIONSHIP_EXCEPTION`
`NULL_LISTENER`
`OMRS_NOT_INITIALIZED`
`UNABLE_TO_SEND_EVENT`
`UNEXPECTED_INITIALIZATION_EXCEPTION`

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 SecurityManagerErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static SecurityManagerErrorCode[]`	`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
  - ADD_ENTITY_EXCEPTION
```
public static final SecurityManagerErrorCode ADD_ENTITY_EXCEPTION
```
  - ADD_RELATIONSHIP_EXCEPTION
```
public static final SecurityManagerErrorCode ADD_RELATIONSHIP_EXCEPTION
```
  - GET_ENTITY_EXCEPTION
```
public static final SecurityManagerErrorCode GET_ENTITY_EXCEPTION
```
  - GET_RELATIONSHIP_EXCEPTION
```
public static final SecurityManagerErrorCode GET_RELATIONSHIP_EXCEPTION
```
  - ADD_CLASSIFICATION_EXCEPTION
```
public static final SecurityManagerErrorCode ADD_CLASSIFICATION_EXCEPTION
```
  - OMRS_NOT_INITIALIZED
```
public static final SecurityManagerErrorCode OMRS_NOT_INITIALIZED
```
  - NULL_LISTENER
```
public static final SecurityManagerErrorCode NULL_LISTENER
```
  - UNABLE_TO_SEND_EVENT
```
public static final SecurityManagerErrorCode UNABLE_TO_SEND_EVENT
```
  - UNEXPECTED_INITIALIZATION_EXCEPTION
```
public static final SecurityManagerErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION
```
- Method Detail
  - values
```
public static SecurityManagerErrorCode[] 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 (SecurityManagerErrorCode c : SecurityManagerErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SecurityManagerErrorCode 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<SecurityManagerErrorCode>
    
    Returns:
    
    string of property names and values for this enum

Enum SecurityManagerErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ADD_ENTITY_EXCEPTION

ADD_RELATIONSHIP_EXCEPTION

GET_ENTITY_EXCEPTION

GET_RELATIONSHIP_EXCEPTION

ADD_CLASSIFICATION_EXCEPTION

OMRS_NOT_INITIALIZED

NULL_LISTENER

UNABLE_TO_SEND_EVENT

UNEXPECTED_INITIALIZATION_EXCEPTION

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString