public final class TextAuditLogPublisher extends AccessLogPublisher<T> implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
Modifier and Type | Field and Description |
---|---|
protected static org.forgerock.i18n.slf4j.LocalizedLogger |
logger
The tracer object for the debug logger.
|
Constructor and Description |
---|
TextAuditLogPublisher() |
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg config) |
protected void |
buildFilters(boolean suppressInternal)
For startup access logger.
|
void |
close()
Close this publisher.
|
protected void |
close0()
Release any resources owned by the sub-implementation.
|
org.forgerock.opendj.ldap.Dn |
getDN()
Gets the DN of the configuration entry for this log publisher.
|
protected String |
getTransactionId(org.forgerock.opendj.ldap.messages.Request request) |
protected void |
initializeFilters(T config)
Initializes the filter configuration.
|
void |
initializeLogPublisher(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg cfg,
ServerContext serverContext)
Initializes this publisher provider based on the information in the
provided debug publisher configuration.
|
boolean |
isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this log
publisher.
|
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg config,
List<LocalizableMessage> unacceptableReasons) |
protected boolean |
isConnectLoggable(ClientConnection c)
Returns
true if the provided client connect should be logged. |
protected boolean |
isDisconnectLoggable(ClientConnection c)
Returns
true if the provided client disconnect should be logged. |
protected boolean |
isFilterConfigurationAcceptable(T config,
List<LocalizableMessage> unacceptableReasons)
Perform any initialization required by the sub-implementation.
|
protected boolean |
isRequestLoggable(RequestDJContext context,
org.forgerock.opendj.ldap.messages.Request request)
Returns
true if the provided request should be logged. |
protected boolean |
isResponseLoggable(RequestDJContext context,
org.forgerock.opendj.ldap.messages.Request request,
org.forgerock.opendj.ldap.messages.Response response)
Returns
true if the provided response should be logged. |
void |
logAddResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AddRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the add result.
|
void |
logDeleteResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.DeleteRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the delete result.
|
void |
logModifyDnResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyDnRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the modifyDN result.
|
void |
logModifyResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the modify result.
|
logAbandonRequest, logAbandonResult, logAddRequest, logBindRequest, logBindResult, logCompareRequest, logCompareResult, logConnect, logDeleteRequest, logDisconnect, logExtendedRequest, logExtendedResult, logInvalidRequest, logInvalidResult, logModifyDnRequest, logModifyRequest, logSearchRequest, logSearchResult, logUnbind
protected static final org.forgerock.i18n.slf4j.LocalizedLogger logger
public TextAuditLogPublisher()
public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg config)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
protected void close0()
public void initializeLogPublisher(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg cfg, ServerContext serverContext) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
LogPublisher
initializeLogPublisher
in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
cfg
- The publisher configuration that contains the information to use
to initialize this publisher.serverContext
- The server context.org.forgerock.opendj.config.server.ConfigException
- If an unrecoverable problem arises in the process of performing
the initialization as a result of the server configuration.InitializationException
- If a problem occurs during initialization that is not related to
the server configuration.public boolean isConfigurationAcceptable(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg configuration, List<LocalizableMessage> unacceptableReasons)
LogPublisher
isConfigurationAcceptable
in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
isConfigurationAcceptable
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
configuration
- The log publisher configuration for which to make the
determination.unacceptableReasons
- A list that may be used to hold the reasons that the provided
configuration is not acceptable.true
if the provided configuration is acceptable for this
log publisher, or false
if not.public boolean isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
public void logAddResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logAddResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
context
- the logging context for the requestrequest
- the original add requestresult
- the result to logpublic void logDeleteResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logDeleteResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
context
- the logging context for the requestrequest
- the original delete requestresult
- the result to logpublic void logModifyResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logModifyResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modify requestresult
- the result to logpublic void logModifyDnResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logModifyDnResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAuditLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modifyDN requestresult
- the result to logprotected String getTransactionId(org.forgerock.opendj.ldap.messages.Request request)
public final void close()
LogPublisher
public final org.forgerock.opendj.ldap.Dn getDN()
LogPublisher
protected void buildFilters(boolean suppressInternal)
suppressInternal
- true
if internal operations should be suppressed.protected final void initializeFilters(T config) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
config
- The access publisher configuration that contains the information
to use to initialize this access publisher.org.forgerock.opendj.config.server.ConfigException
- If an unrecoverable problem arises in the process of performing
the initialization as a result of the server configuration.InitializationException
- If a problem occurs during initialization that is not related to
the server configuration.protected final boolean isConnectLoggable(ClientConnection c)
true
if the provided client connect should be logged.c
- The client connection.true
if the provided client connect should be logged.protected final boolean isDisconnectLoggable(ClientConnection c)
true
if the provided client disconnect should be logged.c
- The client connection.true
if the provided client disconnect should be logged.protected final boolean isFilterConfigurationAcceptable(T config, List<LocalizableMessage> unacceptableReasons)
config
- The access publisher configuration that contains the information
to use to initialize this access publisher.unacceptableReasons
- A list that may be used to hold the reasons that the provided
configuration is not acceptable.true
if the provided configuration is acceptable for this
access log publisher, or false
if not.protected final boolean isRequestLoggable(RequestDJContext context, org.forgerock.opendj.ldap.messages.Request request)
true
if the provided request should be logged.context
- the log contextrequest
- the request to logtrue
if the provided request should be logged.protected final boolean isResponseLoggable(RequestDJContext context, org.forgerock.opendj.ldap.messages.Request request, org.forgerock.opendj.ldap.messages.Response response)
true
if the provided response should be logged.context
- the log contextrequest
- the request to which the response correspondsresponse
- the response to logtrue
if the provided response should be logged.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.