T
- The type of access log publisher configuration handled by
this log publisher implementation.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class AccessLogPublisher<T extends AccessLogPublisherCfg> extends Object implements LogPublisher<T>
Constructor and Description |
---|
AccessLogPublisher() |
Modifier and Type | Method and Description |
---|---|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this log
publisher.
|
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,
LocalizableMessage 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 |
logUnbind(UnbindOperation unbindOperation)
Writes a message to the access logger with information about the
unbind request associated with the provided unbind operation.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, getDN, initializeLogPublisher
public AccessLogPublisher()
public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
isConfigurationAcceptable
in interface LogPublisher<T extends AccessLogPublisherCfg>
configuration
- The 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
log publisher, or false
if not.public void logConnect(ClientConnection clientConnection)
The default implementation is to not log anything.
clientConnection
- The client connection that has been established.public void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, LocalizableMessage message)
The default implementation is to not log anything.
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)
The default implementation is to not log anything.
abandonOperation
- The abandon operation containing the information to use
to log the abandon request.public void logAbandonResult(AbandonOperation abandonOperation)
The default implementation is to not log anything.
abandonOperation
- The abandon operation containing the information to use
to log the abandon request.public void logAddRequest(AddOperation addOperation)
The default implementation is to not log anything.
addOperation
- The add operation containing the information to use to
log the add request.public void logAddResponse(AddOperation addOperation)
The default implementation is to not log anything.
addOperation
- The add operation containing the information to use to
log the add response.public void logBindRequest(BindOperation bindOperation)
The default implementation is to not log anything.
bindOperation
- The bind operation containing the information to use to
log the bind request.public void logBindResponse(BindOperation bindOperation)
The default implementation is to not log anything.
bindOperation
- The bind operation containing the information to use to
log the bind response.public void logCompareRequest(CompareOperation compareOperation)
The default implementation is to not log anything.
compareOperation
- The compare operation containing the information to use
to log the compare request.public void logCompareResponse(CompareOperation compareOperation)
The default implementation is to not log anything.
compareOperation
- The compare operation containing the information to use
to log the compare response.public void logDeleteRequest(DeleteOperation deleteOperation)
The default implementation is to not log anything.
deleteOperation
- The delete operation containing the information to use
to log the delete request.public void logDeleteResponse(DeleteOperation deleteOperation)
The default implementation is to not log anything.
deleteOperation
- The delete operation containing the information to use
to log the delete response.public void logExtendedRequest(ExtendedOperation extendedOperation)
The default implementation is to not log anything.
extendedOperation
- The extended operation containing the information to use
to log the extended request.public void logExtendedResponse(ExtendedOperation extendedOperation)
The default implementation is to not log anything.
extendedOperation
- The extended operation containing the information to use
to log the extended response.public void logModifyRequest(ModifyOperation modifyOperation)
The default implementation is to not log anything.
modifyOperation
- The modify operation containing the information to use
to log the modify request.public void logModifyResponse(ModifyOperation modifyOperation)
The default implementation is to not log anything.
modifyOperation
- The modify operation containing the information to use
to log the modify response.public void logModifyDNRequest(ModifyDNOperation modifyDNOperation)
The default implementation is to not log anything.
modifyDNOperation
- The modify DN operation containing the information to
use to log the modify DN request.public void logModifyDNResponse(ModifyDNOperation modifyDNOperation)
The default implementation is to not log anything.
modifyDNOperation
- The modify DN operation containing the information to
use to log the modify DN response.public void logSearchRequest(SearchOperation searchOperation)
The default implementation is to not log anything.
searchOperation
- The search operation containing the information to use
to log the search request.public void logSearchResultDone(SearchOperation searchOperation)
The default implementation is to not log anything.
searchOperation
- The search operation containing the information to use
to log the search result done message.public void logUnbind(UnbindOperation unbindOperation)
The default implementation is to not log anything.
unbindOperation
- The unbind operation containing the information to use
to log the unbind request.Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.