org.opends.server.loggers

Class TextHTTPAccessLogPublisher

java.lang.Object

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

org.opends.server.loggers.TextHTTPAccessLogPublisher

All Implemented Interfaces:

Closeable, AutoCloseable, ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg>, LogPublisher<FileBasedHTTPAccessLogPublisherCfg>

public final class TextHTTPAccessLogPublisher
extends HTTPAccessLogPublisher<FileBasedHTTPAccessLogPublisherCfg>
implements ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg>

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

Constructor Summary

Constructors

Constructor and Description
TextHTTPAccessLogPublisher()

Method Summary

Methods

Modifier and Type	Method and Description
org.forgerock.opendj.config.server.ConfigChangeResult	applyConfigurationChange(FileBasedHTTPAccessLogPublisherCfg config) Applies the configuration changes to this change listener.
void	close() Close this publisher.
DN	getDN() Gets the DN of the configuration entry for this log publisher.
static TextHTTPAccessLogPublisher	getStartupTextHTTPAccessPublisher(TextWriter writer) Returns an instance of the text HTTP access log publisher that will print all messages to the provided writer.
void	initializeLogPublisher(FileBasedHTTPAccessLogPublisherCfg cfg, ServerContext serverContext) Initializes this publisher provider based on the information in the provided debug publisher configuration.
boolean	isConfigurationAcceptable(FileBasedHTTPAccessLogPublisherCfg configuration, List<LocalizableMessage> unacceptableReasons) Indicates whether the provided configuration is acceptable for this log publisher.
boolean	isConfigurationChangeAcceptable(FileBasedHTTPAccessLogPublisherCfg config, List<LocalizableMessage> unacceptableReasons) Indicates whether the proposed change to the configuration is acceptable to this change listener.
void	logRequestInfo(HTTPRequestInfo ri) 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

Constructor Detail

TextHTTPAccessLogPublisher

public TextHTTPAccessLogPublisher()

Method Detail

getStartupTextHTTPAccessPublisher

public static TextHTTPAccessLogPublisher getStartupTextHTTPAccessPublisher(TextWriter writer)

Returns an instance of the text HTTP access log publisher that will print all messages to the provided writer. This is used to print the messages to the console when the server starts up.

Parameters:

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

Returns:

The instance of the text error log publisher that will print all messages to standard out.

applyConfigurationChange

public org.forgerock.opendj.config.server.ConfigChangeResult applyConfigurationChange(FileBasedHTTPAccessLogPublisherCfg config)

Description copied from interface: ConfigurationChangeListener

Applies the configuration changes to this change listener.

Specified by:

applyConfigurationChange in interface ConfigurationChangeListener<FileBasedHTTPAccessLogPublisherCfg>

Parameters:

config - The new configuration containing the changes.

Returns:

Returns information about the result of changing the configuration.

initializeLogPublisher

public void initializeLogPublisher(FileBasedHTTPAccessLogPublisherCfg cfg,
                          ServerContext serverContext)
                            throws org.forgerock.opendj.config.server.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<FileBasedHTTPAccessLogPublisherCfg>

Parameters:

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

serverContext - The server context.

Throws:

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.

isConfigurationAcceptable

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

Description copied from class: HTTPAccessLogPublisher

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<FileBasedHTTPAccessLogPublisherCfg>

Overrides:

isConfigurationAcceptable in class HTTPAccessLogPublisher<FileBasedHTTPAccessLogPublisherCfg>

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(FileBasedHTTPAccessLogPublisherCfg 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<FileBasedHTTPAccessLogPublisherCfg>

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.

close

public final void close()

Description copied from interface: LogPublisher

Close this publisher.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface LogPublisher<FileBasedHTTPAccessLogPublisherCfg>

getDN

public final DN getDN()

Description copied from interface: LogPublisher

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

Specified by:

getDN in interface LogPublisher<FileBasedHTTPAccessLogPublisherCfg>

Returns:

The configuration entry DN.

logRequestInfo

public void logRequestInfo(HTTPRequestInfo ri)

Description copied from class: HTTPAccessLogPublisher

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

Overrides:

logRequestInfo in class HTTPAccessLogPublisher<FileBasedHTTPAccessLogPublisherCfg>

Parameters:

ri - The request info to log

See Also:

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