Package org.opends.server.loggers

Class TextAccessLogPublisher

java.lang.Object

org.opends.server.loggers.AccessLogPublisher<T>

org.opends.server.loggers.TextAccessLogPublisher

All Implemented Interfaces:

Closeable, AutoCloseable, ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>, LogPublisher<FileBasedAccessLogPublisherCfg>

public final class TextAccessLogPublisher
extends AccessLogPublisher<T>
implements ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>

This class provides the implementation of the access logger used by the directory server.

Constructor Summary

Constructors

Constructor	Description
TextAccessLogPublisher()	Default constructor.
TextAccessLogPublisher(TextWriter writer, ServerContext serverContext)	Prints all messages to the provided writer.

Method Summary

Modifier and Type	Method	Description
ConfigChangeResult	applyConfigurationChange(FileBasedAccessLogPublisherCfg config)	Applies the configuration changes to this change listener.
protected void	buildFilters()	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 String	getTransactionId(RequestContext context)
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(RequestContext context, Request request)	Returns true if the provided request should be logged.
protected boolean	isResponseLoggable(RequestContext context, Request request, Response response)	Returns true if the provided response should be logged.
protected boolean	isTlsHandshakeLoggable(ConnectionContext c)	Returns true if the provided TLS handshake should be logged.
void	logAbandonRequest(RequestContext context, AbandonRequest request)	Writes a message to the access logger with information about the provided abandon request.
void	logAbandonResult(RequestContext context, AbandonRequest request, Result result)	Writes a message to the access logger with information about the provided result.
void	logAddRequest(RequestContext context, AddRequest request)	Writes a message to the access logger with information about the add request.
void	logAddResult(RequestContext context, AddRequest request, Result result)	Writes a message to the access logger with information about the add result.
void	logBindRequest(RequestContext context, BindRequest request)	Writes a message to the access logger with information about the bind request.
void	logBindResult(RequestContext context, BindRequest request, Result result)	Writes a message to the access logger with information about the bind result.
void	logCompareRequest(RequestContext context, CompareRequest request)	Writes a message to the access logger with information about the compare request.
void	logCompareResult(RequestContext context, CompareRequest request, 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(RequestContext context, DeleteRequest request)	Writes a message to the access logger with information about the delete request.
void	logDeleteResult(RequestContext context, DeleteRequest request, 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(RequestContext context, ExtendedRequest<?> request)	Writes a message to the access logger with information about the extended request.
void	logExtendedResult(RequestContext context, ExtendedRequest<?> request, Result result)	Writes a message to the access logger with information about the extended result.
void	logInvalidRequest(RequestContext context, InvalidRequest request)	Writes a message to the access logger with information about an invalid request.
void	logInvalidResult(RequestContext context, InvalidRequest request, Result result)	Writes a message to the access logger with information about the result.
void	logModifyDnRequest(RequestContext context, ModifyDnRequest request)	Writes a message to the access logger with information about the modifyDN request.
void	logModifyDnResult(RequestContext context, ModifyDnRequest request, Result result)	Writes a message to the access logger with information about the modifyDN result.
void	logModifyRequest(RequestContext context, ModifyRequest request)	Writes a message to the access logger with information about the modify request.
void	logModifyResult(RequestContext context, ModifyRequest request, Result result)	Writes a message to the access logger with information about the modify result.
void	logSearchRequest(RequestContext context, SearchRequest request)	Writes a message to the access logger with information about the search request.
void	logSearchResult(RequestContext context, SearchRequest request, Result result)	Writes a message to the access logger with information about the search result.
void	logUnbind(RequestContext context, UnbindRequest request)	Writes a message to the access logger with information about the provided unbind request.

Methods inherited from class org.opends.server.loggers.AccessLogPublisher

logTlsHandshake

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextAccessLogPublisher

public TextAccessLogPublisher()

Default constructor.

TextAccessLogPublisher

public TextAccessLogPublisher(TextWriter writer,
                              ServerContext serverContext)

Prints all messages to the provided writer.

Parameters:

writer - The text writer where the message will be written to.

serverContext - the server context

Method Detail

applyConfigurationChange

public ConfigChangeResult applyConfigurationChange(FileBasedAccessLogPublisherCfg config)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

initializeLogPublisher

public void initializeLogPublisher(FileBasedAccessLogPublisherCfg cfg,
                                   ServerContext serverContext)
                            throws ConfigException,
                                   InitializationException

Description copied from interface: LogPublisher

Initializes this publisher provider based on the information in the provided debug publisher configuration.

Specified by:

initializeLogPublisher in interface LogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

cfg - The publisher configuration that contains the information to use to initialize this publisher.

serverContext - The server context.

Throws:

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.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(FileBasedAccessLogPublisherCfg configuration,
                                         List<LocalizableMessage> unacceptableReasons)

Description copied from interface: LogPublisher

Indicates whether the provided configuration is acceptable for this log publisher. It should be possible to call this method on an uninitialized log publisher instance in order to determine whether the log publisher would be able to use the provided configuration.

Specified by:

isConfigurationAcceptable in interface LogPublisher<FileBasedAccessLogPublisherCfg>

Overrides:

isConfigurationAcceptable in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

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.

Returns:

true if the provided configuration is acceptable for this log publisher, or false if not.

isConfigurationChangeAcceptable

public boolean isConfigurationChangeAcceptable(FileBasedAccessLogPublisherCfg config,
                                               List<LocalizableMessage> unacceptableReasons)

Description copied from interface: ConfigurationChangeListener

Indicates whether the proposed change to the configuration is acceptable to this change listener.

Specified by:

isConfigurationChangeAcceptable in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>

Parameters:

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.

Returns:

Returns true if the proposed change is acceptable, or false if it is not.

logAbandonRequest

public void logAbandonRequest(RequestContext context,
                              AbandonRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the provided abandon request.

The default implementation is to not log anything.

Overrides:

logAbandonRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the abandon request to log

logAbandonResult

public void logAbandonResult(RequestContext context,
                             AbandonRequest request,
                             Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the provided result. Note there is no LDAP result sent back to client, it is for logging purposes only.

Overrides:

logAbandonResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the context for the request

request - the original abandon request

result - the Result to the abandon request

logAddRequest

public void logAddRequest(RequestContext context,
                          AddRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the add request.

The default implementation is to not log anything.

Overrides:

logAddRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the add request to log

logAddResult

public void logAddResult(RequestContext context,
                         AddRequest request,
                         Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the add result.

The default implementation is to not log anything.

Overrides:

logAddResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original add request

result - the result to log

logBindRequest

public void logBindRequest(RequestContext context,
                           BindRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the bind request.

The default implementation is to not log anything.

Overrides:

logBindRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the bind request to log

logBindResult

public void logBindResult(RequestContext context,
                          BindRequest request,
                          Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the bind result.

The default implementation is to not log anything.

Overrides:

logBindResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original bind request

result - the result to log

logCompareRequest

public void logCompareRequest(RequestContext context,
                              CompareRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the compare request.

The default implementation is to not log anything.

Overrides:

logCompareRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the compare request to log

logCompareResult

public void logCompareResult(RequestContext context,
                             CompareRequest request,
                             Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the compare result.

The default implementation is to not log anything.

Overrides:

logCompareResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original compare request

result - the result to log

logConnect

public void logConnect(ClientConnection clientConnection)

Description copied from class: AccessLogPublisher

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.

The default implementation is to not log anything.

Overrides:

logConnect in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

clientConnection - The client connection that has been established.

logDeleteRequest

public void logDeleteRequest(RequestContext context,
                             DeleteRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the delete request.

The default implementation is to not log anything.

Overrides:

logDeleteRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original delete request

logDeleteResult

public void logDeleteResult(RequestContext context,
                            DeleteRequest request,
                            Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the delete result.

The default implementation is to not log anything.

Overrides:

logDeleteResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original delete request

result - the result to log

logDisconnect

public void logDisconnect(ClientConnection clientConnection,
                          DisconnectReason disconnectReason,
                          LocalizableMessage message)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the termination of an existing client connection.

The default implementation is to not log anything.

Overrides:

logDisconnect in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

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.

logExtendedRequest

public void logExtendedRequest(RequestContext context,
                               ExtendedRequest<?> request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the extended request.

The default implementation is to not log anything.

Overrides:

logExtendedRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original extended request

logExtendedResult

public void logExtendedResult(RequestContext context,
                              ExtendedRequest<?> request,
                              Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the extended result.

The default implementation is to not log anything.

Overrides:

logExtendedResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original extended request

result - the result to log

logInvalidRequest

public void logInvalidRequest(RequestContext context,
                              InvalidRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about an invalid request.

Overrides:

logInvalidRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the context for this request

request - the description of the invalid request to log

logInvalidResult

public void logInvalidResult(RequestContext context,
                             InvalidRequest request,
                             Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the result.

The default implementation is to not log anything.

Overrides:

logInvalidResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original description of the invalid request

result - the result to log

logModifyDnRequest

public void logModifyDnRequest(RequestContext context,
                               ModifyDnRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modifyDN request.

The default implementation is to not log anything.

Overrides:

logModifyDnRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modifyDN request

logModifyDnResult

public void logModifyDnResult(RequestContext context,
                              ModifyDnRequest request,
                              Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modifyDN result.

The default implementation is to not log anything.

Overrides:

logModifyDnResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modifyDN request

result - the result to log

logModifyRequest

public void logModifyRequest(RequestContext context,
                             ModifyRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modify request.

The default implementation is to not log anything.

Overrides:

logModifyRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modify request

logModifyResult

public void logModifyResult(RequestContext context,
                            ModifyRequest request,
                            Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modify result.

The default implementation is to not log anything.

Overrides:

logModifyResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modify request

result - the result to log

logSearchRequest

public void logSearchRequest(RequestContext context,
                             SearchRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the search request.

The default implementation is to not log anything.

Overrides:

logSearchRequest in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original search request

logSearchResult

public void logSearchResult(RequestContext context,
                            SearchRequest request,
                            Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the search result.

The default implementation is to not log anything.

Overrides:

logSearchResult in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original search request

result - the result to log

logUnbind

public void logUnbind(RequestContext context,
                      UnbindRequest request)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the provided unbind request.

The default implementation is to not log anything.

Overrides:

logUnbind in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the unbind request to log

close0

protected void close0()

Release any resources owned by the sub-implementation.

getTransactionId

protected String getTransactionId(RequestContext context)

close

public final void close()

Description copied from interface: LogPublisher

Close this publisher.

getDN

public final Dn getDN()

Description copied from interface: LogPublisher

Gets the DN of the configuration entry for this log publisher.

Returns:

The configuration entry DN.

initializeFilters

protected final void initializeFilters(T config)
                                throws ConfigException

Initializes the filter configuration. This method must be called by sub-classes during initialization.

Parameters:

config - The access publisher configuration that contains the information to use to initialize this access publisher.

Throws:

ConfigException - If an unrecoverable problem arises in the process of performing the initialization as a result of the server configuration.

isConnectLoggable

protected final boolean isConnectLoggable(ClientConnection c)

Returns true if the provided client connect should be logged.

Parameters:

c - The client connection.

Returns:

true if the provided client connect should be logged.

isDisconnectLoggable

protected final boolean isDisconnectLoggable(ClientConnection c)

Returns true if the provided client disconnect should be logged.

Parameters:

c - The client connection.

Returns:

true if the provided client disconnect should be logged.

isTlsHandshakeLoggable

protected final boolean isTlsHandshakeLoggable(ConnectionContext c)

Returns true if the provided TLS handshake should be logged.

Parameters:

c - the connection context

Returns:

true if the provided TLS handshake should be logged.

isFilterConfigurationAcceptable

protected final boolean isFilterConfigurationAcceptable(T config,
                                                        List<LocalizableMessage> unacceptableReasons)

Perform any initialization required by the sub-implementation.

Parameters:

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.

Returns:

true if the provided configuration is acceptable for this access log publisher, or false if not.

isRequestLoggable

protected final boolean isRequestLoggable(RequestContext context,
                                          Request request)

Returns true if the provided request should be logged.

Parameters:

context - the log context

request - the request to log

Returns:

true if the provided request should be logged.

isResponseLoggable

protected final boolean isResponseLoggable(RequestContext context,
                                           Request request,
                                           Response response)

Returns true if the provided response should be logged.

Parameters:

context - the log context

request - the request to which the response corresponds

response - the response to log

Returns:

true if the provided response should be logged.

buildFilters

protected void buildFilters()

For startup access logger.