Package org.opends.server.loggers

Class AccessLogger

java.lang.Object

org.opends.server.loggers.AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

org.opends.server.loggers.AccessLogger

All Implemented Interfaces:

ConfigurationAddListener<AccessLogPublisherCfg>, ConfigurationChangeListener<AccessLogPublisherCfg>, ConfigurationDeleteListener<AccessLogPublisherCfg>

public final class AccessLogger
extends AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

This class defines the wrapper that will invoke all registered access loggers for each type of request received or response sent.

Method Summary

Modifier and Type	Method	Description
void	addLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)	Add a log publisher to the logger.
static AccessLogger	getInstance()	Retrieve the singleton instance of this class.
protected ClassPropertyDefinition	getJavaClassPropertyDefinition()	Returns the java ClassPropertyDefinition for the current logger.
protected Collection<AccessLogPublisher<AccessLogPublisherCfg>>	getLogPublishers()	Returns the log publishers.
static void	logConnect(ClientConnection connection)	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.
static void	logDisconnect(ClientConnection connection, DisconnectReason disconnectReason, LocalizableMessage message)	Writes a message to the access logger with information about the termination of an existing client connection.
static void	logRequest(RequestContext context, Request request)	Writes a message to the access logger with information about the provided request.
static void	logResult(RequestContext context, Request request, Result result)	Writes a message to the access logger with information about the provided request and result.
void	removeAllLogPublishers()	Removes all existing log publishers from the logger.
void	removeLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)	Remove a log publisher from the logger.

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

applyConfigurationAdd, applyConfigurationChange, applyConfigurationDelete, initializeLogger, isConfigurationAddAcceptable, isConfigurationChangeAcceptable, isConfigurationDeleteAcceptable, modifyLogPublisher

Methods inherited from class java.lang.Object

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

Method Details

getJavaClassPropertyDefinition

protected ClassPropertyDefinition getJavaClassPropertyDefinition()

Description copied from class: AbstractLogger

Returns the java ClassPropertyDefinition for the current logger.

Specified by:

getJavaClassPropertyDefinition in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

Returns:

the java ClassPropertyDefinition for the current logger.

getLogPublishers

protected Collection<AccessLogPublisher<AccessLogPublisherCfg>> getLogPublishers()

Description copied from class: AbstractLogger

Returns the log publishers.

Specified by:

getLogPublishers in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

Returns:

the collection of LogPublishers

getInstance

public static AccessLogger getInstance()

Retrieve the singleton instance of this class.

Returns:

The singleton instance of this logger.

logConnect

public static void logConnect(ClientConnection connection)

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.

Parameters:

connection - The client connection that has been established.

logDisconnect

public static void logDisconnect(ClientConnection connection,
 DisconnectReason disconnectReason,
 LocalizableMessage message)

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

Parameters:

connection - 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.

addLogPublisher

public void addLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)

Description copied from class: AbstractLogger

Add a log publisher to the logger.

Specified by:

addLogPublisher in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

Parameters:

publisher - The log publisher to add.

removeLogPublisher

public void removeLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)

Description copied from class: AbstractLogger

Remove a log publisher from the logger.

Specified by:

removeLogPublisher in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

Parameters:

publisher - The log publisher to remove.

removeAllLogPublishers

public void removeAllLogPublishers()

Description copied from class: AbstractLogger

Removes all existing log publishers from the logger.

Specified by:

removeAllLogPublishers in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

logRequest

public static void logRequest(RequestContext context,
 Request request)

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

Parameters:

context - the request context

request - the request to log

logResult

public static void logResult(RequestContext context,
 Request request,
 Result result)

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

Parameters:

context - the request context

request - the request to log

result - the result to log