|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.api.AccessLogPublisher<FileBasedAccessLogPublisherCfg>
org.opends.server.loggers.TextAccessLogPublisher
public class TextAccessLogPublisher
This class provides the implementation of the access logger used by the directory server.
Constructor Summary | |
---|---|
TextAccessLogPublisher()
|
Method Summary | |
---|---|
ConfigChangeResult |
applyConfigurationChange(FileBasedAccessLogPublisherCfg config)
Applies the configuration changes to this change listener. |
void |
close()
Close this publisher. |
DN |
getDN()
Gets the DN of the configuration entry for this access log publisher. |
static TextAccessLogPublisher |
getStartupTextAccessPublisher(TextWriter writer,
boolean suppressInternal)
Returns an instance of the text access log publisher that will print all messages to the provided writer. |
void |
initializeAccessLogPublisher(FileBasedAccessLogPublisherCfg config)
Initializes this access publisher provider based on the information in the provided debug publisher configuration. |
boolean |
isConfigurationAcceptable(AccessLogPublisherCfg configuration,
java.util.List<Message> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this access log publisher. |
boolean |
isConfigurationChangeAcceptable(FileBasedAccessLogPublisherCfg config,
java.util.List<Message> unacceptableReasons)
Indicates whether the proposed change to the configuration is acceptable to this change listener. |
void |
logAbandonRequest(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the abandon request associated with the provided abandon operation. |
void |
logAbandonResult(AbandonOperation abandonOperation)
Writes a message to the access logger with information about the result of the provided abandon operation. |
void |
logAddRequest(AddOperation addOperation)
Writes a message to the access logger with information about the add request associated with the provided add operation. |
void |
logAddResponse(AddOperation addOperation)
Writes a message to the access logger with information about the add response associated with the provided add operation. |
void |
logBindRequest(BindOperation bindOperation)
Writes a message to the access logger with information about the bind request associated with the provided bind operation. |
void |
logBindResponse(BindOperation bindOperation)
Writes a message to the access logger with information about the bind response associated with the provided bind operation. |
void |
logCompareRequest(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare request associated with the provided compare operation. |
void |
logCompareResponse(CompareOperation compareOperation)
Writes a message to the access logger with information about the compare response associated with the provided compare operation. |
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. |
void |
logDeleteRequest(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the delete request associated with the provided delete operation. |
void |
logDeleteResponse(DeleteOperation deleteOperation)
Writes a message to the access logger with information about the delete response associated with the provided delete operation. |
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. |
void |
logExtendedRequest(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended request associated with the provided extended operation. |
void |
logExtendedResponse(ExtendedOperation extendedOperation)
Writes a message to the access logger with information about the extended response associated with the provided extended operation. |
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. |
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. |
void |
logModifyRequest(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify request associated with the provided modify operation. |
void |
logModifyResponse(ModifyOperation modifyOperation)
Writes a message to the access logger with information about the modify response associated with the provided modify operation. |
void |
logSearchRequest(SearchOperation searchOperation)
Writes a message to the access logger with information about the search request associated with the provided search operation. |
void |
logSearchResultDone(SearchOperation searchOperation)
Writes a message to the access logger with information about the completion of the provided search operation. |
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. |
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. |
void |
logUnbind(UnbindOperation unbindOperation)
Writes a message to the access logger with information about the unbind request associated with the provided unbind operation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TextAccessLogPublisher()
Method Detail |
---|
public static TextAccessLogPublisher getStartupTextAccessPublisher(TextWriter writer, boolean suppressInternal)
writer
- The text writer where the message will be written to.suppressInternal
- Indicates whether to suppress internal operations.
public boolean isConfigurationAcceptable(AccessLogPublisherCfg configuration, java.util.List<Message> unacceptableReasons)
isConfigurationAcceptable
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
configuration
- The access log publisher
configuration for which to make the
determination.unacceptableReasons
- A list that may be used to hold the
reasons that the provided
configuration is not acceptable.
true
if the provided configuration is acceptable
for this access log publisher, or false
if not.public void initializeAccessLogPublisher(FileBasedAccessLogPublisherCfg config) throws ConfigException, InitializationException
initializeAccessLogPublisher
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
config
- The access publisher configuration that contains
the information to use to initialize this access
publisher.
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 isConfigurationChangeAcceptable(FileBasedAccessLogPublisherCfg config, java.util.List<Message> unacceptableReasons)
isConfigurationChangeAcceptable
in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
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 applyConfigurationChange(FileBasedAccessLogPublisherCfg config)
applyConfigurationChange
in interface ConfigurationChangeListener<FileBasedAccessLogPublisherCfg>
config
- The new configuration containing the changes.
public void close()
close
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
public void logConnect(ClientConnection clientConnection)
logConnect
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
clientConnection
- The client connection that has been established.public void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, Message message)
logDisconnect
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
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 void logAbandonRequest(AbandonOperation abandonOperation)
logAbandonRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
abandonOperation
- The abandon operation containing the information
to use to log the abandon request.public void logAbandonResult(AbandonOperation abandonOperation)
logAbandonResult
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
abandonOperation
- The abandon operation containing the information
to use to log the abandon request.public void logAddRequest(AddOperation addOperation)
logAddRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
addOperation
- The add operation containing the information to use
to log the add request.public void logAddResponse(AddOperation addOperation)
logAddResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
addOperation
- The add operation containing the information to use
to log the add response.public void logBindRequest(BindOperation bindOperation)
logBindRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
bindOperation
- The bind operation with the information to use
to log the bind request.public void logBindResponse(BindOperation bindOperation)
logBindResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
bindOperation
- The bind operation containing the information to use
to log the bind response.public void logCompareRequest(CompareOperation compareOperation)
logCompareRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
compareOperation
- The compare operation containing the information
to use to log the compare request.public void logCompareResponse(CompareOperation compareOperation)
logCompareResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
compareOperation
- The compare operation containing the information
to use to log the compare response.public void logDeleteRequest(DeleteOperation deleteOperation)
logDeleteRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
deleteOperation
- The delete operation with the information to
use to log the delete request.public void logDeleteResponse(DeleteOperation deleteOperation)
logDeleteResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
deleteOperation
- The delete operation containing the information to
use to log the delete response.public void logExtendedRequest(ExtendedOperation extendedOperation)
logExtendedRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
extendedOperation
- The extended operation containing the
information to use to log the extended request.public void logExtendedResponse(ExtendedOperation extendedOperation)
logExtendedResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
extendedOperation
- The extended operation containing the
info to use to log the extended response.public void logModifyRequest(ModifyOperation modifyOperation)
logModifyRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyOperation
- The modify operation containing the information to
use to log the modify request.public void logModifyResponse(ModifyOperation modifyOperation)
logModifyResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyOperation
- The modify operation containing the information to
use to log the modify response.public void logModifyDNRequest(ModifyDNOperation modifyDNOperation)
logModifyDNRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyDNOperation
- The modify DN operation containing the
info to use to log the modify DN request.public void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
logModifyDNResponse
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
modifyDNOperation
- The modify DN operation containing the
information to use to log the modify DN
response.public void logSearchRequest(SearchOperation searchOperation)
logSearchRequest
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation containing the info to
use to log the search request.public void logSearchResultEntry(SearchOperation searchOperation, SearchResultEntry searchEntry)
logSearchResultEntry
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation with which the search result
entry is associated.searchEntry
- The search result entry to be logged.public void logSearchResultReference(SearchOperation searchOperation, SearchResultReference searchReference)
logSearchResultReference
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation with which the search result
reference is associated.searchReference
- The search result reference to be logged.public void logSearchResultDone(SearchOperation searchOperation)
logSearchResultDone
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
searchOperation
- The search operation containing the information
to use to log the search result done message.public void logUnbind(UnbindOperation unbindOperation)
logUnbind
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
unbindOperation
- The unbind operation containing the info to
use to log the unbind request.public DN getDN()
getDN
in class AccessLogPublisher<FileBasedAccessLogPublisherCfg>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |