com.unboundid.directory.sdk.common.api

Class AccessLogger

java.lang.Object

com.unboundid.directory.sdk.common.api.AccessLogger

All Implemented Interfaces:

Configurable, ExampleUsageProvider, Reconfigurable<AccessLoggerConfig>, UnboundIDExtension

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

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

Access loggers will be invoked for the following events:

• Whenever a new connection is established.
• Whenever an existing connection is closed or terminated.
• Whenever an abandon, add, bind, compare, delete, extended, modify, modify DN, search, or unbind request is received.
• Whenever an abandon, add, bind, compare, delete, extended, modify, modify DN, or search request is forwarded to another server for processing.
• If a forwarded add, bind, compare, delete, extended, modify, modify DN, or search operation fails.
• After sending the result for an add, bind, compare, delete, extended, modify, modify DN, or search operation.
• After completing processing for an abandon operation.
• After sending a search result entry, search result reference, or intermediate response message to the client.

Each access logger may configured to indicate whether to include or exclude internal and/or replicated operations, and criteria may be used to provide filtered logging. This is handled automatically by the server, so individual access 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 Access Loggers

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

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

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

FileBasedAccessLogger, ScriptedAccessLogger, ScriptedFileBasedAccessLogger

Constructor Summary

Constructors

Constructor and Description
AccessLogger() Creates a new instance of this access logger.

Method Summary

