Package org.opends.server.loggers

Class CommonAudit

java.lang.Object

org.opends.server.loggers.CommonAudit

public final class CommonAudit
extends Object

Entry point for the common audit facility.

This class manages the AuditService instances and Audit Event Handlers that correspond to the publishers defined in OpenDJ configuration.

In theory there should be only one instance of AuditService for all the event handlers but defining one service per handler allow to perform filtering at the DJ server level.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommonAudit.HttpLogger	Represents a ForgeRock common audit based logger which can be used to log HTTP access audit events.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TRANSACTION_ID	Transaction id used when the incoming request does not contain a transaction id.

Constructor Summary

Constructors

Constructor	Description
CommonAudit(ServerContext serverContext)	Creates the common audit.

Method Summary

Modifier and Type	Method	Description
Collection<? extends CommonAudit.HttpLogger>	getHttpLogRequestHandlers()	Returns the audit service that manages HTTP Access logging.
boolean	isHttpAccessLogEnabled()	Indicates if HTTP access logging is enabled for common audit.
void	shutdown()	Shutdown common audit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_TRANSACTION_ID

public static final String DEFAULT_TRANSACTION_ID

Transaction id used when the incoming request does not contain a transaction id.

See Also:

• Constant Field Values

Constructor Details

CommonAudit

public CommonAudit(ServerContext serverContext)

Creates the common audit.

Parameters:

serverContext - The server context.

Method Details

shutdown

public void shutdown()

Shutdown common audit.

isHttpAccessLogEnabled

public boolean isHttpAccessLogEnabled()

Indicates if HTTP access logging is enabled for common audit.

Returns:

true if there is at least one HTTP access logger enabled for common audit.

getHttpLogRequestHandlers

public Collection<? extends CommonAudit.HttpLogger> getHttpLogRequestHandlers()

Returns the audit service that manages HTTP Access logging.

Returns:

the request handler that accepts audit events