Package com.unboundid.directory.sdk.http.api

Class HTTPOperationLogger

java.lang.Object

com.unboundid.directory.sdk.http.api.HTTPOperationLogger

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<HTTPOperationLoggerConfig>, UnboundIDExtension

@Extensible
@DirectoryServerExtension
@DirectoryProxyServerExtension(appliesToLocalContent=true,
                               appliesToRemoteContent=true)
@MetricsEngineExtension
@BrokerExtension
@ThreadSafety(level=INTERFACE_THREADSAFE)
public abstract class HTTPOperationLogger
extends java.lang.Object
implements UnboundIDExtension, Reconfigurable<HTTPOperationLoggerConfig>, ExampleUsageProvider

This class defines an API that must be implemented by extensions which record information about interaction with HTTP clients. HTTP operation loggers may write information to files, but they may also write to other locations, including databases, message, queues, e-mail messages, or other targets.

Configuring HTTP Operation Loggers

In order to configure an HTTP operation logger created using this API, use a command like:

      dsconfig create-log-publisher \
           --publisher-name "{logger-name}" \
           --type third-party-http-operation \
           --set enabled:true \
           --set "extension-class:{class-name}" \
           --set "extension-argument:{name=value}"
 

where "{logger-name}" is the name to use for the HTTP operation logger instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.ds.HTTPOperationLogger, and "{name=value}" represents name-value pairs for any arguments to provide to the logger. If multiple arguments should be provided to the logger, then the "--set extension-argument:{name=value}" option should be provided multiple times.

See Also:

ScriptedHTTPOperationLogger

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	STATE_KEY_CORRELATION_ID	The key that will be used to hold the correlation ID for the associated HTTP request.
static java.lang.String	STATE_KEY_PROCESSING_TIME_MILLIS	The key that will be used to hold the operation processing time in milliseconds.
static java.lang.String	STATE_KEY_PROCESSING_TIME_NANOS	The key that will be used to hold the operation processing time in nanoseconds.
static java.lang.String	STATE_KEY_REQUEST_ID	The key that will be used to hold the request ID for the associated HTTP request.
static java.lang.String	STATE_KEY_REQUEST_TIME_MILLIS	The key that will be used to hold the time the request was received, in milliseconds since January 1, 1960, UTC, as reported by System.currentTimeMillis().
static java.lang.String	STATE_KEY_REQUEST_TIME_NANOS	The key that will be used to hold the time the request was received, in nanoseconds, as reported by System.nanoTime().
static java.lang.String	STATE_KEY_RESPONSE_CONTENT_LENGTH	The key that will be used to hold the response content length in the state map.
static java.lang.String	STATE_KEY_RESPONSE_COOKIES	The key that will be used to hold the set of cookies included in the response to the client.

Constructor Summary

Constructors

Constructor	Description
HTTPOperationLogger()	Creates a new instance of this HTTP operation logger.

Method Summary

Modifier and Type	Method	Description
ResultCode	applyConfiguration(HTTPOperationLoggerConfig config, ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)	Attempts to apply the configuration from the provided argument parser to this extension.
void	defineConfigArguments(ArgumentParser parser)	Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeHTTPOperationLogger()	Performs any cleanup which may be necessary when this HTTP operation logger is to be taken out of service.
java.util.Map<java.util.List<java.lang.String>,java.lang.String>	getExamplesArgumentSets()	Retrieves a map containing examples of configurations that may be used for this extension.
abstract java.lang.String[]	getExtensionDescription()	Retrieves a human-readable description for this extension.
abstract java.lang.String	getExtensionName()	Retrieves a human-readable name for this extension.
void	initializeHTTPOperationLogger(HTTPServerContext serverContext, HTTPOperationLoggerConfig config, ArgumentParser parser)	Initializes this HTTP operation logger.
boolean	isConfigurationAcceptable(HTTPOperationLoggerConfig config, ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)	Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension.
void	logRequest(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> stateMap)	Logs information about a servlet request that has been received from the client.
void	logResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,java.lang.Object> stateMap)	Logs information about a servlet response to be returned to the client.

Methods inherited from class java.lang.Object

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

Field Detail

STATE_KEY_REQUEST_ID

public static final java.lang.String STATE_KEY_REQUEST_ID

The key that will be used to hold the request ID for the associated HTTP request. It will always be present in the state map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map<java.lang.String, java.lang.Object>) and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) methods are invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_CORRELATION_ID

public static final java.lang.String STATE_KEY_CORRELATION_ID

The key that will be used to hold the correlation ID for the associated HTTP request. It will be present in the state map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map<java.lang.String, java.lang.Object>) and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) methods are invoked, but only if the HTTP Connection Handler is configured to use correlation IDs. The value associated with this key will be a java.lang.String object.

See Also:

Constant Field Values

STATE_KEY_REQUEST_TIME_MILLIS

public static final java.lang.String STATE_KEY_REQUEST_TIME_MILLIS

The key that will be used to hold the time the request was received, in milliseconds since January 1, 1960, UTC, as reported by System.currentTimeMillis(). It will always be present in the state map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map<java.lang.String, java.lang.Object>) and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) methods are invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_REQUEST_TIME_NANOS

public static final java.lang.String STATE_KEY_REQUEST_TIME_NANOS

The key that will be used to hold the time the request was received, in nanoseconds, as reported by System.nanoTime(). It will always be present in the state map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map<java.lang.String, java.lang.Object>) and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) methods are invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_RESPONSE_CONTENT_LENGTH

public static final java.lang.String STATE_KEY_RESPONSE_CONTENT_LENGTH

The key that will be used to hold the response content length in the state map. It will always be present in the state map when the logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) method is invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_PROCESSING_TIME_MILLIS

