|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.http.api.HTTPOperationLogger
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=true) @MetricsEngineExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class HTTPOperationLogger
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.
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.
ScriptedHTTPOperationLogger
Field Summary | |
---|---|
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 | |
---|---|
HTTPOperationLogger()
Creates a new instance of this HTTP operation logger. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(HTTPOperationLoggerConfig 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 |
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,
com.unboundid.util.args.ArgumentParser parser)
Initializes this HTTP operation logger. |
boolean |
isConfigurationAcceptable(HTTPOperationLoggerConfig 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. |
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 |
---|
public static final java.lang.String STATE_KEY_REQUEST_ID
logRequest(javax.servlet.http.HttpServletRequest, java.util.Map)
and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
methods are invoked. The
value associated with this key will be a java.lang.Long
object.
public static final java.lang.String STATE_KEY_REQUEST_TIME_MILLIS
System.currentTimeMillis()
. It will always be present in the state
map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map)
and logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
methods are
invoked. The value associated with this key will be a
java.lang.Long
object.
public static final java.lang.String STATE_KEY_REQUEST_TIME_NANOS
System.nanoTime()
. It will always be
present in the state map when the logRequest(javax.servlet.http.HttpServletRequest, java.util.Map)
and
logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
methods are invoked. The value associated with this
key will be a java.lang.Long
object.
public static final java.lang.String STATE_KEY_RESPONSE_CONTENT_LENGTH
logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
method is invoked. The value associated with this key
will be a java.lang.Long
object.
public static final java.lang.String STATE_KEY_PROCESSING_TIME_MILLIS
logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
method is invoked. The value associated with this key
will be a java.lang.Long
object.
public static final java.lang.String STATE_KEY_PROCESSING_TIME_NANOS
logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
method is invoked. The value associated with this key
will be a java.lang.Long
object.
public static final java.lang.String STATE_KEY_RESPONSE_COOKIES
logResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.util.Map)
method is invoked. The value associated with this
key will be a java.util.List<javax.servlet.http.Cookie>
object.
Constructor Detail |
---|
public HTTPOperationLogger()
initializeHTTPOperationLogger
method.
Method Detail |
---|
public abstract java.lang.String getExtensionName()
getExtensionName
in interface UnboundIDExtension
public abstract java.lang.String[] getExtensionDescription()
getExtensionDescription
in interface UnboundIDExtension
null
or an empty array if no description should be available.public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface Configurable
parser
- The argument parser to be updated with the configuration
arguments which may be used by this extension.
com.unboundid.util.args.ArgumentException
- If a problem is encountered while updating the
provided argument parser.public void initializeHTTPOperationLogger(HTTPServerContext serverContext, HTTPOperationLoggerConfig config, com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.ldap.sdk.LDAPException
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.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this HTTP
operation logger.public boolean isConfigurationAcceptable(HTTPOperationLoggerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<HTTPOperationLoggerConfig>
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.
true
if the configuration in the provided argument parser
appears to be acceptable, or false
if not.public com.unboundid.ldap.sdk.ResultCode applyConfiguration(HTTPOperationLoggerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> adminActionsRequired, java.util.List<java.lang.String> messages)
applyConfiguration
in interface Reconfigurable<HTTPOperationLoggerConfig>
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.
SUCCESS
should be
used to indicate that all processing completed successfully. Any
other result will indicate that a problem occurred during
processing.public void finalizeHTTPOperationLogger()
public void logRequest(javax.servlet.http.HttpServletRequest request, java.util.Map<java.lang.String,java.lang.Object> stateMap)
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)
method.public void logResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.util.Map<java.lang.String,java.lang.Object> stateMap)
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)
method.public java.util.Map<java.util.List<java.lang.String>,java.lang.String> getExamplesArgumentSets()
getExamplesArgumentSets
in interface ExampleUsageProvider
null
or empty if there should
not be any example argument sets.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |