public class CommonAudit extends Object
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.
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_TRANSACTION_ID
Transaction id used when the incoming request does not contain a transaction id.
|
Constructor and Description |
---|
CommonAudit(ServerContext serverContext)
Creates the common audit.
|
Modifier and Type | Method and Description |
---|---|
void |
addOrUpdatePublisher(org.forgerock.opendj.server.config.server.LogPublisherCfg newConfig)
Adds or updates the publisher corresponding to the provided configuration to common audit.
|
org.forgerock.json.resource.RequestHandler |
getAuditServiceForHttpAccessLog()
Returns the audit service that manages HTTP Access logging.
|
org.forgerock.json.resource.RequestHandler |
getRequestHandler(org.forgerock.opendj.server.config.server.LogPublisherCfg config)
Returns the Common Audit request handler for the provided configuration.
|
boolean |
isCommonAuditConfig(org.forgerock.opendj.server.config.server.LogPublisherCfg config)
Indicates if the provided log publisher configuration corresponds to a common audit publisher.
|
boolean |
isExistingCommonAuditConfig(org.forgerock.opendj.server.config.server.LogPublisherCfg config)
Indicates if the provided log publisher configuration corresponds to a common audit publisher.
|
boolean |
isHttpAccessLogEnabled()
Indicates if HTTP access logging is enabled for common audit.
|
void |
removePublisher(org.forgerock.opendj.server.config.server.LogPublisherCfg config)
Removes the publisher corresponding to the provided configuration from common audit.
|
void |
setTrustTransactionIds(boolean shouldTrust)
Sets the indicator for transactionIds trusting.
|
boolean |
shouldTrustTransactionIds()
Indicates if transactionIds received from requests should be trusted.
|
void |
shutdown()
Shutdown common audit.
|
public static final String DEFAULT_TRANSACTION_ID
public CommonAudit(ServerContext serverContext) throws org.forgerock.opendj.config.server.ConfigException
serverContext
- The server context.org.forgerock.opendj.config.server.ConfigException
- If an error occurs.public boolean shouldTrustTransactionIds()
true
if transactionIds should be trusted, false
otherwisepublic void setTrustTransactionIds(boolean shouldTrust)
shouldTrust
- true
if transactionIds should be trusted, false
otherwisepublic org.forgerock.json.resource.RequestHandler getRequestHandler(org.forgerock.opendj.server.config.server.LogPublisherCfg config) throws org.forgerock.opendj.config.server.ConfigException
config
- The log publisher configurationorg.forgerock.opendj.config.server.ConfigException
- If an error occurspublic void addOrUpdatePublisher(org.forgerock.opendj.server.config.server.LogPublisherCfg newConfig) throws org.forgerock.opendj.config.server.ConfigException
newConfig
- Configuration of the publisherorg.forgerock.opendj.config.server.ConfigException
- If an error occurs.public void removePublisher(org.forgerock.opendj.server.config.server.LogPublisherCfg config) throws org.forgerock.opendj.config.server.ConfigException
config
- Configuration of publisher to removeorg.forgerock.opendj.config.server.ConfigException
- If an error occurs.public void shutdown()
public boolean isCommonAuditConfig(org.forgerock.opendj.server.config.server.LogPublisherCfg config) throws org.forgerock.opendj.config.server.ConfigException
The common audit publisher may not already exist.
This method must not be used when the corresponding configuration is deleted, because it implies checking the corresponding configuration entry in the server.
config
- The log publisher configuration.true
if publisher corresponds to a common audit publisherorg.forgerock.opendj.config.server.ConfigException
- If an error occurspublic boolean isExistingCommonAuditConfig(org.forgerock.opendj.server.config.server.LogPublisherCfg config) throws org.forgerock.opendj.config.server.ConfigException
config
- The log publisher configuration.true
if publisher is defined for common audit, false
otherwiseorg.forgerock.opendj.config.server.ConfigException
- If an error occurspublic boolean isHttpAccessLogEnabled()
true
if there is at least one HTTP access logger enabled for common audit.public org.forgerock.json.resource.RequestHandler getAuditServiceForHttpAccessLog()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.