public static final java.lang.String STATE_KEY_PROCESSING_TIME_MILLIS

The key that will be used to hold the operation processing time in milliseconds. It will always be present in the state map when the logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) method is invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_PROCESSING_TIME_NANOS

public static final java.lang.String STATE_KEY_PROCESSING_TIME_NANOS

The key that will be used to hold the operation processing time in nanoseconds. It will always be present in the state map when the logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) method is invoked. The value associated with this key will be a java.lang.Long object.

See Also:

Constant Field Values

STATE_KEY_RESPONSE_COOKIES

public static final java.lang.String STATE_KEY_RESPONSE_COOKIES

The key that will be used to hold the set of cookies included in the response to the client. It will always be present in the state map when the logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) method is invoked. The value associated with this key will be a java.util.List<javax.servlet.http.Cookie> object.

See Also:

Constant Field Values

Constructor Detail

HTTPOperationLogger

public HTTPOperationLogger()

Creates a new instance of this HTTP operation logger. All HTTP operation logger implementations must include a default constructor, but any initialization should generally be done in the initializeHTTPOperationLogger method.

Method Detail

getExtensionName

public abstract java.lang.String getExtensionName()

Retrieves a human-readable name for this extension.

Specified by:

getExtensionName in interface UnboundIDExtension

Returns:

A human-readable name for this extension.

getExtensionDescription

public abstract java.lang.String[] getExtensionDescription()

Retrieves a human-readable description for this extension. Each element of the array that is returned will be considered a separate paragraph in generated documentation.

Specified by:

getExtensionDescription in interface UnboundIDExtension

Returns:

A human-readable description for this extension, or null or an empty array if no description should be available.

defineConfigArguments

public void defineConfigArguments(ArgumentParser parser)
                           throws ArgumentException

Updates the provided argument parser to define any configuration arguments which may be used by this extension. The argument parser may also be updated to define relationships between arguments (e.g., to specify required, exclusive, or dependent argument sets).

Specified by:

defineConfigArguments in interface Configurable

Parameters:

parser - The argument parser to be updated with the configuration arguments which may be used by this extension.

Throws:

ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeHTTPOperationLogger

public void initializeHTTPOperationLogger(HTTPServerContext serverContext,
                                          HTTPOperationLoggerConfig config,
                                          ArgumentParser parser)
                                   throws LDAPException

Initializes this HTTP operation logger.

Parameters:

serverContext - A handle to the server context for the server in which this extension is running.

config - The general configuration for this HTTP operation logger.

parser - The argument parser which has been initialized from the configuration for this HTTP operation logger.

Throws:

LDAPException - If a problem occurs while initializing this HTTP operation logger.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(HTTPOperationLoggerConfig config,
                                         ArgumentParser parser,
                                         java.util.List<java.lang.String> unacceptableReasons)

Indicates whether the configuration represented by the provided argument parser is acceptable for use by this extension. The parser will have been used to parse any configuration available for this extension, and any automatic validation will have been performed. This method may be used to perform any more complex validation which cannot be performed automatically by the argument parser.

Specified by:

isConfigurationAcceptable in interface Reconfigurable<HTTPOperationLoggerConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the proposed configuration for this extension.

unacceptableReasons - A list to which messages may be added to provide additional information about why the provided configuration is not acceptable.

Returns:

true if the configuration in the provided argument parser appears to be acceptable, or false if not.

applyConfiguration

public ResultCode applyConfiguration(HTTPOperationLoggerConfig config,
                                     ArgumentParser parser,
                                     java.util.List<java.lang.String> adminActionsRequired,
                                     java.util.List<java.lang.String> messages)

Attempts to apply the configuration from the provided argument parser to this extension.

Specified by:

applyConfiguration in interface Reconfigurable<HTTPOperationLoggerConfig>

Parameters:

config - The general configuration for this extension.

parser - The argument parser that has been used to parse the new configuration for this extension.

adminActionsRequired - A list to which messages may be added to provide additional information about any additional administrative actions that may be required to apply some of the configuration changes.

messages - A list to which messages may be added to provide additional information about the processing performed by this method.

Returns:

A result code providing information about the result of applying the configuration change. A result of SUCCESS should be used to indicate that all processing completed successfully. Any other result will indicate that a problem occurred during processing.

finalizeHTTPOperationLogger

public void finalizeHTTPOperationLogger()

Performs any cleanup which may be necessary when this HTTP operation logger is to be taken out of service.

logRequest

public void logRequest(javax.servlet.http.HttpServletRequest request,
                       java.util.Map<java.lang.String,java.lang.Object> stateMap)

Logs information about a servlet request that has been received from the client.

Parameters:

request - An object with information about the request received from the client.

stateMap - An empty map which may be updated to hold state information that can be used to correlate information between the request and response. The same map instance will be passed to the logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map<java.lang.String, java.lang.Object>) method.

logResponse

public void logResponse(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        java.util.Map<java.lang.String,java.lang.Object> stateMap)

Logs information about a servlet response to be returned to the client.

Parameters:

request - An object with information about the request received from the client.

response - An object with information about the response to be returned to the client.

stateMap - A map containing state any information added while processing the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map<java.lang.String, java.lang.Object>) method.

getExamplesArgumentSets

public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()

Retrieves a map containing examples of configurations that may be used for this extension. The map key should be a list of sample arguments, and the corresponding value should be a description of the behavior that will be exhibited by the extension when used with that configuration.

Specified by:

getExamplesArgumentSets in interface ExampleUsageProvider

Returns:

A map containing examples of configurations that may be used for this extension. It may be null or empty if there should not be any example argument sets.