Package org.opends.server.loggers

Class JfrAccessLogPublisher

java.lang.Object

org.opends.server.loggers.AccessLogPublisher<AccessLogPublisherCfg>

org.opends.server.loggers.JfrAccessLogPublisher

All Implemented Interfaces:

Closeable, AutoCloseable, LogPublisher<AccessLogPublisherCfg>

public final class JfrAccessLogPublisher
extends AccessLogPublisher<AccessLogPublisherCfg>

An access logger which emits JFR events for monitoring current load.

Method Summary

Modifier and Type	Method	Description
void	close()	Close this publisher.
Dn	getDN()	Gets the DN of the configuration entry for this log publisher.
void	initializeLogPublisher(AccessLogPublisherCfg cfg, ServerContext serverContext)	Initializes this publisher provider based on the information in the provided debug publisher configuration.
void	logAbandonResult(RequestContext context, AbandonRequest request, Result result)	Writes a message to the access logger with information about the provided result.
void	logAddResult(RequestContext context, AddRequest request, Result result)	Writes a message to the access logger with information about the add result.
void	logBindResult(RequestContext context, BindRequest request, Result result)	Writes a message to the access logger with information about the bind result.
void	logCompareResult(RequestContext context, CompareRequest request, Result result)	Writes a message to the access logger with information about the compare result.
void	logDeleteResult(RequestContext context, DeleteRequest request, Result result)	Writes a message to the access logger with information about the delete result.
void	logExtendedResult(RequestContext context, ExtendedRequest<?> request, Result result)	Writes a message to the access logger with information about the extended result.
void	logInvalidResult(RequestContext context, InvalidRequest request, Result result)	Writes a message to the access logger with information about the result.
void	logModifyDnResult(RequestContext context, ModifyDnRequest request, Result result)	Writes a message to the access logger with information about the modifyDN result.
void	logModifyResult(RequestContext context, ModifyRequest request, Result result)	Writes a message to the access logger with information about the modify result.
void	logSearchResult(RequestContext context, SearchRequest request, Result result)	Writes a message to the access logger with information about the search result.
static AccessLogPublisher<AccessLogPublisherCfg>	newJfrAccessLogPublisher()	Creates a new initialized JFR access log publisher.

Methods inherited from class org.opends.server.loggers.AccessLogPublisher

isConfigurationAcceptable, logAbandonRequest, logAddRequest, logBindRequest, logCompareRequest, logConnect, logDeleteRequest, logDisconnect, logExtendedRequest, logInvalidRequest, logModifyDnRequest, logModifyRequest, logSearchRequest, logTlsHandshake, logUnbind

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

newJfrAccessLogPublisher

public static AccessLogPublisher<AccessLogPublisherCfg> newJfrAccessLogPublisher()

Creates a new initialized JFR access log publisher.

Returns:

The log publisher.

initializeLogPublisher

public void initializeLogPublisher(AccessLogPublisherCfg cfg,
 ServerContext serverContext)

Description copied from interface: LogPublisher

Initializes this publisher provider based on the information in the provided debug publisher configuration.

Parameters:

cfg - The publisher configuration that contains the information to use to initialize this publisher.

serverContext - The server context.

close

public void close()

Description copied from interface: LogPublisher

Close this publisher.

getDN

public Dn getDN()

Description copied from interface: LogPublisher

Gets the DN of the configuration entry for this log publisher.

Returns:

The configuration entry DN.

logAbandonResult

public void logAbandonResult(RequestContext context,
 AbandonRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the provided result. Note there is no LDAP result sent back to client, it is for logging purposes only.

Overrides:

logAbandonResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the context for the request

request - the original abandon request

result - the Result to the abandon request

logAddResult

public void logAddResult(RequestContext context,
 AddRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the add result.

The default implementation is to not log anything.

Overrides:

logAddResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original add request

result - the result to log

logBindResult

public void logBindResult(RequestContext context,
 BindRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the bind result.

The default implementation is to not log anything.

Overrides:

logBindResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original bind request

result - the result to log

logCompareResult

public void logCompareResult(RequestContext context,
 CompareRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the compare result.

The default implementation is to not log anything.

Overrides:

logCompareResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original compare request

result - the result to log

logDeleteResult

public void logDeleteResult(RequestContext context,
 DeleteRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the delete result.

The default implementation is to not log anything.

Overrides:

logDeleteResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original delete request

result - the result to log

logExtendedResult

public void logExtendedResult(RequestContext context,
 ExtendedRequest<?> request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the extended result.

The default implementation is to not log anything.

Overrides:

logExtendedResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original extended request

result - the result to log

logInvalidResult

public void logInvalidResult(RequestContext context,
 InvalidRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the result.

The default implementation is to not log anything.

Overrides:

logInvalidResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original description of the invalid request

result - the result to log

logModifyDnResult

public void logModifyDnResult(RequestContext context,
 ModifyDnRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modifyDN result.

The default implementation is to not log anything.

Overrides:

logModifyDnResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modifyDN request

result - the result to log

logModifyResult

public void logModifyResult(RequestContext context,
 ModifyRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the modify result.

The default implementation is to not log anything.

Overrides:

logModifyResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original modify request

result - the result to log

logSearchResult

public void logSearchResult(RequestContext context,
 SearchRequest request,
 Result result)

Description copied from class: AccessLogPublisher

Writes a message to the access logger with information about the search result.

The default implementation is to not log anything.

Overrides:

logSearchResult in class AccessLogPublisher<AccessLogPublisherCfg>

Parameters:

context - the logging context for the request

request - the original search request

result - the result to log