public final class TextAuditLogPublisher extends AccessLogPublisher<T> implements ConfigurationChangeListener<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 |
|---|---|
ConfigChangeResult |
applyConfigurationChange(FileBasedAuditLogPublisherCfg config)
Applies the configuration changes to this change listener.
|
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.
|
DN |
getDN()
Gets the DN of the configuration entry for this log publisher.
|
protected void |
initializeFilters(T config)
Initializes the filter configuration.
|
void |
initializeLogPublisher(FileBasedAuditLogPublisherCfg cfg,
ServerContext serverContext)
Initializes this publisher provider based on the information in the
provided debug publisher configuration.
|
boolean |
isConfigurationAcceptable(FileBasedAuditLogPublisherCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this log
publisher.
|
boolean |
isConfigurationChangeAcceptable(FileBasedAuditLogPublisherCfg config,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the proposed change to the configuration is
acceptable to this change listener.
|
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(Operation o)
Returns
true if the provided request should be logged. |
protected boolean |
isResponseLoggable(Operation o)
Returns
true if the provided response should be logged. |
void |
logAddResponse(AddOperation addOperation)
Writes a message to the access logger with information about the
add response associated with the provided add operation.
|
void |
logDeleteResponse(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the
delete response associated with the provided delete operation.
|
void |
logModifyDNResponse(ModifyDNOperation modifyDNOperation)
Writes a message to the access logger with information about the
modify DN response associated with the provided modify DN
operation.
|
void |
logModifyResponse(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the
modify response associated with the provided modify operation.
|
logAbandonRequest, logAbandonResult, logAddRequest, logBindRequest, logBindResponse, logCompareRequest, logCompareResponse, logConnect, logDeleteRequest, logDisconnect, logExtendedRequest, logExtendedResponse, logModifyDNRequest, logModifyRequest, logSearchRequest, logSearchResultDone, logUnbindprotected static final org.forgerock.i18n.slf4j.LocalizedLogger logger
public TextAuditLogPublisher()
public ConfigChangeResult applyConfigurationChange(FileBasedAuditLogPublisherCfg config)
applyConfigurationChange in interface ConfigurationChangeListener<FileBasedAuditLogPublisherCfg>config - The new configuration containing the changes.protected void close0()
public void initializeLogPublisher(FileBasedAuditLogPublisherCfg cfg, ServerContext serverContext) throws ConfigException, InitializationException
initializeLogPublisher in interface LogPublisher<FileBasedAuditLogPublisherCfg>cfg - The publisher configuration that contains the information to use
to initialize this publisher.serverContext - The server context.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(FileBasedAuditLogPublisherCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationAcceptable in interface LogPublisher<FileBasedAuditLogPublisherCfg>isConfigurationAcceptable in class AccessLogPublisher<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(FileBasedAuditLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable in interface ConfigurationChangeListener<FileBasedAuditLogPublisherCfg>config - The new configuration containing the changes.unacceptableReasons - A list that can be used to hold messages about why the
provided configuration is not acceptable.true if the proposed change is
acceptable, or false if it is not.public void logAddResponse(AddOperation addOperation)
The default implementation is to not log anything.
logAddResponse in class AccessLogPublisher<FileBasedAuditLogPublisherCfg>addOperation - The add operation containing the information to use to
log the add response.public void logDeleteResponse(DeleteOperation deleteOperation)
The default implementation is to not log anything.
logDeleteResponse in class AccessLogPublisher<FileBasedAuditLogPublisherCfg>deleteOperation - The delete operation containing the information to use
to log the delete response.public void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
The default implementation is to not log anything.
logModifyDNResponse in class AccessLogPublisher<FileBasedAuditLogPublisherCfg>modifyDNOperation - The modify DN operation containing the information to
use to log the modify DN response.public void logModifyResponse(ModifyOperation modifyOperation)
The default implementation is to not log anything.
logModifyResponse in class AccessLogPublisher<FileBasedAuditLogPublisherCfg>modifyOperation - The modify operation containing the information to use
to log the modify response.public final void close()
public final DN getDN()
protected void buildFilters(boolean suppressInternal)
suppressInternal - true if internal operations should be suppressed.protected final void initializeFilters(T config) throws ConfigException, InitializationException
config - The access publisher configuration that contains the information
to use to initialize this access publisher.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(Operation o)
true if the provided request should be logged.o - The request.true if the provided request should be logged.protected final boolean isResponseLoggable(Operation o)
true if the provided response should be logged.o - The response.true if the provided response should be logged.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.