Modifier and Type	Method and Description
ResultCode	applyConfiguration(AccessLoggerConfig 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	finalizeAccessLogger() Performs any cleanup which may be necessary when this access 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	initializeAccessLogger(ServerContext serverContext, AccessLoggerConfig config, ArgumentParser parser) Initializes this access logger.
boolean	isConfigurationAcceptable(AccessLoggerConfig 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	logAbandonForward(OperationContext opContext, AbandonRequest request, ForwardTarget target) Logs a message about an abandon request that will be forwarded to another server.
void	logAbandonRequest(OperationContext opContext, AbandonRequest request) Logs a message about an abandon request received from a client.
void	logAbandonResult(CompletedOperationContext opContext, AbandonRequest request, GenericResult result) Logs a message about the result of processing an abandon request.
void	logAddAssuranceCompleted(CompletedOperationContext opContext, AddRequest request, AddResult result, AssuredReplicationResult assuranceResult) Logs a message about the result of replication assurance processing for an add operation.
void	logAddForward(OperationContext opContext, AddRequest request, ForwardTarget target) Logs a message about an add request that will be forwarded to another server.
void	logAddForwardFailure(OperationContext opContext, AddRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward an add request to another server.
void	logAddRequest(OperationContext opContext, AddRequest request) Logs a message about an add request received from a client.
void	logAddResponse(CompletedOperationContext opContext, AddRequest request, AddResult result) Logs a message about the result of processing an add request.
void	logBindForward(OperationContext opContext, SASLBindRequest request, ForwardTarget target) Logs a message about a SASL bind request that will be forwarded to another server.
void	logBindForward(OperationContext opContext, SimpleBindRequest request, ForwardTarget target) Logs a message about a simple bind request that will be forwarded to another server.
void	logBindForwardFailure(OperationContext opContext, SASLBindRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.
void	logBindForwardFailure(OperationContext opContext, SimpleBindRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a simple bind request to another server.
void	logBindRequest(OperationContext opContext, SASLBindRequest request) Logs a message about a SASL bind request received from a client.
void	logBindRequest(OperationContext opContext, SimpleBindRequest request) Logs a message about a simple bind request received from a client.
void	logBindResponse(CompletedOperationContext opContext, SASLBindRequest request, BindResult result) Logs a message about the result of processing a SASL bind request.
void	logBindResponse(CompletedOperationContext opContext, SimpleBindRequest request, BindResult result) Logs a message about the result of processing a simple bind request.
void	logClientCertificateChain(ClientContext clientContext, java.security.cert.Certificate[] certChain, java.lang.String authDN) Logs a message about a certificate chain presented by a client.
void	logCompareForward(OperationContext opContext, CompareRequest request, ForwardTarget target) Logs a message about a compare request that will be forwarded to another server.
void	logCompareForwardFailure(OperationContext opContext, CompareRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a compare request to another server.
void	logCompareRequest(OperationContext opContext, CompareRequest request) Logs a message about a compare request received from a client.
void	logCompareResponse(CompletedOperationContext opContext, CompareRequest request, CompareResult result) Logs a message about the result of processing a compare request.
void	logConnect(ClientContext clientContext) Logs a message indicating that a new connection has been established.
void	logDeleteAssuranceCompleted(CompletedOperationContext opContext, DeleteRequest request, DeleteResult result, AssuredReplicationResult assuranceResult) Logs a message about the result of replication assurance processing for a delete operation.
void	logDeleteForward(OperationContext opContext, DeleteRequest request, ForwardTarget target) Logs a message about a delete request that will be forwarded to another server.
void	logDeleteForwardFailure(OperationContext opContext, DeleteRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a delete request to another server.
void	logDeleteRequest(OperationContext opContext, DeleteRequest request) Logs a message about a delete request received from a client.
void	logDeleteResponse(CompletedOperationContext opContext, DeleteRequest request, DeleteResult result) Logs a message about the result of processing a delete request.
void	logDisconnect(ClientContext clientContext, DisconnectReason disconnectReason, java.lang.String message) Logs a message indicating that a connection has been closed.
void	logEntryRebalancingRequest(long rebalancingOperationID, OperationContext triggerOperation, java.lang.String baseDN, int sizeLimit, java.lang.String sourceBackendSetName, java.lang.String sourceAddress, int sourcePort, java.lang.String targetBackendSetName, java.lang.String targetAddress, int targetPort) Writes a message to the access logger to indicate that the Directory Proxy Server will attempt to perform entry rebalancing by migrating a subtree from one backend set to another.
void	logEntryRebalancingResult(long rebalancingOperationID, OperationContext triggerOperation, java.lang.String baseDN, int sizeLimit, java.lang.String sourceBackendSetName, java.lang.String sourceAddress, int sourcePort, java.lang.String targetBackendSetName, java.lang.String targetAddress, int targetPort, MoveSubtreeResult moveSubtreeResult) Writes a message to the access logger to indicate that the Directory Proxy Server will attempt to perform entry rebalancing by migrating a subtree from one backend set to another.
void	logExtendedForward(OperationContext opContext, ExtendedRequest request, ForwardTarget target) Logs a message about an extended request that will be forwarded to another server.
void	logExtendedForwardFailure(OperationContext opContext, ExtendedRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward an extended request to another server.
void	logExtendedRequest(OperationContext opContext, ExtendedRequest request) Logs a message about an extended request received from a client.
void	logExtendedResponse(CompletedOperationContext opContext, ExtendedRequest request, ExtendedResult result) Logs a message about the result of processing an extended request.
void	logIntermediateResponse(OperationContext opContext, IntermediateResponse intermediateResponse) Logs a message about an intermediate response that was returned to the client.
void	logModifyAssuranceCompleted(CompletedOperationContext opContext, ModifyRequest request, ModifyResult result, AssuredReplicationResult assuranceResult) Logs a message about the result of replication assurance processing for a modify operation.
void	logModifyDNAssuranceCompleted(CompletedOperationContext opContext, ModifyDNRequest request, ModifyDNResult result, AssuredReplicationResult assuranceResult) Logs a message about the result of replication assurance processing for a modify DN operation.
void	logModifyDNForward(OperationContext opContext, ModifyDNRequest request, ForwardTarget target) Logs a message about a modify DN request that will be forwarded to another server.
void	logModifyDNForwardFailure(OperationContext opContext, ModifyDNRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a modify DN request to another server.
void	logModifyDNRequest(OperationContext opContext, ModifyDNRequest request) Logs a message about a modify DN request received from a client.
void	logModifyDNResponse(CompletedOperationContext opContext, ModifyDNRequest request, ModifyDNResult result) Logs a message about the result of processing a modify DN request.
void	logModifyForward(OperationContext opContext, ModifyRequest request, ForwardTarget target) Logs a message about a modify request that will be forwarded to another server.
void	logModifyForwardFailure(OperationContext opContext, ModifyRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a modify request to another server.
void	logModifyRequest(OperationContext opContext, ModifyRequest request) Logs a message about a modify request received from a client.
void	logModifyResponse(CompletedOperationContext opContext, ModifyRequest request, ModifyResult result) Logs a message about the result of processing a modify request.
void	logSearchForward(OperationContext opContext, SearchRequest request, ForwardTarget target) Logs a message about a search request that will be forwarded to another server.
void	logSearchForwardFailure(OperationContext opContext, SearchRequest request, ForwardTarget target, LDAPException failure) Logs a message about a failure encountered while attempting to forward a search request to another server.
void	logSearchRequest(OperationContext opContext, SearchRequest request) Logs a message about a search request received from a client.
void	logSearchResultDone(CompletedSearchOperationContext opContext, SearchRequest request, SearchResult result) Logs a message about the result of processing a search request.
void	logSearchResultEntry(OperationContext opContext, SearchRequest request, Entry entry, java.util.List<Control> controls) Logs a message about a search result entry that was returned to the client.
void	logSearchResultReference(OperationContext opContext, SearchRequest request, java.util.List<java.lang.String> referralURLs, java.util.List<Control> controls) Logs a message about a search result reference that was returned to the client.
void	logSecurityNegotiation(ClientContext clientContext, java.lang.String protocol, java.lang.String cipher, java.util.Map<java.lang.String,java.lang.String> properties) Logs a message about security negotiation performed by a client.
void	logUnbindRequest(OperationContext opContext, UnbindRequest request) Logs a message about an unbind request received from a client.

Methods inherited from class java.lang.Object

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

Constructor Detail

AccessLogger

public AccessLogger()

Creates a new instance of this access logger. All access logger implementations must include a default constructor, but any initialization should generally be done in the initializeAccessLogger 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.

initializeAccessLogger

public void initializeAccessLogger(ServerContext serverContext,
                                   AccessLoggerConfig config,
                                   ArgumentParser parser)
                            throws LDAPException

Initializes this access logger.

Parameters:

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

config - The general configuration for this access logger.

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

Throws:

LDAPException - If a problem occurs while initializing this access logger.

isConfigurationAcceptable

public boolean isConfigurationAcceptable(AccessLoggerConfig 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<AccessLoggerConfig>

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

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.

finalizeAccessLogger

public void finalizeAccessLogger()

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

logConnect

public void logConnect(ClientContext clientContext)

Logs a message indicating that a new connection has been established.

Parameters:

clientContext - Information about the client connection that has been accepted.

logDisconnect

public void logDisconnect(ClientContext clientContext,
                          DisconnectReason disconnectReason,
                          java.lang.String message)

Logs a message indicating that a connection has been closed.

Parameters:

clientContext - Information about the client connection that has been closed.

disconnectReason - A general reason that the connection has been closed.

message - A message with additional information about the closure. It may be null if none is available.

logSecurityNegotiation

public void logSecurityNegotiation(ClientContext clientContext,
                                   java.lang.String protocol,
                                   java.lang.String cipher,
                                   java.util.Map<java.lang.String,java.lang.String> properties)

Logs a message about security negotiation performed by a client.

Parameters:

clientContext - Information about the client connection on which the negotiation was completed.

protocol - The security protocol selected by the negotiation. It may be null if no protocol is available.

cipher - The cipher suite selected by the negotiation. It may be null if no cipher is available.

properties - A set of additional properties that may be included in the log message. It may be null or empty if no additional properties are needed.

logClientCertificateChain

public void logClientCertificateChain(ClientContext clientContext,
                                      java.security.cert.Certificate[] certChain,
                                      java.lang.String authDN)

Logs a message about a certificate chain presented by a client.

Parameters:

clientContext - Information about the client that presented the certificate chain.

certChain - The certificate chain presented by the client.

authDN - The DN of the user as whom the client was automatically authenticated, or null if the client was not automatically authenticated.

logAbandonRequest

public void logAbandonRequest(OperationContext opContext,
                              AbandonRequest request)

Logs a message about an abandon request received from a client.

Parameters:

opContext - The operation context for the abandon operation.

request - The abandon request that was received.

logAbandonForward

public void logAbandonForward(OperationContext opContext,
                              AbandonRequest request,
                              ForwardTarget target)

Logs a message about an abandon request that will be forwarded to another server.

Parameters:

opContext - The operation context for the abandon operation.

request - The abandon request that was received.

target - Information about the server to which the request will be forwarded.

logAbandonResult

public void logAbandonResult(CompletedOperationContext opContext,
                             AbandonRequest request,
                             GenericResult result)

Logs a message about the result of processing an abandon request.

Parameters:

opContext - The operation context for the abandon operation.

request - The abandon request that was received.

result - The result of processing the abandon request.

logAddRequest

public void logAddRequest(OperationContext opContext,
                          AddRequest request)

Logs a message about an add request received from a client.

Parameters:

opContext - The operation context for the add operation.

request - The add request that was received.

logAddForward

public void logAddForward(OperationContext opContext,
                          AddRequest request,
                          ForwardTarget target)

Logs a message about an add request that will be forwarded to another server.

Parameters:

opContext - The operation context for the add operation.

request - The add request that was received.

target - Information about the server to which the request will be forwarded.

logAddForwardFailure

public void logAddForwardFailure(OperationContext opContext,
                                 AddRequest request,
                                 ForwardTarget target,
                                 LDAPException failure)

Logs a message about a failure encountered while attempting to forward an add request to another server.

Parameters:

opContext - The operation context for the add operation.

request - The add request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logAddResponse

public void logAddResponse(CompletedOperationContext opContext,
                           AddRequest request,
                           AddResult result)

Logs a message about the result of processing an add request.

Parameters:

opContext - The operation context for the add operation.

request - The add request that was received.

result - The result of processing the add request.

logAddAssuranceCompleted

public void logAddAssuranceCompleted(CompletedOperationContext opContext,
                                     AddRequest request,
                                     AddResult result,
                                     AssuredReplicationResult assuranceResult)

Logs a message about the result of replication assurance processing for an add operation.

Parameters:

opContext - The operation context for the add operation.

request - The add request that was received.

result - The result of processing the add request.

assuranceResult - The replication assurance processing result.

logBindRequest

public void logBindRequest(OperationContext opContext,
                           SimpleBindRequest request)

Logs a message about a simple bind request received from a client.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

logBindForward

public void logBindForward(OperationContext opContext,
                           SimpleBindRequest request,
                           ForwardTarget target)

Logs a message about a simple bind request that will be forwarded to another server.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

target - Information about the server to which the request will be forwarded.

logBindForwardFailure

public void logBindForwardFailure(OperationContext opContext,
                                  SimpleBindRequest request,
                                  ForwardTarget target,
                                  LDAPException failure)

Logs a message about a failure encountered while attempting to forward a simple bind request to another server.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logBindResponse

public void logBindResponse(CompletedOperationContext opContext,
                            SimpleBindRequest request,
                            BindResult result)

Logs a message about the result of processing a simple bind request.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

result - The result of processing the bind request.

logBindRequest

public void logBindRequest(OperationContext opContext,
                           SASLBindRequest request)

Logs a message about a SASL bind request received from a client.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

logBindForward

public void logBindForward(OperationContext opContext,
                           SASLBindRequest request,
                           ForwardTarget target)

Logs a message about a SASL bind request that will be forwarded to another server.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

target - Information about the server to which the request will be forwarded.

logBindForwardFailure

public void logBindForwardFailure(OperationContext opContext,
                                  SASLBindRequest request,
                                  ForwardTarget target,
                                  LDAPException failure)

Logs a message about a failure encountered while attempting to forward a SASL bind request to another server.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logBindResponse

public void logBindResponse(CompletedOperationContext opContext,
                            SASLBindRequest request,
                            BindResult result)

Logs a message about the result of processing a SASL bind request.

Parameters:

opContext - The operation context for the bind operation.

request - The bind request that was received.

result - The result of processing the bind request.

logCompareRequest

public void logCompareRequest(OperationContext opContext,
                              CompareRequest request)

Logs a message about a compare request received from a client.

Parameters:

opContext - The operation context for the compare operation.

request - The compare request that was received.

logCompareForward

public void logCompareForward(OperationContext opContext,
                              CompareRequest request,
                              ForwardTarget target)

Logs a message about a compare request that will be forwarded to another server.

Parameters:

opContext - The operation context for the compare operation.

request - The compare request that was received.

target - Information about the server to which the request will be forwarded.

logCompareForwardFailure

public void logCompareForwardFailure(OperationContext opContext,
                                     CompareRequest request,
                                     ForwardTarget target,
                                     LDAPException failure)

Logs a message about a failure encountered while attempting to forward a compare request to another server.

Parameters:

opContext - The operation context for the compare operation.

request - The compare request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logCompareResponse

public void logCompareResponse(CompletedOperationContext opContext,
                               CompareRequest request,
                               CompareResult result)

Logs a message about the result of processing a compare request.

Parameters:

opContext - The operation context for the compare operation.

request - The compare request that was received.

result - The result of processing the compare request.

logDeleteRequest

public void logDeleteRequest(OperationContext opContext,
                             DeleteRequest request)

Logs a message about a delete request received from a client.

Parameters:

opContext - The operation context for the delete operation.

request - The delete request that was received.

logDeleteForward

public void logDeleteForward(OperationContext opContext,
                             DeleteRequest request,
                             ForwardTarget target)

Logs a message about a delete request that will be forwarded to another server.

Parameters:

opContext - The operation context for the delete operation.

request - The delete request that was received.

target - Information about the server to which the request will be forwarded.

logDeleteForwardFailure

public void logDeleteForwardFailure(OperationContext opContext,
                                    DeleteRequest request,
                                    ForwardTarget target,
                                    LDAPException failure)

Logs a message about a failure encountered while attempting to forward a delete request to another server.

Parameters:

opContext - The operation context for the delete operation.

request - The delete request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logDeleteResponse

public void logDeleteResponse(CompletedOperationContext opContext,
                              DeleteRequest request,
                              DeleteResult result)

Logs a message about the result of processing a delete request.

Parameters:

opContext - The operation context for the delete operation.

request - The delete request that was received.

result - The result of processing the delete request.

logDeleteAssuranceCompleted

public void logDeleteAssuranceCompleted(CompletedOperationContext opContext,
                                        DeleteRequest request,
                                        DeleteResult result,
                                        AssuredReplicationResult assuranceResult)

Logs a message about the result of replication assurance processing for a delete operation.

Parameters:

opContext - The operation context for the delete operation.

request - The delete request that was received.

result - The result of processing the delete request.

assuranceResult - The replication assurance processing result.

logExtendedRequest

public void logExtendedRequest(OperationContext opContext,
                               ExtendedRequest request)

Logs a message about an extended request received from a client.

Parameters:

opContext - The operation context for the extended operation.

request - The extended request that was received.

logExtendedForward

public void logExtendedForward(OperationContext opContext,
                               ExtendedRequest request,
                               ForwardTarget target)

Logs a message about an extended request that will be forwarded to another server.

Parameters:

opContext - The operation context for the extended operation.

request - The extended request that was received.

target - Information about the server to which the request will be forwarded.

logExtendedForwardFailure

public void logExtendedForwardFailure(OperationContext opContext,
                                      ExtendedRequest request,
                                      ForwardTarget target,
                                      LDAPException failure)

Logs a message about a failure encountered while attempting to forward an extended request to another server.

Parameters:

opContext - The operation context for the extended operation.

request - The extended request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logExtendedResponse

public void logExtendedResponse(CompletedOperationContext opContext,
                                ExtendedRequest request,
                                ExtendedResult result)

Logs a message about the result of processing an extended request.

Parameters:

opContext - The operation context for the extended operation.

request - The extended request that was received.

result - The result of processing the extended request.

logModifyRequest

public void logModifyRequest(OperationContext opContext,
                             ModifyRequest request)

Logs a message about a modify request received from a client.

Parameters:

opContext - The operation context for the modify operation.

request - The modify request that was received.

logModifyForward

public void logModifyForward(OperationContext opContext,
                             ModifyRequest request,
                             ForwardTarget target)

Logs a message about a modify request that will be forwarded to another server.

Parameters:

opContext - The operation context for the modify operation.

request - The modify request that was received.

target - Information about the server to which the request will be forwarded.

logModifyForwardFailure

public void logModifyForwardFailure(OperationContext opContext,
                                    ModifyRequest request,
                                    ForwardTarget target,
                                    LDAPException failure)

Logs a message about a failure encountered while attempting to forward a modify request to another server.

Parameters:

opContext - The operation context for the modify operation.

request - The modify request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logModifyResponse

public void logModifyResponse(CompletedOperationContext opContext,
                              ModifyRequest request,
                              ModifyResult result)

Logs a message about the result of processing a modify request.

Parameters:

opContext - The operation context for the modify operation.

request - The modify request that was received.

result - The result of processing the modify request.

logModifyAssuranceCompleted

public void logModifyAssuranceCompleted(CompletedOperationContext opContext,
                                        ModifyRequest request,
                                        ModifyResult result,
                                        AssuredReplicationResult assuranceResult)

Logs a message about the result of replication assurance processing for a modify operation.

Parameters:

opContext - The operation context for the modify operation.

request - The modify request that was received.

result - The result of processing the modify request.

assuranceResult - The replication assurance processing result.

logModifyDNRequest

public void logModifyDNRequest(OperationContext opContext,
                               ModifyDNRequest request)

Logs a message about a modify DN request received from a client.

Parameters:

opContext - The operation context for the modify DN operation.

request - The modify DN request that was received.

logModifyDNForward

public void logModifyDNForward(OperationContext opContext,
                               ModifyDNRequest request,
                               ForwardTarget target)

Logs a message about a modify DN request that will be forwarded to another server.

Parameters:

opContext - The operation context for the modify DN operation.

request - The modify DN request that was received.

target - Information about the server to which the request will be forwarded.

logModifyDNForwardFailure

public void logModifyDNForwardFailure(OperationContext opContext,
                                      ModifyDNRequest request,
                                      ForwardTarget target,
                                      LDAPException failure)

Logs a message about a failure encountered while attempting to forward a modify DN request to another server.

Parameters:

opContext - The operation context for the modify DN operation.

request - The modify DN request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logModifyDNResponse

public void logModifyDNResponse(CompletedOperationContext opContext,
                                ModifyDNRequest request,
                                ModifyDNResult result)

Logs a message about the result of processing a modify DN request.

Parameters:

opContext - The operation context for the modify DN operation.

request - The modify DN request that was received.

result - The result of processing the modify DN request.

logModifyDNAssuranceCompleted

public void logModifyDNAssuranceCompleted(CompletedOperationContext opContext,
                                          ModifyDNRequest request,
                                          ModifyDNResult result,
                                          AssuredReplicationResult assuranceResult)

Logs a message about the result of replication assurance processing for a modify DN operation.

Parameters:

opContext - The operation context for the modify DN operation.

request - The modify DN request that was received.

result - The result of processing the modify DN request.

assuranceResult - The replication assurance processing result.

logSearchRequest

public void logSearchRequest(OperationContext opContext,
                             SearchRequest request)

Logs a message about a search request received from a client.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

logSearchForward

public void logSearchForward(OperationContext opContext,
                             SearchRequest request,
                             ForwardTarget target)

Logs a message about a search request that will be forwarded to another server.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

target - Information about the server to which the request will be forwarded.

logSearchForwardFailure

public void logSearchForwardFailure(OperationContext opContext,
                                    SearchRequest request,
                                    ForwardTarget target,
                                    LDAPException failure)

Logs a message about a failure encountered while attempting to forward a search request to another server.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

target - Information about the server to which the request was forwarded.

failure - The exception that was received when attempting to forward the request.

logSearchResultEntry

public void logSearchResultEntry(OperationContext opContext,
                                 SearchRequest request,
                                 Entry entry,
                                 java.util.List<Control> controls)

Logs a message about a search result entry that was returned to the client.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

entry - The entry that was returned.

controls - The set of controls included with the entry, or an empty list if there were none.

logSearchResultReference

public void logSearchResultReference(OperationContext opContext,
                                     SearchRequest request,
                                     java.util.List<java.lang.String> referralURLs,
                                     java.util.List<Control> controls)

Logs a message about a search result reference that was returned to the client.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

referralURLs - The referral URLs for the reference that was returned.

controls - The set of controls included with the reference, or an empty list if there were none.

logSearchResultDone

public void logSearchResultDone(CompletedSearchOperationContext opContext,
                                SearchRequest request,
                                SearchResult result)

Logs a message about the result of processing a search request.

Parameters:

opContext - The operation context for the search operation.

request - The search request that was received.

result - The result of processing the search request.

logUnbindRequest

public void logUnbindRequest(OperationContext opContext,
                             UnbindRequest request)

Logs a message about an unbind request received from a client.

Parameters:

opContext - The operation context for the unbind operation.

request - The unbind request that was received.

logIntermediateResponse

public void logIntermediateResponse(OperationContext opContext,
                                    IntermediateResponse intermediateResponse)

Logs a message about an intermediate response that was returned to the client.

Parameters:

opContext - The operation context for the associated operation.

intermediateResponse - The intermediate response that was returned.

logEntryRebalancingRequest

public void logEntryRebalancingRequest(long rebalancingOperationID,
                                       OperationContext triggerOperation,
                                       java.lang.String baseDN,
                                       int sizeLimit,
                                       java.lang.String sourceBackendSetName,
                                       java.lang.String sourceAddress,
                                       int sourcePort,
                                       java.lang.String targetBackendSetName,
                                       java.lang.String targetAddress,
                                       int targetPort)

Writes a message to the access logger to indicate that the Directory Proxy Server will attempt to perform entry rebalancing by migrating a subtree from one backend set to another.

Parameters:

rebalancingOperationID - The unique ID assigned to the entry balancing operation.

triggerOperation - The operation that triggered the entry rebalancing. It may be null if the rebalancing operation wasn't triggered by a client request.

baseDN - The base DN of the subtree to migrate.

sizeLimit - The maximum number of entries to migrate.

sourceBackendSetName - The name of the backend set containing the subtree to migrate.

sourceAddress - The address of the server from which the source entries will be read.

sourcePort - The port of the server from which the source entries will be read.

targetBackendSetName - The name of the backend set to which the subtree will be migrated.

targetAddress - The address of the server to which the subtree will be migrated.

targetPort - The port of the server to which the subtree will be migrated.

logEntryRebalancingResult

public void logEntryRebalancingResult(long rebalancingOperationID,
                                      OperationContext triggerOperation,
                                      java.lang.String baseDN,
                                      int sizeLimit,
                                      java.lang.String sourceBackendSetName,
                                      java.lang.String sourceAddress,
                                      int sourcePort,
                                      java.lang.String targetBackendSetName,
                                      java.lang.String targetAddress,
                                      int targetPort,
                                      MoveSubtreeResult moveSubtreeResult)

Writes a message to the access logger to indicate that the Directory Proxy Server will attempt to perform entry rebalancing by migrating a subtree from one backend set to another.

Parameters:

rebalancingOperationID - The unique ID assigned to the entry balancing operation.

triggerOperation - The operation that triggered the entry rebalancing. It may be null if the rebalancing operation wasn't triggered by a client request.

baseDN - The base DN of the subtree to migrate.

sizeLimit - The maximum number of entries to migrate.

sourceBackendSetName - The name of the backend set containing the subtree to migrate.

sourceAddress - The address of the server from which the source entries will be read.

sourcePort - The port of the server from which the source entries will be read.

targetBackendSetName - The name of the backend set to which the subtree will be migrated.

targetAddress - The address of the server to which the subtree will be migrated.

targetPort - The port of the server to which the subtree will be migrated.

moveSubtreeResult - An object with information about the result of the subtree move processing.

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.