AuditMessageQueue (ipf-commons-audit 4.0.0 API)

All Known Subinterfaces:

AbstractMockedAuditMessageQueue

All Known Implementing Classes:

AsynchronousAuditMessageQueue, BasicHttpAuditMessageQueue, CompositeAuditMessageQueue, JmsAuditMessageQueue, LoggingAuditMessageQueue, RecordingAuditMessageQueue, SynchronousAuditMessageQueue
```
public interface AuditMessageQueue
```
Determine the timing and priority in which audit messages are delivered. Examples for implementations are synchronous, asynchronous or JMS-based.

Since:

3.5

Author:

Christian Ohr

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`X_IPF_ATNA_APPLICATION`
`static String`	`X_IPF_ATNA_HOSTNAME`
`static String`	`X_IPF_ATNA_PROCESSID`
`static String`	`X_IPF_ATNA_TIMESTAMP`

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`void`	`audit(AuditContext auditContext, AuditMessage... auditMessages)`
`default void`	`flush()`	Forces all unsent messages in the queue to be sent
`default void`	`shutdown()`	Flushes the queue and shutdown any associated runtime daemons that may be handling queue inflow/outflow

- Field Detail
  - X_IPF_ATNA_TIMESTAMP
```
static final String X_IPF_ATNA_TIMESTAMP
```
    See Also:
    
    Constant Field Values
  - X_IPF_ATNA_HOSTNAME
```
static final String X_IPF_ATNA_HOSTNAME
```
    See Also:
    
    Constant Field Values
  - X_IPF_ATNA_PROCESSID
```
static final String X_IPF_ATNA_PROCESSID
```
    See Also:
    
    Constant Field Values
  - X_IPF_ATNA_APPLICATION
```
static final String X_IPF_ATNA_APPLICATION
```
    See Also:
    
    Constant Field Values
- Method Detail
  - audit
```
void audit(AuditContext auditContext,
           AuditMessage... auditMessages)
```
    Parameters:
    
    auditContext - IPF audit context
    
    auditMessages - one or more audit message instances
  - flush
```
default void flush()
```
    Forces all unsent messages in the queue to be sent
  - shutdown
```
default void shutdown()
```
    Flushes the queue and shutdown any associated runtime daemons that may be handling queue inflow/outflow