AuditConstants (OpenAM Project 15.1.7-SNAPSHOT API)

java.lang.Object
- org.forgerock.openam.audit.AuditConstants

```
public final class AuditConstants
extends Object
```
Collection of constants related to auditing.

Since:

13.0.0

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AuditConstants.AuthenticationFailureReason` Predefined values for the entries in the authentication audit "entries/info/failureReason" field.
`static class`	`AuditConstants.Component` Predefined components for audit events.
`static class`	`AuditConstants.ConfigOperation` Predefined operations for configuration events.
`static class`	`AuditConstants.EntriesInfoFieldKey` Predefined keys for the entries in the authentication audit "entries/info" field.
`static class`	`AuditConstants.EventName` Predefined names for audit events.
`static class`	`AuditConstants.TrackingIdKey` Predefined tracking ID types.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_RESPONSE_DETAIL_REASON` The field name to use when adding a "reason" string to the /response/detail object of an access event.
`static String`	`ACCESS_TOPIC` The topic to which events built using `AMAccessAuditEventBuilder` should be routed.
`static String`	`ACTIVITY_TOPIC` The topic to which events built using `AMActivityAuditEventBuilder` should be routed.
`static String`	`AUTHENTICATION_TOPIC` The topic to which events built using `AMAuthenticationAuditEventBuilder` should be routed.
`static String`	`CONFIG_TOPIC` The topic to which events built using `AMConfigAuditEventBuilder` should be routed.
`static String`	`DEBUG_NAME` Name of the `Debug` instance.
`static String`	`EVENT_REALM` Names of the realm field on an audit event.
`static String`	`LOGIN_MODULE_CONTROL_FLAG` Key for the login module control flag that can be added `AuditRequestContext`.
`static String`	`NO_REALM` To access the default audit service via `AuditEventFactory.accessEvent(String)` and `AuditEventPublisher#isAuditing(String, String, EventName)` you can provide null or an empty string.
`static String`	`OAUTH2_AUDIT_CONTEXT_PROVIDERS` The OAuth2 audit context providers, responsible for finding details which can be audit logged from various tokens which may be attached to requests and/or responses.
`static String`	`SERVICE_NAME` SMS service name for the audit service.
`static String`	`USER_ID` Names of fields on an audit events.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ACCESS_TOPIC
```
public static final String ACCESS_TOPIC
```
    The topic to which events built using AMAccessAuditEventBuilder should be routed.
    
    See Also:
    
    Constant Field Values
  - ACTIVITY_TOPIC
```
public static final String ACTIVITY_TOPIC
```
    The topic to which events built using AMActivityAuditEventBuilder should be routed.
    
    See Also:
    
    Constant Field Values
  - CONFIG_TOPIC
```
public static final String CONFIG_TOPIC
```
    The topic to which events built using AMConfigAuditEventBuilder should be routed.
    
    See Also:
    
    Constant Field Values
  - AUTHENTICATION_TOPIC
```
public static final String AUTHENTICATION_TOPIC
```
    The topic to which events built using AMAuthenticationAuditEventBuilder should be routed.
    
    See Also:
    
    Constant Field Values
  - SERVICE_NAME
```
public static final String SERVICE_NAME
```
    SMS service name for the audit service.
    
    See Also:
    
    Constant Field Values
  - DEBUG_NAME
```
public static final String DEBUG_NAME
```
    Name of the Debug instance.
    
    See Also:
    
    Constant Field Values
  - USER_ID
```
public static final String USER_ID
```
    Names of fields on an audit events.
    
    See Also:
    
    Constant Field Values
  - EVENT_REALM
```
public static final String EVENT_REALM
```
    Names of the realm field on an audit event.
    
    See Also:
    
    Constant Field Values
  - NO_REALM
```
public static final String NO_REALM
```
    To access the default audit service via AuditEventFactory.accessEvent(String) and AuditEventPublisher#isAuditing(String, String, EventName) you can provide null or an empty string. We deliberately do not provide a convenience method with no realm to force implementers to consider providing the realm.
  - OAUTH2_AUDIT_CONTEXT_PROVIDERS
```
public static final String OAUTH2_AUDIT_CONTEXT_PROVIDERS
```
    The OAuth2 audit context providers, responsible for finding details which can be audit logged from various tokens which may be attached to requests and/or responses.
    
    See Also:
    
    Constant Field Values
  - ACCESS_RESPONSE_DETAIL_REASON
```
public static final String ACCESS_RESPONSE_DETAIL_REASON
```
    The field name to use when adding a "reason" string to the /response/detail object of an access event.
    
    See Also:
    
    Constant Field Values
  - LOGIN_MODULE_CONTROL_FLAG
```
public static final String LOGIN_MODULE_CONTROL_FLAG
```
    Key for the login module control flag that can be added AuditRequestContext.
    
    See Also:
    
    Constant Field Values

Class AuditConstants

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACCESS_TOPIC

ACTIVITY_TOPIC

CONFIG_TOPIC

AUTHENTICATION_TOPIC

SERVICE_NAME

DEBUG_NAME

USER_ID

EVENT_REALM

NO_REALM

OAUTH2_AUDIT_CONTEXT_PROVIDERS

ACCESS_RESPONSE_DETAIL_REASON

LOGIN_MODULE_CONTROL_FLAG