Package org.opends.server.loggers

Class HTTPAccessLogger

java.lang.Object

org.opends.server.loggers.AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

org.opends.server.loggers.HTTPAccessLogger

All Implemented Interfaces:

ConfigurationAddListener<HttpAccessLogPublisherCfg>, ConfigurationChangeListener<HttpAccessLogPublisherCfg>, ConfigurationDeleteListener<HttpAccessLogPublisherCfg>

public final class HTTPAccessLogger
extends AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

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

Method Summary

Modifier and Type	Method	Description
void	addLogPublisher(HTTPAccessLogPublisher<HttpAccessLogPublisherCfg> publisher)	Add a log publisher to the logger.
static Collection<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>>	getHTTPAccessLogPublishers()	Returns all the registered HTTP access log publishers.
static HTTPAccessLogger	getInstance()	Retrieve the singleton instance of this class.
protected ClassPropertyDefinition	getJavaClassPropertyDefinition()	Returns the java ClassPropertyDefinition for the current logger.
protected Collection<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>>	getLogPublishers()	Returns the log publishers.
static void	logRequestInfo(HTTPRequestInfo requestInfo)	Logs the given HTTPRequestInfo.
void	removeAllLogPublishers()	Removes all existing log publishers from the logger.
void	removeLogPublisher(HTTPAccessLogPublisher<HttpAccessLogPublisherCfg> 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 Detail

getJavaClassPropertyDefinition

protected ClassPropertyDefinition getJavaClassPropertyDefinition()

Description copied from class: AbstractLogger

Returns the java ClassPropertyDefinition for the current logger.

Specified by:

getJavaClassPropertyDefinition in class AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

Returns:

the java ClassPropertyDefinition for the current logger.

getLogPublishers

protected Collection<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>> getLogPublishers()

Description copied from class: AbstractLogger

Returns the log publishers.

Specified by:

getLogPublishers in class AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

Returns:

the collection of LogPublishers

getInstance

public static HTTPAccessLogger getInstance()

Retrieve the singleton instance of this class.

Returns:

The singleton instance of this logger.

getHTTPAccessLogPublishers

public static Collection<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>> getHTTPAccessLogPublishers()

Returns all the registered HTTP access log publishers.

Returns:

a Collection of HTTPAccessLogPublisher objects

logRequestInfo

public static void logRequestInfo(HTTPRequestInfo requestInfo)

Logs the given HTTPRequestInfo.

Parameters:

requestInfo - the HTTP request info to log

addLogPublisher

public void addLogPublisher(HTTPAccessLogPublisher<HttpAccessLogPublisherCfg> publisher)

Description copied from class: AbstractLogger

Add a log publisher to the logger.

Specified by:

addLogPublisher in class AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

Parameters:

publisher - The log publisher to add.

removeLogPublisher

public void removeLogPublisher(HTTPAccessLogPublisher<HttpAccessLogPublisherCfg> publisher)

Description copied from class: AbstractLogger

Remove a log publisher from the logger.

Specified by:

removeLogPublisher in class AbstractLogger<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>

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<HTTPAccessLogPublisher<HttpAccessLogPublisherCfg>,HttpAccessLogPublisherCfg>