public final class TextAccessLogPublisher extends AccessLogPublisher<T> implements org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.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 |
---|---|
org.forgerock.opendj.config.server.ConfigChangeResult |
applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg 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.
|
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 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.FileBasedAccessLogPublisherCfg 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.FileBasedAccessLogPublisherCfg configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this log
publisher.
|
boolean |
isConfigurationChangeAcceptable(org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg 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 |
logAbandonRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AbandonRequest request)
Writes a message to the access logger with information about the provided abandon request.
|
void |
logAbandonResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AbandonRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the provided result.
|
void |
logAddRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AddRequest request)
Writes a message to the access logger with information about the add request.
|
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 |
logBindRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.BindRequest request)
Writes a message to the access logger with information about the bind request.
|
void |
logBindResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.BindRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the bind result.
|
void |
logCompareRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.CompareRequest request)
Writes a message to the access logger with information about the compare request.
|
void |
logCompareResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.CompareRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the compare result.
|
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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.DeleteRequest request)
Writes a message to the access logger with information about the delete request.
|
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 |
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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
Writes a message to the access logger with information about the extended request.
|
void |
logExtendedResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the extended result.
|
void |
logInvalidRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.InvalidRequest request)
Writes a message to the access logger with information about an invalid request.
|
void |
logInvalidResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.InvalidRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the result.
|
void |
logModifyDnRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
Writes a message to the access logger with information about the modifyDN request.
|
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 |
logModifyRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyRequest request)
Writes a message to the access logger with information about the modify request.
|
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.
|
void |
logSearchRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.SearchRequest request)
Writes a message to the access logger with information about the search request.
|
void |
logSearchResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.SearchRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the search result.
|
void |
logUnbind(RequestDJContext context,
org.forgerock.opendj.ldap.messages.UnbindRequest request)
Writes a message to the access logger with information about the provided unbind request.
|
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 org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg config)
applyConfigurationChange
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
public void initializeLogPublisher(org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg cfg, ServerContext serverContext) throws org.forgerock.opendj.config.server.ConfigException, InitializationException
LogPublisher
initializeLogPublisher
in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
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.FileBasedAccessLogPublisherCfg configuration, List<LocalizableMessage> unacceptableReasons)
LogPublisher
isConfigurationAcceptable
in interface LogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
isConfigurationAcceptable
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.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(org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons)
isConfigurationChangeAcceptable
in interface org.forgerock.opendj.config.server.ConfigurationChangeListener<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
public void logAbandonRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.AbandonRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logAbandonRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the abandon request to logpublic void logAbandonResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.AbandonRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
logAbandonResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the context for the requestrequest
- the original abandon requestresult
- the Result
to the abandon requestpublic void logAddRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logAddRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the add request to logpublic 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.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original add requestresult
- the result to logpublic void logBindRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logBindRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the bind request to logpublic void logBindResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logBindResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original bind requestresult
- the result to logpublic void logCompareRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logCompareRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the compare request to logpublic void logCompareResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logCompareResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original compare requestresult
- the result to logpublic void logConnect(ClientConnection clientConnection)
AccessLogPublisher
The default implementation is to not log anything.
logConnect
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
clientConnection
- The client connection that has been established.public void logDeleteRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logDeleteRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original delete requestpublic 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.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original delete requestresult
- the result to logpublic void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, LocalizableMessage message)
AccessLogPublisher
The default implementation is to not log anything.
logDisconnect
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.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(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
AccessLogPublisher
The default implementation is to not log anything.
logExtendedRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original extended requestpublic void logExtendedResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logExtendedResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original extended requestresult
- the result to logpublic void logInvalidRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.InvalidRequest request)
AccessLogPublisher
logInvalidRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the context for this requestrequest
- the description of the invalid request to logpublic void logInvalidResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.InvalidRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logInvalidResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original description of the invalid requestresult
- the result to logpublic void logModifyDnRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logModifyDnRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modifyDN requestpublic 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.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modifyDN requestresult
- the result to logpublic void logModifyRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logModifyRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modify requestpublic 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.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original modify requestresult
- the result to logpublic void logSearchRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logSearchRequest
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original search requestpublic void logSearchResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request, org.forgerock.opendj.ldap.messages.Result result)
AccessLogPublisher
The default implementation is to not log anything.
logSearchResult
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the original search requestresult
- the result to logpublic void logUnbind(RequestDJContext context, org.forgerock.opendj.ldap.messages.UnbindRequest request)
AccessLogPublisher
The default implementation is to not log anything.
logUnbind
in class AccessLogPublisher<org.forgerock.opendj.server.config.server.FileBasedAccessLogPublisherCfg>
context
- the logging context for the requestrequest
- the unbind request to logprotected void close0()
protected 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.