OpenMetadataSecurityAuditCode (Metadata Security Connectors 2.8 API)

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

All Implemented Interfaces:

Serializable, Comparable<OpenMetadataSecurityAuditCode>, AuditLogMessageSet
```
public enum OpenMetadataSecurityAuditCode
extends Enum<OpenMetadataSecurityAuditCode>
implements AuditLogMessageSet
```
The OpenMetadataSecurityAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:
- Log Message Id - 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

Enum Constant Summary

Enum Constants
Enum Constant and Description
`INCOMPLETE_ASSET`
`PLATFORM_INITIALIZING`
`PLATFORM_SHUTDOWN`
`SERVICE_INITIALIZING`
`SERVICE_SHUTDOWN`
`UNAUTHORIZED_ASSET_ACCESS`
`UNAUTHORIZED_ASSET_CHANGE`
`UNAUTHORIZED_ASSET_CREATE`
`UNAUTHORIZED_ASSET_FEEDBACK`
`UNAUTHORIZED_CONNECTION_ACCESS`
`UNAUTHORIZED_INSTANCE_ACCESS`
`UNAUTHORIZED_INSTANCE_CHANGE`
`UNAUTHORIZED_INSTANCE_CREATE`
`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
`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 OpenMetadataSecurityAuditCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OpenMetadataSecurityAuditCode[]`	`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
  - PLATFORM_INITIALIZING
```
public static final OpenMetadataSecurityAuditCode PLATFORM_INITIALIZING
```
  - PLATFORM_SHUTDOWN
```
public static final OpenMetadataSecurityAuditCode PLATFORM_SHUTDOWN
```
  - SERVICE_INITIALIZING
```
public static final OpenMetadataSecurityAuditCode SERVICE_INITIALIZING
```
  - SERVICE_SHUTDOWN
```
public static final OpenMetadataSecurityAuditCode SERVICE_SHUTDOWN
```
  - UNAUTHORIZED_PLATFORM_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_PLATFORM_ACCESS
```
  - UNAUTHORIZED_SERVER_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_SERVER_ACCESS
```
  - UNAUTHORIZED_SERVICE_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_SERVICE_ACCESS
```
  - UNAUTHORIZED_ASSET_FEEDBACK
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_FEEDBACK
```
  - UNAUTHORIZED_ZONE_CHANGE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ZONE_CHANGE
```
  - UNAUTHORIZED_CONNECTION_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_CONNECTION_ACCESS
```
  - UNAUTHORIZED_ASSET_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_ACCESS
```
  - UNAUTHORIZED_ASSET_CREATE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_CREATE
```
  - UNAUTHORIZED_ASSET_CHANGE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_ASSET_CHANGE
```
  - INCOMPLETE_ASSET
```
public static final OpenMetadataSecurityAuditCode INCOMPLETE_ASSET
```
  - UNAUTHORIZED_TYPE_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_TYPE_ACCESS
```
  - UNAUTHORIZED_TYPE_CHANGE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_TYPE_CHANGE
```
  - UNAUTHORIZED_INSTANCE_CREATE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_CREATE
```
  - UNAUTHORIZED_INSTANCE_ACCESS
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_ACCESS
```
  - UNAUTHORIZED_INSTANCE_CHANGE
```
public static final OpenMetadataSecurityAuditCode UNAUTHORIZED_INSTANCE_CHANGE
```
- Method Detail
  - values
```
public static OpenMetadataSecurityAuditCode[] 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 (OpenMetadataSecurityAuditCode c : OpenMetadataSecurityAuditCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OpenMetadataSecurityAuditCode 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 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<OpenMetadataSecurityAuditCode>
    
    Returns:
    
    string of property names and values for this enum

Enum OpenMetadataSecurityAuditCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PLATFORM_INITIALIZING

PLATFORM_SHUTDOWN

SERVICE_INITIALIZING

SERVICE_SHUTDOWN

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_CREATE

UNAUTHORIZED_INSTANCE_ACCESS

UNAUTHORIZED_INSTANCE_CHANGE

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString