|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.directory.sdk.common.api.FileBasedAccessLogger
@Extensible @DirectoryServerExtension @DirectoryProxyServerExtension(appliesToLocalContent=true, appliesToRemoteContent=true) @SynchronizationServerExtension(appliesToLocalContent=true, appliesToSynchronizedContent=false) @MetricsEngineExtension @IdentityBrokerExtension @ThreadSafety(level=INTERFACE_THREADSAFE) public abstract class FileBasedAccessLogger
This class defines an API that may be used to create a specific type of
access logger which is intended to write log messages to text files. This is
a convenience for developers which wish to create custom access loggers that
write to text files and provides support for a wide range of functionality
including high-performance and highly-concurrent logging. All of the options
available to AccessLogger
implementations are available for
file-based access loggers, as well as options for indicating the log file
path, the rotation and retention policies, whether to buffer the output, etc.
Note that file-based access loggers will automatically be registered within
the server as disk space consumers, so there is no need to implement the
DiskSpaceConsumer
interface. Also note that configuration change
related to the log file (e.g., the log file path, buffer size, queue size,
etc.) will also automatically be handled by the server, so subclasses only
need to be concerned about changes to the custom arguments they define.
dsconfig create-log-publisher \ --publisher-name "{logger-name}" \ --type third-party-file-based-access \ --set enabled:true \ --set "log-file:{path}" \ --set "rotation-policy:{rotation-policy-name}" \ --set "retention-policy:{retention-policy-name}" \ --set "extension-class:{class-name}" \ --set "extension-argument:{name=value}"where "{logger-name}" is the name to use for the access logger instance, "{path}" is the path to the log file to be written, "{rotation-policy-name}" is the name of the log rotation policy to use for the log file, "{retention-policy-name}" is the name of the log retention policy to use for the log file, "{class-name}" is the fully-qualified name of the Java class that extends
com.unboundid.directory.sdk.common.api.FileBasedAccessLogger
, 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. It is also possible to specify
multiple log rotation and/or retention policies if desired.
AccessLogger
,
ScriptedAccessLogger
,
ScriptedFileBasedAccessLogger
Constructor Summary | |
---|---|
FileBasedAccessLogger()
Creates a new instance of this file-based access logger. |
Method Summary | |
---|---|
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(FileBasedAccessLoggerConfig 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 |
finalizeAccessLogger()
Performs any cleanup which may be necessary when this file-based 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,
FileBasedAccessLoggerConfig config,
com.unboundid.util.args.ArgumentParser parser)
Initializes this file-based access logger. |
boolean |
isConfigurationAcceptable(FileBasedAccessLoggerConfig 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. |
java.lang.CharSequence |
logAbandonForward(OperationContext opContext,
AbandonRequest request,
ForwardTarget target)
Logs a message about an abandon request that will be forwarded to another server. |
java.lang.CharSequence |
logAbandonRequest(OperationContext opContext,
AbandonRequest request)
Logs a message about an abandon request received from a client. |
java.lang.CharSequence |
logAbandonResult(CompletedOperationContext opContext,
AbandonRequest request,
GenericResult result)
Logs a message about the result of processing an abandon request. |
java.lang.CharSequence |
logAddAssuranceCompleted(CompletedOperationContext opContext,
AddRequest request,
AddResult result,
AssuredReplicationResult assuranceResult)
Logs a message about the result of replication assurance processing for an add operation. |
java.lang.CharSequence |
logAddForward(OperationContext opContext,
AddRequest request,
ForwardTarget target)
Logs a message about an add request that will be forwarded to another server. |
java.lang.CharSequence |
logAddForwardFailure(OperationContext opContext,
AddRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward an add request to another server. |
java.lang.CharSequence |
logAddRequest(OperationContext opContext,
AddRequest request)
Logs a message about an add request received from a client. |
java.lang.CharSequence |
logAddResponse(CompletedOperationContext opContext,
AddRequest request,
AddResult result)
Logs a message about the result of processing an add request. |
java.lang.CharSequence |
logBindForward(OperationContext opContext,
SASLBindRequest request,
ForwardTarget target)
Logs a message about a SASL bind request that will be forwarded to another server. |
java.lang.CharSequence |
logBindForward(OperationContext opContext,
SimpleBindRequest request,
ForwardTarget target)
Logs a message about a simple bind request that will be forwarded to another server. |
java.lang.CharSequence |
logBindForwardFailure(OperationContext opContext,
SASLBindRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a SASL bind request to another server. |
java.lang.CharSequence |
logBindForwardFailure(OperationContext opContext,
SimpleBindRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a simple bind request to another server. |
java.lang.CharSequence |
logBindRequest(OperationContext opContext,
SASLBindRequest request)
Logs a message about a SASL bind request received from a client. |
java.lang.CharSequence |
logBindRequest(OperationContext opContext,
SimpleBindRequest request)
Logs a message about a simple bind request received from a client. |
java.lang.CharSequence |
logBindResponse(CompletedOperationContext opContext,
SASLBindRequest request,
BindResult result)
Logs a message about the result of processing a SASL bind request. |
java.lang.CharSequence |
logBindResponse(CompletedOperationContext opContext,
SimpleBindRequest request,
BindResult result)
Logs a message about the result of processing a simple bind request. |
java.lang.CharSequence |
logClientCertificateChain(ClientContext clientContext,
java.security.cert.Certificate[] certChain,
java.lang.String authDN)
Logs a message about a certificate chain presented by a client. |
java.lang.CharSequence |
logCompareForward(OperationContext opContext,
CompareRequest request,
ForwardTarget target)
Logs a message about a compare request that will be forwarded to another server. |
java.lang.CharSequence |
logCompareForwardFailure(OperationContext opContext,
CompareRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a compare request to another server. |
java.lang.CharSequence |
logCompareRequest(OperationContext opContext,
CompareRequest request)
Logs a message about a compare request received from a client. |
java.lang.CharSequence |
logCompareResponse(CompletedOperationContext opContext,
CompareRequest request,
CompareResult result)
Logs a message about the result of processing a compare request. |
java.lang.CharSequence |
logConnect(ClientContext clientContext)
Logs a message indicating that a new connection has been established. |
java.lang.CharSequence |
logDeleteAssuranceCompleted(CompletedOperationContext opContext,
DeleteRequest request,
DeleteResult result,
AssuredReplicationResult assuranceResult)
Logs a message about the result of replication assurance processing for a delete operation. |
java.lang.CharSequence |
logDeleteForward(OperationContext opContext,
DeleteRequest request,
ForwardTarget target)
Logs a message about a delete request that will be forwarded to another server. |
java.lang.CharSequence |
logDeleteForwardFailure(OperationContext opContext,
DeleteRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a delete request to another server. |
java.lang.CharSequence |
logDeleteRequest(OperationContext opContext,
DeleteRequest request)
Logs a message about a delete request received from a client. |
java.lang.CharSequence |
logDeleteResponse(CompletedOperationContext opContext,
DeleteRequest request,
DeleteResult result)
Logs a message about the result of processing a delete request. |
java.lang.CharSequence |
logDisconnect(ClientContext clientContext,
DisconnectReason disconnectReason,
java.lang.String message)
Logs a message indicating that a connection has been closed. |
java.lang.CharSequence |
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. |
java.lang.CharSequence |
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,
com.unboundid.ldap.sdk.unboundidds.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. |
java.lang.CharSequence |
logExtendedForward(OperationContext opContext,
ExtendedRequest request,
ForwardTarget target)
Logs a message about an extended request that will be forwarded to another server. |
java.lang.CharSequence |
logExtendedForwardFailure(OperationContext opContext,
ExtendedRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward an extended request to another server. |
java.lang.CharSequence |
logExtendedRequest(OperationContext opContext,
ExtendedRequest request)
Logs a message about an extended request received from a client. |
java.lang.CharSequence |
logExtendedResponse(CompletedOperationContext opContext,
ExtendedRequest request,
ExtendedResult result)
Logs a message about the result of processing an extended request. |
java.lang.CharSequence |
logIntermediateResponse(OperationContext opContext,
com.unboundid.ldap.sdk.IntermediateResponse intermediateResponse)
Logs a message about an intermediate response that was returned to the client. |
java.lang.CharSequence |
logModifyAssuranceCompleted(CompletedOperationContext opContext,
ModifyRequest request,
ModifyResult result,
AssuredReplicationResult assuranceResult)
Logs a message about the result of replication assurance processing for a modify operation. |
java.lang.CharSequence |
logModifyDNAssuranceCompleted(CompletedOperationContext opContext,
ModifyDNRequest request,
ModifyDNResult result,
AssuredReplicationResult assuranceResult)
Logs a message about the result of replication assurance processing for a modify DN operation. |
java.lang.CharSequence |
logModifyDNForward(OperationContext opContext,
ModifyDNRequest request,
ForwardTarget target)
Logs a message about a modify DN request that will be forwarded to another server. |
java.lang.CharSequence |
logModifyDNForwardFailure(OperationContext opContext,
ModifyDNRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a modify DN request to another server. |
java.lang.CharSequence |
logModifyDNRequest(OperationContext opContext,
ModifyDNRequest request)
Logs a message about a modify DN request received from a client. |
java.lang.CharSequence |
logModifyDNResponse(CompletedOperationContext opContext,
ModifyDNRequest request,
ModifyDNResult result)
Logs a message about the result of processing a modify DN request. |
java.lang.CharSequence |
logModifyForward(OperationContext opContext,
ModifyRequest request,
ForwardTarget target)
Logs a message about a modify request that will be forwarded to another server. |
java.lang.CharSequence |
logModifyForwardFailure(OperationContext opContext,
ModifyRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a modify request to another server. |
java.lang.CharSequence |
logModifyRequest(OperationContext opContext,
ModifyRequest request)
Logs a message about a modify request received from a client. |
java.lang.CharSequence |
logModifyResponse(CompletedOperationContext opContext,
ModifyRequest request,
ModifyResult result)
Logs a message about the result of processing a modify request. |
java.lang.CharSequence |
logSearchForward(OperationContext opContext,
SearchRequest request,
ForwardTarget target)
Logs a message about a search request that will be forwarded to another server. |
java.lang.CharSequence |
logSearchForwardFailure(OperationContext opContext,
SearchRequest request,
ForwardTarget target,
com.unboundid.ldap.sdk.LDAPException failure)
Logs a message about a failure encountered while attempting to forward a search request to another server. |
java.lang.CharSequence |
logSearchRequest(OperationContext opContext,
SearchRequest request)
Logs a message about a search request received from a client. |
java.lang.CharSequence |
logSearchResultDone(CompletedSearchOperationContext opContext,
SearchRequest request,
SearchResult result)
Logs a message about the result of processing a search request. |
java.lang.CharSequence |
logSearchResultEntry(OperationContext opContext,
SearchRequest request,
Entry entry,
java.util.List<com.unboundid.ldap.sdk.Control> controls)
Logs a message about a search result entry that was returned to the client. |
java.lang.CharSequence |
logSearchResultReference(OperationContext opContext,
SearchRequest request,
java.util.List<java.lang.String> referralURLs,
java.util.List<com.unboundid.ldap.sdk.Control> controls)
Logs a message about a search result reference that was returned to the client. |
java.lang.CharSequence |
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. |
java.lang.CharSequence |
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 |
---|
public FileBasedAccessLogger()
initializeAccessLogger
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 initializeAccessLogger(ServerContext serverContext, FileBasedAccessLoggerConfig 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 file-based access
logger.parser
- The argument parser which has been initialized from
the configuration for this file-based access logger.
com.unboundid.ldap.sdk.LDAPException
- If a problem occurs while initializing this
file-based access logger.public boolean isConfigurationAcceptable(FileBasedAccessLoggerConfig config, com.unboundid.util.args.ArgumentParser parser, java.util.List<java.lang.String> unacceptableReasons)
isConfigurationAcceptable
in interface Reconfigurable<FileBasedAccessLoggerConfig>
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(FileBasedAccessLoggerConfig 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<FileBasedAccessLoggerConfig>
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 finalizeAccessLogger()
public java.lang.CharSequence logConnect(ClientContext clientContext)
clientContext
- Information about the client connection that has
been accepted.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDisconnect(ClientContext clientContext, DisconnectReason disconnectReason, java.lang.String message)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSecurityNegotiation(ClientContext clientContext, java.lang.String protocol, java.lang.String cipher, java.util.Map<java.lang.String,java.lang.String> properties)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logClientCertificateChain(ClientContext clientContext, java.security.cert.Certificate[] certChain, java.lang.String authDN)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAbandonRequest(OperationContext opContext, AbandonRequest request)
opContext
- The operation context for the abandon operation.request
- The abandon request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAbandonForward(OperationContext opContext, AbandonRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAbandonResult(CompletedOperationContext opContext, AbandonRequest request, GenericResult result)
opContext
- The operation context for the abandon operation.request
- The abandon request that was received.result
- The result of processing the abandon request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAddRequest(OperationContext opContext, AddRequest request)
opContext
- The operation context for the add operation.request
- The add request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAddForward(OperationContext opContext, AddRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAddForwardFailure(OperationContext opContext, AddRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAddResponse(CompletedOperationContext opContext, AddRequest request, AddResult result)
opContext
- The operation context for the add operation.request
- The add request that was received.result
- The result of processing the add request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logAddAssuranceCompleted(CompletedOperationContext opContext, AddRequest request, AddResult result, AssuredReplicationResult assuranceResult)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindRequest(OperationContext opContext, SimpleBindRequest request)
opContext
- The operation context for the bind operation.request
- The bind request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindForward(OperationContext opContext, SimpleBindRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindForwardFailure(OperationContext opContext, SimpleBindRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindResponse(CompletedOperationContext opContext, SimpleBindRequest request, BindResult result)
opContext
- The operation context for the bind operation.request
- The bind request that was received.result
- The result of processing the bind request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindRequest(OperationContext opContext, SASLBindRequest request)
opContext
- The operation context for the bind operation.request
- The bind request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindForward(OperationContext opContext, SASLBindRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindForwardFailure(OperationContext opContext, SASLBindRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logBindResponse(CompletedOperationContext opContext, SASLBindRequest request, BindResult result)
opContext
- The operation context for the bind operation.request
- The bind request that was received.result
- The result of processing the bind request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logCompareRequest(OperationContext opContext, CompareRequest request)
opContext
- The operation context for the compare operation.request
- The compare request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logCompareForward(OperationContext opContext, CompareRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logCompareForwardFailure(OperationContext opContext, CompareRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logCompareResponse(CompletedOperationContext opContext, CompareRequest request, CompareResult result)
opContext
- The operation context for the compare operation.request
- The compare request that was received.result
- The result of processing the compare request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDeleteRequest(OperationContext opContext, DeleteRequest request)
opContext
- The operation context for the delete operation.request
- The delete request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDeleteForward(OperationContext opContext, DeleteRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDeleteForwardFailure(OperationContext opContext, DeleteRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDeleteResponse(CompletedOperationContext opContext, DeleteRequest request, DeleteResult result)
opContext
- The operation context for the delete operation.request
- The delete request that was received.result
- The result of processing the delete request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logDeleteAssuranceCompleted(CompletedOperationContext opContext, DeleteRequest request, DeleteResult result, AssuredReplicationResult assuranceResult)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logExtendedRequest(OperationContext opContext, ExtendedRequest request)
opContext
- The operation context for the extended operation.request
- The extended request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logExtendedForward(OperationContext opContext, ExtendedRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logExtendedForwardFailure(OperationContext opContext, ExtendedRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logExtendedResponse(CompletedOperationContext opContext, ExtendedRequest request, ExtendedResult result)
opContext
- The operation context for the extended operation.request
- The extended request that was received.result
- The result of processing the extended request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyRequest(OperationContext opContext, ModifyRequest request)
opContext
- The operation context for the modify operation.request
- The modify request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyForward(OperationContext opContext, ModifyRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyForwardFailure(OperationContext opContext, ModifyRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyResponse(CompletedOperationContext opContext, ModifyRequest request, ModifyResult result)
opContext
- The operation context for the modify operation.request
- The modify request that was received.result
- The result of processing the modify request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyAssuranceCompleted(CompletedOperationContext opContext, ModifyRequest request, ModifyResult result, AssuredReplicationResult assuranceResult)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyDNRequest(OperationContext opContext, ModifyDNRequest request)
opContext
- The operation context for the modify DN operation.request
- The modify DN request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyDNForward(OperationContext opContext, ModifyDNRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyDNForwardFailure(OperationContext opContext, ModifyDNRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyDNResponse(CompletedOperationContext opContext, ModifyDNRequest request, ModifyDNResult result)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logModifyDNAssuranceCompleted(CompletedOperationContext opContext, ModifyDNRequest request, ModifyDNResult result, AssuredReplicationResult assuranceResult)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchRequest(OperationContext opContext, SearchRequest request)
opContext
- The operation context for the search operation.request
- The search request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchForward(OperationContext opContext, SearchRequest request, ForwardTarget target)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchForwardFailure(OperationContext opContext, SearchRequest request, ForwardTarget target, com.unboundid.ldap.sdk.LDAPException failure)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchResultEntry(OperationContext opContext, SearchRequest request, Entry entry, java.util.List<com.unboundid.ldap.sdk.Control> controls)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchResultReference(OperationContext opContext, SearchRequest request, java.util.List<java.lang.String> referralURLs, java.util.List<com.unboundid.ldap.sdk.Control> controls)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logSearchResultDone(CompletedSearchOperationContext opContext, SearchRequest request, SearchResult result)
opContext
- The operation context for the search operation.request
- The search request that was received.result
- The result of processing the search request.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logUnbindRequest(OperationContext opContext, UnbindRequest request)
opContext
- The operation context for the unbind operation.request
- The unbind request that was received.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence logIntermediateResponse(OperationContext opContext, com.unboundid.ldap.sdk.IntermediateResponse intermediateResponse)
opContext
- The operation context for the associated
operation.intermediateResponse
- The intermediate response that was returned.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence 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)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.public java.lang.CharSequence 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, com.unboundid.ldap.sdk.unboundidds.MoveSubtreeResult moveSubtreeResult)
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.
null
or empty if no message should be written. It may
optionally include line breaks if the log message should span
multiple lines.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 |