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 org.forgerock.opendj.server.config.server.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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AbandonRequest request)
Writes a message to the access logger with information about the provided abandon request.
|
void |
logAbandonResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AbandonRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the provided result.
|
void |
logAddRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AddRequest request)
Writes a message to the access logger with information about the add request.
|
void |
logAddResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AddRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the add result.
|
void |
logBindRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.BindRequest request)
Writes a message to the access logger with information about the bind request.
|
void |
logBindResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.BindRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the bind result.
|
void |
logCompareRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.CompareRequest request)
Writes a message to the access logger with information about the compare request.
|
void |
logCompareResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.CompareRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the compare result.
|
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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.DeleteRequest request)
Writes a message to the access logger with information about the delete request.
|
void |
logDeleteResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.DeleteRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the delete result.
|
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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
Writes a message to the access logger with information about the extended request.
|
void |
logExtendedResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the extended result.
|
void |
logInvalidRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.InvalidRequest request)
Writes a message to the access logger with information about an invalid request.
|
void |
logInvalidResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.InvalidRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the result.
|
void |
logModifyDnRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
Writes a message to the access logger with information about the modifyDN request.
|
void |
logModifyDnResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyDnRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the modifyDN result.
|
void |
logModifyRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyRequest request)
Writes a message to the access logger with information about the modify request.
|
void |
logModifyResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the modify result.
|
void |
logSearchRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.SearchRequest request)
Writes a message to the access logger with information about the search request.
|
void |
logSearchResult(RequestDJContext context,
org.forgerock.opendj.ldap.messages.SearchRequest request,
org.forgerock.opendj.ldap.messages.Result result)
Writes a message to the access logger with information about the search result.
|
void |
logUnbind(RequestDJContext context,
org.forgerock.opendj.ldap.messages.UnbindRequest request)
Writes a message to the access logger with information about the provided unbind request.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, getDN, initializeLogPublisher
public AccessLogPublisher()
public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
LogPublisher
isConfigurationAcceptable
in interface LogPublisher<T extends org.forgerock.opendj.server.config.server.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(RequestDJContext context, org.forgerock.opendj.ldap.messages.AbandonRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the abandon request to logpublic void logAbandonResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.AbandonRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original abandon requestresult
- the Result
to the abandon requestpublic void logAddRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the add request to logpublic void logAddResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original add requestresult
- the result to logpublic void logBindRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the bind request to logpublic void logBindResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original bind requestresult
- the result to logpublic void logCompareRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the compare request to logpublic void logCompareResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original compare requestresult
- the result to logpublic void logDeleteRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original delete requestpublic void logDeleteResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original delete requestresult
- the result to logpublic void logExtendedRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original extended requestpublic void logExtendedResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original extended requestresult
- the result to logpublic void logInvalidRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.InvalidRequest request)
context
- the context for this requestrequest
- the description of the invalid request to logpublic void logInvalidResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.InvalidRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original description of the invalid requestresult
- the result to logpublic void logModifyRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modify requestpublic void logModifyResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modify requestresult
- the result to logpublic void logModifyDnRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modifyDN requestpublic void logModifyDnResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modifyDN requestresult
- the result to logpublic void logSearchRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original search requestpublic void logSearchResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request, org.forgerock.opendj.ldap.messages.Result result)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original search requestresult
- the result to logpublic void logUnbind(RequestDJContext context, org.forgerock.opendj.ldap.messages.UnbindRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the unbind request to logCopyright © 2010-2017 ForgeRock AS. All Rights Reserved.