public class AccessLogger extends AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
AbstractLogger.LoggerStorage<P extends LogPublisher<C>,C extends org.forgerock.opendj.server.config.server.LogPublisherCfg>
Modifier and Type | Method and Description |
---|---|
void |
addLogPublisher(AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg> publisher)
Add a log publisher to the logger.
|
static AccessLogger |
getInstance()
Retrieve the singleton instance of this class.
|
protected org.forgerock.opendj.config.ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Returns the java
ClassPropertyDefinition for the current logger. |
protected Collection<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>> |
getLogPublishers()
Returns the log publishers.
|
static 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.
|
static 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.
|
static void |
logAddRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.AddRequest request)
Writes a message to the access logger with information about the provided add request.
|
static 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 provided result.
|
static void |
logBindRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.BindRequest request)
Writes a message to the access logger with information about the provided bind request.
|
static 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 provided bind result.
|
static void |
logCompareRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.CompareRequest request)
Writes a message to the access logger with information about the provided compare request.
|
static 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 provided compare result.
|
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(RequestDJContext context,
org.forgerock.opendj.ldap.messages.DeleteRequest request)
Writes a message to the access logger with information about the provided delete request.
|
static 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 provided delete result.
|
static 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.
|
static void |
logExtendedRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
Writes a message to the access logger with information about the provided extended request.
|
static 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 provided extended result.
|
static void |
logInvalidRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.InvalidRequest request)
Writes a message to the access logger with information about an invalid request.
|
static 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 provided result.
|
static void |
logModifyDnRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
Writes a message to the access logger with information about the provided modifyDN request.
|
static 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 provided modifyDN result.
|
static void |
logModifyRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.ModifyRequest request)
Writes a message to the access logger with information about the provided modify request.
|
static 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 provided modify result.
|
static void |
logSearchRequest(RequestDJContext context,
org.forgerock.opendj.ldap.messages.SearchRequest request)
Writes a message to the access logger with information about the provided search request.
|
static 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 provided search result.
|
static 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.
|
void |
removeAllLogPublishers()
Removes all existing log publishers from the logger.
|
boolean |
removeLogPublisher(AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg> publisher)
Remove a log publisher from the logger.
|
applyConfigurationAdd, applyConfigurationChange, applyConfigurationDelete, initializeLogger, isConfigurationAddAcceptable, isConfigurationChangeAcceptable, isConfigurationDeleteAcceptable
protected org.forgerock.opendj.config.ClassPropertyDefinition getJavaClassPropertyDefinition()
AbstractLogger
ClassPropertyDefinition
for the current logger.getJavaClassPropertyDefinition
in class AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
ClassPropertyDefinition
for the current logger.protected Collection<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>> getLogPublishers()
AbstractLogger
getLogPublishers
in class AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
LogPublisher
spublic static AccessLogger getInstance()
public static void logConnect(ClientConnection clientConnection)
clientConnection
- The client connection that has been established.public static void logDisconnect(ClientConnection clientConnection, DisconnectReason disconnectReason, LocalizableMessage 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 final void addLogPublisher(AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg> publisher)
AbstractLogger
addLogPublisher
in class AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
publisher
- The log publisher to add.public final boolean removeLogPublisher(AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg> publisher)
AbstractLogger
removeLogPublisher
in class AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
publisher
- The log publisher to remove.public final void removeAllLogPublishers()
AbstractLogger
removeAllLogPublishers
in class AbstractLogger<AccessLogPublisher<org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>,org.forgerock.opendj.server.config.server.AccessLogPublisherCfg>
public static void logAbandonRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.AbandonRequest request)
context
- the context for this requestrequest
- the request to logpublic static 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 static void logAddRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logAddResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.AddRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original add requestresult
- the Result
to the add requestpublic static void logBindRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logBindResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.BindRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original bind requestresult
- the Result
to the bind requestpublic static void logCompareRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logCompareResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.CompareRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original compare requestresult
- the CompareResult
to the compare requestpublic static void logDeleteRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logDeleteResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.DeleteRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original delete requestresult
- the Result
to the delete requestpublic static void logExtendedRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request)
context
- the context for this requestrequest
- the request to logpublic static void logExtendedResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ExtendedRequest<?> request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original extended requestresult
- the Result
to the extended requestpublic static 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 static void logInvalidResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.InvalidRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original description of the invalid requestresult
- the Result
to the requestpublic static void logModifyRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logModifyResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original modify requestresult
- the Result
to the modify requestpublic static void logModifyDnRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logModifyDnResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.ModifyDnRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original modifyDN requestresult
- the Result
to the modifyDN requestpublic static void logSearchRequest(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request)
context
- the context for this requestrequest
- the request to logpublic static void logSearchResult(RequestDJContext context, org.forgerock.opendj.ldap.messages.SearchRequest request, org.forgerock.opendj.ldap.messages.Result result)
context
- the context for the requestrequest
- the original search requestresult
- the Result
to the search requestpublic static void logUnbind(RequestDJContext context, org.forgerock.opendj.ldap.messages.UnbindRequest request)
context
- the context for the requestrequest
- the request to logCopyright © 2010-2017 ForgeRock AS. All Rights Reserved.