com.unboundid.directory.sdk.common.api

Class HTTPTraceLogger

java.lang.Object

com.unboundid.directory.sdk.common.api.HTTPTraceLogger

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<HTTPTraceLoggerConfig>, UnboundIDExtension

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

This class defines an API that must be implemented by extensions which record information about HTTP operations in the server.

Each trace logger may be configured to indicate whether to include or exclude log messages based on a set of target message types. Nothing is logged by a trace logger unless it is configured with one or more message types to log. Filtering by message type is handled automatically by the server, so individual trace logger implementations do not need to attempt to perform that filtering on their own. However, they may perform additional processing if desired to further narrow the set of messages that should be logged.

Configuring Trace Loggers

In order to configure a trace logger created using this API, use a command like:

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

where "{logger-name}" is the name to use for the trace logger instance, "{class-name}" is the fully-qualified name of the Java class that extends com.unboundid.directory.sdk.common.api.TraceLogger, 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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTRIBUTE_KEY_CREATE_REQUEST_RESOURCE The servlet request key that will be used to hold the request resource for SCIM create requests (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "CREATE").
static java.lang.String	ATTRIBUTE_KEY_CREATE_RESULT_RESOURCE The servlet request key that will be used to hold the request resource for SCIM create requests (messageCategory = "SCIM", messageType = "RESULT", keyValues["op"] = "CREATE").
static java.lang.String	ATTRIBUTE_KEY_MODIFY_RESULT_RESOURCE The servlet request key that will be used to hold the result resource for SCIM modify requests (messageCategory = "SCIM", messageType = "RESULT", keyValues["op"] = "MODIFY").
static java.lang.String	ATTRIBUTE_KEY_PATCH_REQUEST_RESOURCE The servlet request key that will be used to hold the request resource for SCIM modify requests using PATCH (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "MODIFY").
static java.lang.String	ATTRIBUTE_KEY_REPLACE_REQUEST_RESOURCE The servlet request key that will be used to hold the request resource for SCIM modify requests using PUT (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "MODIFY").

Constructor Summary

Constructors

Constructor and Description
HTTPTraceLogger() Creates a new instance of this trace logger.

Method Summary

Modifier and Type	Method and Description
com.unboundid.ldap.sdk.ResultCode	applyConfiguration(HTTPTraceLoggerConfig config, com.unboundid.util.args.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(com.unboundid.util.args.ArgumentParser parser) Updates the provided argument parser to define any configuration arguments which may be used by this extension.
void	finalizeTraceLogger() Performs any cleanup which may be necessary when this trace 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	initializeTraceLogger(ServerContext serverContext, HTTPTraceLoggerConfig config, com.unboundid.util.args.ArgumentParser parser) Initializes this trace logger.
boolean	isConfigurationAcceptable(HTTPTraceLoggerConfig config, com.unboundid.util.args.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.
abstract void	log(javax.servlet.http.HttpServletRequest request, java.lang.String messageCategory, java.lang.String messageType, java.lang.String message, java.util.Map<java.lang.String,java.lang.String> keyValues) Writes a message to the trace log using the provided information.

Methods inherited from class java.lang.Object

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

Field Detail

ATTRIBUTE_KEY_CREATE_REQUEST_RESOURCE

public static final java.lang.String ATTRIBUTE_KEY_CREATE_REQUEST_RESOURCE

The servlet request key that will be used to hold the request resource for SCIM create requests (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "CREATE"). This will be an instance of com.unboundid.scim2.common.GenericScimResource or null if this is not a SCIM create request.

See Also:

Constant Field Values

ATTRIBUTE_KEY_CREATE_RESULT_RESOURCE

public static final java.lang.String ATTRIBUTE_KEY_CREATE_RESULT_RESOURCE

The servlet request key that will be used to hold the request resource for SCIM create requests (messageCategory = "SCIM", messageType = "RESULT", keyValues["op"] = "CREATE"). This will be an instance of com.unboundid.scim2.common.GenericScimResource or null if this is not a SCIM create result.

See Also:

Constant Field Values

ATTRIBUTE_KEY_REPLACE_REQUEST_RESOURCE

public static final java.lang.String ATTRIBUTE_KEY_REPLACE_REQUEST_RESOURCE

The servlet request key that will be used to hold the request resource for SCIM modify requests using PUT (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "MODIFY"). This will be an instance of com.unboundid.scim2.common.GenericScimResource or null if this is not a SCIM modify request using PUT.

See Also:

Constant Field Values

ATTRIBUTE_KEY_PATCH_REQUEST_RESOURCE

public static final java.lang.String ATTRIBUTE_KEY_PATCH_REQUEST_RESOURCE

The servlet request key that will be used to hold the request resource for SCIM modify requests using PATCH (messageCategory = "SCIM", messageType = "REQUEST", keyValues["op"] = "MODIFY"). This will be an instance of com.unboundid.scim2.common.messages.PatchRequest or null if this is not a SCIM modify request using PATCH.

See Also:

Constant Field Values

ATTRIBUTE_KEY_MODIFY_RESULT_RESOURCE

public static final java.lang.String ATTRIBUTE_KEY_MODIFY_RESULT_RESOURCE

The servlet request key that will be used to hold the result resource for SCIM modify requests (messageCategory = "SCIM", messageType = "RESULT", keyValues["op"] = "MODIFY"). This will be an instance of com.unboundid.scim2.common.GenericScimResource or null if this is not a SCIM modify result.

See Also:

Constant Field Values

Constructor Detail

HTTPTraceLogger

public HTTPTraceLogger()

Creates a new instance of this trace logger. All trace logger implementations must include a default constructor, but any initialization should generally be done in the initializeTraceLogger 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(com.unboundid.util.args.ArgumentParser parser)
                           throws com.unboundid.util.args.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:

com.unboundid.util.args.ArgumentException - If a problem is encountered while updating the provided argument parser.

initializeTraceLogger

public void initializeTraceLogger(ServerContext serverContext,
                                  HTTPTraceLoggerConfig config,
                                  com.unboundid.util.args.ArgumentParser parser)
                           throws com.unboundid.ldap.sdk.LDAPException

Initializes this trace logger.

Parameters:

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

config - The general configuration for this trace logger.

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

Throws:

com.unboundid.ldap.sdk.LDAPException - If a problem occurs while initializing this trace logger.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(HTTPTraceLoggerConfig config,
                                         com.unboundid.util.args.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<HTTPTraceLoggerConfig>

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 com.unboundid.ldap.sdk.ResultCode applyConfiguration(HTTPTraceLoggerConfig config,
                                                            com.unboundid.util.args.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<HTTPTraceLoggerConfig>

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.

finalizeTraceLogger

public void finalizeTraceLogger()

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

log

public abstract void log(javax.servlet.http.HttpServletRequest request,
                         java.lang.String messageCategory,
                         java.lang.String messageType,
                         java.lang.String message,
                         java.util.Map<java.lang.String,java.lang.String> keyValues)

Writes a message to the trace log using the provided information. The provided message type will be used to determine whether to actually log this message.

Parameters:

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

messageCategory - The category of the logged message; never null. The set of categories corresponds with the Trace Log Publisher configuration object properties ending in -message-type, without the suffix in all upper case with no dashes, for example 'XACMLPOLICY'. See dsconfig or the Console for the set of defined properties.

messageType - The type of message; never null. The set of type values corresponds with the Trace Log Publisher -message-type property values, for example 'REQUEST' for category 'HTTP'.

message - The message to be logged; never null.

keyValues - Keys and values that are to be logged with key=value. May be empty, but never null.

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.