org.opends.server.loggers

Class HTTPAccessLogPublisher<T extends org.forgerock.opendj.server.config.server.HTTPAccessLogPublisherCfg>

java.lang.Object

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

Type Parameters:

T - The type of HTTP access log publisher configuration handled by this log publisher implementation.

All Implemented Interfaces:

Closeable, AutoCloseable, LogPublisher<T>

Direct Known Subclasses:

TextHTTPAccessLogPublisher

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class HTTPAccessLogPublisher<T extends org.forgerock.opendj.server.config.server.HTTPAccessLogPublisherCfg>
extends Object
implements LogPublisher<T>

This class defines the set of methods and structures that must be implemented for a Directory Server HTTP access log publisher.

Constructor Summary

Constructors

Constructor and Description
HTTPAccessLogPublisher()

Method Summary

Modifier and Type	Method and Description
boolean	isConfigurationAcceptable(T configuration, List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this log publisher.
void	logRequestInfo(HTTPRequestInfo requestInfo) Logs the request info according to the configured extended log format.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.loggers.LogPublisher

close, getDN, initializeLogPublisher

Constructor Detail

HTTPAccessLogPublisher

public HTTPAccessLogPublisher()

Method Detail

isConfigurationAcceptable

public boolean isConfigurationAcceptable(T configuration,
                                         List<org.forgerock.i18n.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.

Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.

Specified by:

isConfigurationAcceptable in interface LogPublisher<T extends org.forgerock.opendj.server.config.server.HTTPAccessLogPublisherCfg>

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.

logRequestInfo

public void logRequestInfo(HTTPRequestInfo requestInfo)

Logs the request info according to the configured extended log format.

Parameters:

requestInfo - The request info to log

See Also:

W3C's Extended Log File Format, Microsoft's W3C Extended Log File Format (IIS 6.0)