|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.loggers.AccessLogger
public class AccessLogger
This class defines the wrapper that will invoke all registered access loggers for each type of request received or response sent.
Constructor Summary | |
---|---|
AccessLogger()
|
Method Summary | |
---|---|
static void |
addAccessLogPublisher(AccessLogPublisher publisher)
Add an access log publisher to the access logger. |
ConfigChangeResult |
applyConfigurationAdd(AccessLogPublisherCfg config)
Adds a new configuration to this add listener. |
ConfigChangeResult |
applyConfigurationChange(AccessLogPublisherCfg config)
Applies the configuration changes to this change listener. |
ConfigChangeResult |
applyConfigurationDelete(AccessLogPublisherCfg config)
Deletes an existing configuration from this delete listener. |
static AccessLogger |
getInstance()
Retrieve the singleton instance of this class. |
void |
initializeAccessLogger(java.util.List<AccessLogPublisherCfg> configs)
Initializes all the access log publishers. |
boolean |
isConfigurationAddAcceptable(AccessLogPublisherCfg config,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed addition of a new configuration is acceptable to this add listener. |
boolean |
isConfigurationChangeAcceptable(AccessLogPublisherCfg config,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
boolean |
isConfigurationDeleteAcceptable(AccessLogPublisherCfg config,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed deletion of an existing configuration is acceptable to this delete listener. |
static void |
logAbandonRequest(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the abandon request associated with the provided abandon operation. |
static void |
logAbandonResult(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the result of the provided abandon operation. |
static void |
logAddRequest(AddOperation addOperation)
Writes a message to the access logger with information about the add request associated with the provided add operation. |
static void |
logAddResponse(AddOperation addOperation)
Writes a message to the access logger with information about the add response associated with the provided add operation. |
static void |
logBindRequest(BindOperation bindOperation)
Writes a message to the access logger with information about the bind request associated with the provided bind operation. |
static void |
logBindResponse(BindOperation bindOperation)
Writes a message to the access logger with information about the bind response associated with the provided bind operation. |
static void |
logCompareRequest(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare request associated with the provided compare operation. |
static void |
logCompareResponse(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare response associated with the provided compare operation. |
static void |
logConnect(ClientConnection clientConnection)
Writes a message to the access logger with information about a new client connection that has been established, regardless of whether it will be immediately terminated. |
static void |
logDeleteRequest(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the delete request associated with the provided delete operation. |
static void |
logDeleteResponse(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the delete response associated with the provided delete operation. |
static void |
logDisconnect(ClientConnection clientConnection,
DisconnectReason disconnectReason,
Message message)
Writes a message to the access logger with information about the termination of an existing client connection. |
static void |
logExtendedRequest(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended request associated with the provided extended operation. |
static void |
logExtendedResponse(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended response associated with the provided extended operation. |
static void |
logModifyDNRequest(ModifyDNOperation modifyDNOperation)
Writes a message to the access logger with information about the modify DN request associated with the provided modify DN operation. |
static void |
logModifyDNResponse(ModifyDNOperation modifyDNOperation)
Writes a message to the access logger with information about the modify DN response associated with the provided modify DN operation. |
static void |
logModifyRequest(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify request associated with the provided modify operation. |
static void |
logModifyResponse(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify response associated with the provided modify operation. |
static void |
logSearchRequest(SearchOperation searchOperation)
Writes a message to the access logger with information about the search request associated with the provided search operation. |
static void |
logSearchResultDone(SearchOperation searchOperation)
Writes a message to the access logger with information about the completion of the provided search operation. |
static void |
logSearchResultEntry(SearchOperation searchOperation,
SearchResultEntry searchEntry)
Writes a message to the access logger with information about the search result entry that matches the criteria associated with the provided search operation. |
static void |
logSearchResultReference(SearchOperation searchOperation,
SearchResultReference searchReference)
Writes a message to the access logger with information about the search result reference returned while processing the associated search operation. |
static void |
logUnbind(UnbindOperation unbindOperation)
Writes a message to the access logger with information about the unbind request associated with the provided unbind operation. |
static boolean |
removeAccessLogPublisher(AccessLogPublisher publisher)
Remove an access log publisher from the access logger. |
static void |
removeAllAccessLogPublishers()
Removes all existing access log publishers from the logger. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AccessLogger()
Method Detail |
---|
public static AccessLogger getInstance()
public static void addAccessLogPublisher(AccessLogPublisher publisher)
publisher
- The access log publisher to add.public static boolean removeAccessLogPublisher(AccessLogPublisher publisher)
publisher
- The access log publisher to remove.
public static void removeAllAccessLogPublishers()
public void initializeAccessLogger(java.util.List<AccessLogPublisherCfg> configs) throws ConfigException, InitializationException
configs
- The access log publisher configurations.
ConfigException
- If an unrecoverable problem arises in the process of
performing the initialization as a result of the server
configuration.
InitializationException
- If a problem occurs during initialization that is not
related to the server configuration.public boolean isConfigurationAddAcceptable(AccessLogPublisherCfg config, java.util.List<Message> unacceptableReasons)
isConfigurationAddAcceptable
in interface ConfigurationAddListener<AccessLogPublisherCfg>
config
- The configuration that will be added.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed addition is
acceptable, or false
if it is not.public boolean isConfigurationChangeAcceptable(AccessLogPublisherCfg config, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<AccessLogPublisherCfg>
config
- The new configuration containing the changes.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed change is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationAdd(AccessLogPublisherCfg config)
applyConfigurationAdd
in interface ConfigurationAddListener<AccessLogPublisherCfg>
config
- The configuration that will be added.
public ConfigChangeResult applyConfigurationChange(AccessLogPublisherCfg config)
applyConfigurationChange
in interface ConfigurationChangeListener<AccessLogPublisherCfg>
config
- The new configuration containing the changes.
public boolean isConfigurationDeleteAcceptable(AccessLogPublisherCfg config, java.util.List<Message> unacceptableReasons)
isConfigurationDeleteAcceptable
in interface ConfigurationDeleteListener<AccessLogPublisherCfg>
config
- The configuration that will be deleted.unacceptableReasons
- A list that can be used to hold messages about why the
provided configuration is not acceptable.
true
if the proposed deletion is
acceptable, or false
if it is not.public ConfigChangeResult applyConfigurationDelete(AccessLogPublisherCfg config)
applyConfigurationDelete
in interface ConfigurationDeleteListener<AccessLogPublisherCfg>
config
- The existing configuration that will be deleted.
public static void logConnect(ClientConnection clientConnection)
clientConnection
- The client connection that has been established.public static void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, Message message)
clientConnection
- The client connection that has been terminated.disconnectReason
- A generic disconnect reason for the connection
termination.message
- A human-readable message that can provide
additional information about the disconnect.public static void logAbandonRequest(AbandonOperation abandonOperation)
abandonOperation
- The abandon operation containing the information
to use to log the abandon request.public static void logAbandonResult(AbandonOperation abandonOperation)
abandonOperation
- The abandon operation containing the information
to use to log the abandon result.public static void logAddRequest(AddOperation addOperation)
addOperation
- The add operation containing the information to use
to log the add request.public static void logAddResponse(AddOperation addOperation)
addOperation
- The add operation containing the information to use
to log the add response.public static void logBindRequest(BindOperation bindOperation)
bindOperation
- The bind operation containing the information to use
to log the bind request.public static void logBindResponse(BindOperation bindOperation)
bindOperation
- The bind operation containing the information to use
to log the bind response.public static void logCompareRequest(CompareOperation compareOperation)
compareOperation
- The compare operation containing the information
to use to log the compare request.public static void logCompareResponse(CompareOperation compareOperation)
compareOperation
- The compare operation containing the information
to use to log the compare response.public static void logDeleteRequest(DeleteOperation deleteOperation)
deleteOperation
- The delete operation containing the information to
use to log the delete request.public static void logDeleteResponse(DeleteOperation deleteOperation)
deleteOperation
- The delete operation containing the information to
use to log the delete response.public static void logExtendedRequest(ExtendedOperation extendedOperation)
extendedOperation
- The extended operation containing the
information to use to log the extended request.public static void logExtendedResponse(ExtendedOperation extendedOperation)
extendedOperation
- The extended operation containing the
information to use to log the extended response.public static void logModifyRequest(ModifyOperation modifyOperation)
modifyOperation
- The modify operation containing the information to
use to log the modify request.public static void logModifyResponse(ModifyOperation modifyOperation)
modifyOperation
- The modify operation containing the information to
use to log the modify response.public static void logModifyDNRequest(ModifyDNOperation modifyDNOperation)
modifyDNOperation
- The modify DN operation containing the
information to use to log the modify DN request.public static void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
modifyDNOperation
- The modify DN operation containing the
information to use to log the modify DN
response.public static void logSearchRequest(SearchOperation searchOperation)
searchOperation
- The search operation containing the information to
use to log the search request.public static void logSearchResultEntry(SearchOperation searchOperation, SearchResultEntry searchEntry)
searchOperation
- The search operation with which the search result
entry is associated.searchEntry
- The search result entry to be logged.public static void logSearchResultReference(SearchOperation searchOperation, SearchResultReference searchReference)
searchOperation
- The search operation with which the search result
reference is associated.searchReference
- The search result reference to be logged.public static void logSearchResultDone(SearchOperation searchOperation)
searchOperation
- The search operation containing the information
to use to log the search result done message.public static void logUnbind(UnbindOperation unbindOperation)
unbindOperation
- The unbind operation containing the information to
use to log the unbind request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |