java.lang.Object
- org.opends.server.loggers.AccessLogPublisher<T>

Type Parameters:

T - The type of access log publisher configuration handled by this log publisher implementation.

All Implemented Interfaces:

Closeable, AutoCloseable, LogPublisher<T>

Direct Known Subclasses:

TextAccessLogPublisher, TextAuditLogPublisher
```
@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=true,
           mayInvoke=false)
public abstract class AccessLogPublisher<T extends AccessLogPublisherCfg>
extends Object
implements LogPublisher<T>
```
This class defines the set of methods and structures that must be implemented for a Directory Server access log publisher.

Constructor Summary

Constructors
Constructor Description

AccessLogPublisher()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`isConfigurationAcceptable(T configuration, List<org.forgerock.i18n.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, org.forgerock.i18n.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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opends.server.loggers.LogPublisher
close, getDN, initializeLogPublisher

- Constructor Detail
  - AccessLogPublisher
```
public AccessLogPublisher()
```
- Method Detail
  - isConfigurationAcceptable
```
public boolean isConfigurationAcceptable(T configuration,
                                         List<org.forgerock.i18n.LocalizableMessage> unacceptableReasons)
```
    Description copied from interface: LogPublisher
    
    Indicates whether the provided configuration is acceptable for this log publisher. It should be possible to call this method on an uninitialized log publisher instance in order to determine whether the log publisher would be able to use the provided configuration.
    
    Note that implementations which use a subclass of the provided configuration class will likely need to cast the configuration to the appropriate subclass type.
    
    Specified by:
    
    isConfigurationAcceptable in interface LogPublisher<T extends AccessLogPublisherCfg>
    
    Parameters:
    
    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.
    
    Returns:
    
    true if the provided configuration is acceptable for this log publisher, or false if not.
  - logConnect
```
public 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.
    The default implementation is to not log anything.
    
    Parameters:
    
    clientConnection - The client connection that has been established.
  - logDisconnect
```
public void logDisconnect(ClientConnection clientConnection,
                          DisconnectReason disconnectReason,
                          org.forgerock.i18n.LocalizableMessage message)
```
    Writes a message to the access logger with information about the termination of an existing client connection.
    The default implementation is to not log anything.
    
    Parameters:
    
    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.
  - logAbandonRequest
```
public void logAbandonRequest(AbandonOperation abandonOperation)
```
    Writes a message to the access logger with information about the abandon request associated with the provided abandon operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    abandonOperation - The abandon operation containing the information to use to log the abandon request.
  - logAbandonResult
```
public void logAbandonResult(AbandonOperation abandonOperation)
```
    Writes a message to the access logger with information about the result of the provided abandon operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    abandonOperation - The abandon operation containing the information to use to log the abandon request.
  - logAddRequest
```
public void logAddRequest(AddOperation addOperation)
```
    Writes a message to the access logger with information about the add request associated with the provided add operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    addOperation - The add operation containing the information to use to log the add request.
  - logAddResponse
```
public void logAddResponse(AddOperation addOperation)
```
    Writes a message to the access logger with information about the add response associated with the provided add operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    addOperation - The add operation containing the information to use to log the add response.
  - logBindRequest
```
public void logBindRequest(BindOperation bindOperation)
```
    Writes a message to the access logger with information about the bind request associated with the provided bind operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    bindOperation - The bind operation containing the information to use to log the bind request.
  - logBindResponse
```
public void logBindResponse(BindOperation bindOperation)
```
    Writes a message to the access logger with information about the bind response associated with the provided bind operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    bindOperation - The bind operation containing the information to use to log the bind response.
  - logCompareRequest
```
public void logCompareRequest(CompareOperation compareOperation)
```
    Writes a message to the access logger with information about the compare request associated with the provided compare operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    compareOperation - The compare operation containing the information to use to log the compare request.
  - logCompareResponse
```
public void logCompareResponse(CompareOperation compareOperation)
```
    Writes a message to the access logger with information about the compare response associated with the provided compare operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    compareOperation - The compare operation containing the information to use to log the compare response.
  - logDeleteRequest
```
public void logDeleteRequest(DeleteOperation deleteOperation)
```
    Writes a message to the access logger with information about the delete request associated with the provided delete operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    deleteOperation - The delete operation containing the information to use to log the delete request.
  - logDeleteResponse
```
public void logDeleteResponse(DeleteOperation deleteOperation)
```
    Writes a message to the access logger with information about the delete response associated with the provided delete operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    deleteOperation - The delete operation containing the information to use to log the delete response.
  - logExtendedRequest
```
public void logExtendedRequest(ExtendedOperation extendedOperation)
```
    Writes a message to the access logger with information about the extended request associated with the provided extended operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    extendedOperation - The extended operation containing the information to use to log the extended request.
  - logExtendedResponse
```
public void logExtendedResponse(ExtendedOperation extendedOperation)
```
    Writes a message to the access logger with information about the extended response associated with the provided extended operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    extendedOperation - The extended operation containing the information to use to log the extended response.
  - logModifyRequest
```
public void logModifyRequest(ModifyOperation modifyOperation)
```
    Writes a message to the access logger with information about the modify request associated with the provided modify operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    modifyOperation - The modify operation containing the information to use to log the modify request.
  - logModifyResponse
```
public void logModifyResponse(ModifyOperation modifyOperation)
```
    Writes a message to the access logger with information about the modify response associated with the provided modify operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    modifyOperation - The modify operation containing the information to use to log the modify response.
  - logModifyDNRequest
```
public 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.
    The default implementation is to not log anything.
    
    Parameters:
    
    modifyDNOperation - The modify DN operation containing the information to use to log the modify DN request.
  - logModifyDNResponse
```
public 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.
    The default implementation is to not log anything.
    
    Parameters:
    
    modifyDNOperation - The modify DN operation containing the information to use to log the modify DN response.
  - logSearchRequest
```
public void logSearchRequest(SearchOperation searchOperation)
```
    Writes a message to the access logger with information about the search request associated with the provided search operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    searchOperation - The search operation containing the information to use to log the search request.
  - logSearchResultDone
```
public void logSearchResultDone(SearchOperation searchOperation)
```
    Writes a message to the access logger with information about the completion of the provided search operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    searchOperation - The search operation containing the information to use to log the search result done message.
  - logUnbind
```
public void logUnbind(UnbindOperation unbindOperation)
```
    Writes a message to the access logger with information about the unbind request associated with the provided unbind operation.
    The default implementation is to not log anything.
    
    Parameters:
    
    unbindOperation - The unbind operation containing the information to use to log the unbind request.

Class AccessLogPublisher<T extends AccessLogPublisherCfg>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.opends.server.loggers.LogPublisher

Constructor Detail

AccessLogPublisher

Method Detail

isConfigurationAcceptable

logConnect

logDisconnect

logAbandonRequest

logAbandonResult

logAddRequest

logAddResponse

logBindRequest

logBindResponse

logCompareRequest

logCompareResponse

logDeleteRequest

logDeleteResponse

logExtendedRequest

logExtendedResponse

logModifyRequest

logModifyResponse

logModifyDNRequest

logModifyDNResponse

logSearchRequest

logSearchResultDone

logUnbind