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(RequestContext context,
AbandonRequest request)
Writes a message to the access logger with information about the provided abandon request.
|
void |
logAbandonResult(RequestContext context,
AbandonRequest request,
Result result)
Writes a message to the access logger with information about the provided result.
|
void |
logAddRequest(RequestContext context,
AddRequest request)
Writes a message to the access logger with information about the add request.
|
void |
logAddResult(RequestContext context,
AddRequest request,
Result result)
Writes a message to the access logger with information about the add result.
|
void |
logBindRequest(RequestContext context,
BindRequest request)
Writes a message to the access logger with information about the bind request.
|
void |
logBindResult(RequestContext context,
BindRequest request,
Result result)
Writes a message to the access logger with information about the bind result.
|
void |
logCompareRequest(RequestContext context,
CompareRequest request)
Writes a message to the access logger with information about the compare request.
|
void |
logCompareResult(RequestContext context,
CompareRequest request,
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(RequestContext context,
DeleteRequest request)
Writes a message to the access logger with information about the delete request.
|
void |
logDeleteResult(RequestContext context,
DeleteRequest request,
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(RequestContext context,
ExtendedRequest<?> request)
Writes a message to the access logger with information about the extended request.
|
void |
logExtendedResult(RequestContext context,
ExtendedRequest<?> request,
Result result)
Writes a message to the access logger with information about the extended result.
|
void |
logInvalidRequest(RequestContext context,
InvalidRequest request)
Writes a message to the access logger with information about an invalid request.
|
void |
logInvalidResult(RequestContext context,
InvalidRequest request,
Result result)
Writes a message to the access logger with information about the result.
|
void |
logModifyDnRequest(RequestContext context,
ModifyDnRequest request)
Writes a message to the access logger with information about the modifyDN request.
|
void |
logModifyDnResult(RequestContext context,
ModifyDnRequest request,
Result result)
Writes a message to the access logger with information about the modifyDN result.
|
void |
logModifyRequest(RequestContext context,
ModifyRequest request)
Writes a message to the access logger with information about the modify request.
|
void |
logModifyResult(RequestContext context,
ModifyRequest request,
Result result)
Writes a message to the access logger with information about the modify result.
|
void |
logSearchRequest(RequestContext context,
SearchRequest request)
Writes a message to the access logger with information about the search request.
|
void |
logSearchResult(RequestContext context,
SearchRequest request,
Result result)
Writes a message to the access logger with information about the search result.
|
void |
logUnbind(RequestContext context,
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 boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
LogPublisher
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(RequestContext context, AbandonRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the abandon request to logpublic void logAbandonResult(RequestContext context, AbandonRequest request, Result result)
context
- the context for the requestrequest
- the original abandon requestresult
- the Result
to the abandon requestpublic void logAddRequest(RequestContext context, AddRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the add request to logpublic void logAddResult(RequestContext context, AddRequest request, 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(RequestContext context, BindRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the bind request to logpublic void logBindResult(RequestContext context, BindRequest request, 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(RequestContext context, CompareRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the compare request to logpublic void logCompareResult(RequestContext context, CompareRequest request, 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(RequestContext context, DeleteRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original delete requestpublic void logDeleteResult(RequestContext context, DeleteRequest request, 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(RequestContext context, ExtendedRequest<?> request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original extended requestpublic void logExtendedResult(RequestContext context, ExtendedRequest<?> request, 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(RequestContext context, InvalidRequest request)
context
- the context for this requestrequest
- the description of the invalid request to logpublic void logInvalidResult(RequestContext context, InvalidRequest request, 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(RequestContext context, ModifyRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modify requestpublic void logModifyResult(RequestContext context, ModifyRequest request, 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(RequestContext context, ModifyDnRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original modifyDN requestpublic void logModifyDnResult(RequestContext context, ModifyDnRequest request, 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(RequestContext context, SearchRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the original search requestpublic void logSearchResult(RequestContext context, SearchRequest request, 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(RequestContext context, UnbindRequest request)
The default implementation is to not log anything.
context
- the logging context for the requestrequest
- the unbind request to logCopyright 2010-2022 ForgeRock AS.