public final class TextAccessLogPublisher extends AccessLogPublisher<T> implements ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
Modifier and Type | Field and Description |
---|---|
protected static org.forgerock.i18n.slf4j.LocalizedLogger |
logger
The tracer object for the debug logger.
|
Constructor and Description |
---|
TextAccessLogPublisher() |
Modifier and Type | Method and Description |
---|---|
ConfigChangeResult |
applyConfigurationChange(FileBasedAccessLogPublisherCfg 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.
|
static TextAccessLogPublisher |
getStartupTextAccessPublisher(TextWriter writer,
boolean suppressInternal)
Returns an instance of the text access log publisher that will print all
messages to the provided writer.
|
protected void |
initializeFilters(T config)
Initializes the filter configuration.
|
void |
initializeLogPublisher(FileBasedAccessLogPublisherCfg cfg,
ServerContext serverContext)
Initializes this publisher provider based on the information in the
provided debug publisher configuration.
|
boolean |
isConfigurationAcceptable(FileBasedAccessLogPublisherCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this log
publisher.
|
boolean |
isConfigurationChangeAcceptable(FileBasedAccessLogPublisherCfg 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 |
logAbandonRequest(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the abandon
request associated with the provided abandon operation.
|
void |
logAbandonResult(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the result of
the provided abandon operation.
|
void |
logAddRequest(AddOperation addOperation)
Writes a message to the access logger with information about the add
request associated with the provided add operation.
|
void |
logAddResponse(AddOperation addOperation)
Writes a message to the access logger with information about the add
response associated with the provided add operation.
|
void |
logBindRequest(BindOperation bindOperation)
Writes a message to the access logger with information about the bind
request associated with the provided bind operation.
|
void |
logBindResponse(BindOperation bindOperation)
Writes a message to the access logger with information about the bind
response associated with the provided bind operation.
|
void |
logCompareRequest(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare
request associated with the provided compare operation.
|
void |
logCompareResponse(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare
response associated with the provided compare operation.
|
void |
logConnect(ClientConnection clientConnection)
Writes a message to the access logger with information about a new client
connection that has been established, regardless of whether it will be
immediately terminated.
|
void |
logDeleteRequest(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the delete
request associated with the provided delete 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 |
logDisconnect(ClientConnection clientConnection,
DisconnectReason disconnectReason,
LocalizableMessage message)
Writes a message to the access logger with information about the
termination of an existing client connection.
|
void |
logExtendedRequest(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended
request associated with the provided extended operation.
|
void |
logExtendedResponse(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended
response associated with the provided extended operation.
|
void |
logModifyDNRequest(ModifyDNOperation modifyDNOperation)
Writes a message to the access logger with information about the modify DN
request associated with the provided modify DN 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 |
logModifyRequest(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify
request associated with the provided modify operation.
|
void |
logModifyResponse(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify
response associated with the provided modify operation.
|
void |
logSearchRequest(SearchOperation searchOperation)
Writes a message to the access logger with information about the search
request associated with the provided search operation.
|
void |
logSearchResultDone(SearchOperation searchOperation)
Writes a message to the access logger with information about the completion
of the provided search operation.
|
void |
logUnbind(UnbindOperation unbindOperation)
Writes a message to the access logger with information about the unbind
request associated with the provided unbind operation.
|
protected static final org.forgerock.i18n.slf4j.LocalizedLogger logger
public TextAccessLogPublisher()
public static TextAccessLogPublisher getStartupTextAccessPublisher(TextWriter writer, boolean suppressInternal)
writer
- The text writer where the message will be written to.suppressInternal
- Indicates whether to suppress internal operations.public ConfigChangeResult applyConfigurationChange(FileBasedAccessLogPublisherCfg config)
applyConfigurationChange
in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
config
- The new configuration containing the changes.public void initializeLogPublisher(FileBasedAccessLogPublisherCfg cfg, ServerContext serverContext) throws ConfigException, InitializationException
initializeLogPublisher
in interface LogPublisher<FileBasedAccessLogPublisherCfg>
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(FileBasedAccessLogPublisherCfg configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationAcceptable
in interface LogPublisher<FileBasedAccessLogPublisherCfg>
isConfigurationAcceptable
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
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(FileBasedAccessLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
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 logAbandonRequest(AbandonOperation abandonOperation)
logAbandonRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
abandonOperation
- The abandon operation containing the information to use to log the
abandon request.public void logAbandonResult(AbandonOperation abandonOperation)
logAbandonResult
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
abandonOperation
- The abandon operation containing the information to use to log the
abandon request.public void logAddRequest(AddOperation addOperation)
logAddRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
addOperation
- The add operation containing the information to use to log the add
request.public void logAddResponse(AddOperation addOperation)
logAddResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
addOperation
- The add operation containing the information to use to log the add
response.public void logBindRequest(BindOperation bindOperation)
logBindRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
bindOperation
- The bind operation with the information to use to log the bind
request.public void logBindResponse(BindOperation bindOperation)
logBindResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
bindOperation
- The bind operation containing the information to use to log the
bind response.public void logCompareRequest(CompareOperation compareOperation)
logCompareRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
compareOperation
- The compare operation containing the information to use to log the
compare request.public void logCompareResponse(CompareOperation compareOperation)
logCompareResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
compareOperation
- The compare operation containing the information to use to log the
compare response.public void logConnect(ClientConnection clientConnection)
logConnect
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
clientConnection
- The client connection that has been established.public void logDeleteRequest(DeleteOperation deleteOperation)
logDeleteRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
deleteOperation
- The delete operation with the information to use to log the delete
request.public void logDeleteResponse(DeleteOperation deleteOperation)
logDeleteResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
deleteOperation
- The delete operation containing the information to use to log the
delete response.public void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, LocalizableMessage message)
logDisconnect
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
clientConnection
- The client connection that has been terminated.disconnectReason
- A generic disconnect reason for the connection termination.message
- A human-readable message that can provide additional information
about the disconnect.public void logExtendedRequest(ExtendedOperation extendedOperation)
logExtendedRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
extendedOperation
- The extended operation containing the information to use to log
the extended request.public void logExtendedResponse(ExtendedOperation extendedOperation)
logExtendedResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
extendedOperation
- The extended operation containing the info to use to log the
extended response.public void logModifyDNRequest(ModifyDNOperation modifyDNOperation)
logModifyDNRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyDNOperation
- The modify DN operation containing the info to use to log the
modify DN request.public void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
logModifyDNResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyDNOperation
- The modify DN operation containing the information to use to log
the modify DN response.public void logModifyRequest(ModifyOperation modifyOperation)
logModifyRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyOperation
- The modify operation containing the information to use to log the
modify request.public void logModifyResponse(ModifyOperation modifyOperation)
logModifyResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyOperation
- The modify operation containing the information to use to log the
modify response.public void logSearchRequest(SearchOperation searchOperation)
logSearchRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation containing the info to use to log the search
request.public void logSearchResultDone(SearchOperation searchOperation)
logSearchResultDone
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation containing the information to use to log the
search result done message.public void logUnbind(UnbindOperation unbindOperation)
logUnbind
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
unbindOperation
- The unbind operation containing the info to use to log the unbind
request.protected void close0()
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.