AccessLogger (OpenDJ 3.0.0 Documentation)

java.lang.Object
- org.opends.server.loggers.AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
- - org.opends.server.loggers.AccessLogger

All Implemented Interfaces:

ConfigurationAddListener<AccessLogPublisherCfg>, ConfigurationChangeListener<AccessLogPublisherCfg>, ConfigurationDeleteListener<AccessLogPublisherCfg>
```
public class AccessLogger
extends AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
```
This class defines the wrapper that will invoke all registered access loggers for each type of request received or response sent.

Nested Class Summary
- Nested classes/interfaces inherited from class org.opends.server.loggers.AbstractLogger
  AbstractLogger.LoggerStorage<P extends LogPublisher<C>,C extends LogPublisherCfg>

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)` Add a log publisher to the logger.
`static AccessLogger`	`getInstance()` Retrieve the singleton instance of this class.
`protected ClassPropertyDefinition`	`getJavaClassPropertyDefinition()` Returns the java `ClassPropertyDefinition` for the current logger.
`protected Collection<AccessLogPublisher<AccessLogPublisherCfg>>`	`getLogPublishers()` Returns the log publishers.
`static void`	`logAbandonRequest(AbandonOperation abandonOperation)` Writes a message to the access logger with information about the abandon request associated with the provided abandon operation.
`static void`	`logAbandonResult(AbandonOperation abandonOperation)` Writes a message to the access logger with information about the result of the provided abandon operation.
`static void`	`logAddRequest(AddOperation addOperation)` Writes a message to the access logger with information about the add request associated with the provided add operation.
`static void`	`logAddResponse(AddOperation addOperation)` Writes a message to the access logger with information about the add response associated with the provided add operation.
`static void`	`logBindRequest(BindOperation bindOperation)` Writes a message to the access logger with information about the bind request associated with the provided bind operation.
`static void`	`logBindResponse(BindOperation bindOperation)` Writes a message to the access logger with information about the bind response associated with the provided bind operation.
`static void`	`logCompareRequest(CompareOperation compareOperation)` Writes a message to the access logger with information about the compare request associated with the provided compare operation.
`static void`	`logCompareResponse(CompareOperation compareOperation)` Writes a message to the access logger with information about the compare response associated with the provided compare operation.
`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(DeleteOperation deleteOperation)` Writes a message to the access logger with information about the delete request associated with the provided delete operation.
`static void`	`logDeleteResponse(DeleteOperation deleteOperation)` Writes a message to the access logger with information about the delete response associated with the provided delete operation.
`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(ExtendedOperation extendedOperation)` Writes a message to the access logger with information about the extended request associated with the provided extended operation.
`static void`	`logExtendedResponse(ExtendedOperation extendedOperation)` Writes a message to the access logger with information about the extended response associated with the provided extended operation.
`static 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.
`static 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.
`static void`	`logModifyRequest(ModifyOperation modifyOperation)` Writes a message to the access logger with information about the modify request associated with the provided modify operation.
`static void`	`logModifyResponse(ModifyOperation modifyOperation)` Writes a message to the access logger with information about the modify response associated with the provided modify operation.
`static void`	`logSearchRequest(SearchOperation searchOperation)` Writes a message to the access logger with information about the search request associated with the provided search operation.
`static void`	`logSearchResultDone(SearchOperation searchOperation)` Writes a message to the access logger with information about the completion of the provided search operation.
`static void`	`logSearchResultEntry(SearchOperation searchOperation, SearchResultEntry searchEntry)` Writes a message to the access logger with information about the search result entry that matches the criteria associated with the provided search operation.
`static void`	`logSearchResultReference(SearchOperation searchOperation, SearchResultReference searchReference)` Writes a message to the access logger with information about the search result reference returned while processing the associated search operation.
`static void`	`logUnbind(UnbindOperation unbindOperation)` Writes a message to the access logger with information about the unbind request associated with the provided unbind operation.
`void`	`removeAllLogPublishers()` Removes all existing log publishers from the logger.
`boolean`	`removeLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)` Remove a log publisher from the logger.

Methods inherited from class org.opends.server.loggers.AbstractLogger
applyConfigurationAdd, applyConfigurationChange, applyConfigurationDelete, initializeLogger, isConfigurationAddAcceptable, isConfigurationChangeAcceptable, isConfigurationDeleteAcceptable

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

- Method Detail
  - getJavaClassPropertyDefinition
```
protected ClassPropertyDefinition getJavaClassPropertyDefinition()
```
    Returns the java ClassPropertyDefinition for the current logger.
    
    Specified by:
    
    getJavaClassPropertyDefinition in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
    
    Returns:
    the java ClassPropertyDefinition for the current logger.
  - getLogPublishers
```
protected Collection<AccessLogPublisher<AccessLogPublisherCfg>> getLogPublishers()
```
    Returns the log publishers.
    
    Specified by:
    
    getLogPublishers in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
    
    Returns:
    the collection of LogPublishers
  - getInstance
```
public static AccessLogger getInstance()
```
    Retrieve the singleton instance of this class.
    
    Returns:
    The singleton instance of this logger.
  - logConnect
```
public 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.
    
    Parameters:
    clientConnection - The client connection that has been established.
  - logDisconnect
```
public 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.
    
    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 static void logAbandonRequest(AbandonOperation abandonOperation)
```
    Writes a message to the access logger with information about the abandon request associated with the provided abandon operation.
    
    Parameters:
    abandonOperation - The abandon operation containing the information to use to log the abandon request.
  - logAbandonResult
```
public static void logAbandonResult(AbandonOperation abandonOperation)
```
    Writes a message to the access logger with information about the result of the provided abandon operation.
    
    Parameters:
    abandonOperation - The abandon operation containing the information to use to log the abandon result.
  - logAddRequest
```
public static void logAddRequest(AddOperation addOperation)
```
    Writes a message to the access logger with information about the add request associated with the provided add operation.
    
    Parameters:
    addOperation - The add operation containing the information to use to log the add request.
  - logAddResponse
```
public static void logAddResponse(AddOperation addOperation)
```
    Writes a message to the access logger with information about the add response associated with the provided add operation.
    
    Parameters:
    addOperation - The add operation containing the information to use to log the add response.
  - logBindRequest
```
public static void logBindRequest(BindOperation bindOperation)
```
    Writes a message to the access logger with information about the bind request associated with the provided bind operation.
    
    Parameters:
    bindOperation - The bind operation containing the information to use to log the bind request.
  - logBindResponse
```
public static void logBindResponse(BindOperation bindOperation)
```
    Writes a message to the access logger with information about the bind response associated with the provided bind operation.
    
    Parameters:
    bindOperation - The bind operation containing the information to use to log the bind response.
  - logCompareRequest
```
public static void logCompareRequest(CompareOperation compareOperation)
```
    Writes a message to the access logger with information about the compare request associated with the provided compare operation.
    
    Parameters:
    compareOperation - The compare operation containing the information to use to log the compare request.
  - logCompareResponse
```
public static void logCompareResponse(CompareOperation compareOperation)
```
    Writes a message to the access logger with information about the compare response associated with the provided compare operation.
    
    Parameters:
    compareOperation - The compare operation containing the information to use to log the compare response.
  - logDeleteRequest
```
public static void logDeleteRequest(DeleteOperation deleteOperation)
```
    Writes a message to the access logger with information about the delete request associated with the provided delete operation.
    
    Parameters:
    deleteOperation - The delete operation containing the information to use to log the delete request.
  - logDeleteResponse
```
public static void logDeleteResponse(DeleteOperation deleteOperation)
```
    Writes a message to the access logger with information about the delete response associated with the provided delete operation.
    
    Parameters:
    deleteOperation - The delete operation containing the information to use to log the delete response.
  - logExtendedRequest
```
public static void logExtendedRequest(ExtendedOperation extendedOperation)
```
    Writes a message to the access logger with information about the extended request associated with the provided extended operation.
    
    Parameters:
    extendedOperation - The extended operation containing the information to use to log the extended request.
  - logExtendedResponse
```
public static void logExtendedResponse(ExtendedOperation extendedOperation)
```
    Writes a message to the access logger with information about the extended response associated with the provided extended operation.
    
    Parameters:
    extendedOperation - The extended operation containing the information to use to log the extended response.
  - logModifyRequest
```
public static void logModifyRequest(ModifyOperation modifyOperation)
```
    Writes a message to the access logger with information about the modify request associated with the provided modify operation.
    
    Parameters:
    modifyOperation - The modify operation containing the information to use to log the modify request.
  - logModifyResponse
```
public static void logModifyResponse(ModifyOperation modifyOperation)
```
    Writes a message to the access logger with information about the modify response associated with the provided modify operation.
    
    Parameters:
    modifyOperation - The modify operation containing the information to use to log the modify response.
  - logModifyDNRequest
```
public static 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.
    
    Parameters:
    modifyDNOperation - The modify DN operation containing the information to use to log the modify DN request.
  - logModifyDNResponse
```
public static 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.
    
    Parameters:
    modifyDNOperation - The modify DN operation containing the information to use to log the modify DN response.
  - logSearchRequest
```
public static void logSearchRequest(SearchOperation searchOperation)
```
    Writes a message to the access logger with information about the search request associated with the provided search operation.
    
    Parameters:
    searchOperation - The search operation containing the information to use to log the search request.
  - logSearchResultEntry
```
public static void logSearchResultEntry(SearchOperation searchOperation,
                        SearchResultEntry searchEntry)
```
    Writes a message to the access logger with information about the search result entry that matches the criteria associated with the provided search operation.
    
    Parameters:
    searchOperation - The search operation with which the search result entry is associated.
    searchEntry - The search result entry to be logged.
  - logSearchResultReference
```
public static void logSearchResultReference(SearchOperation searchOperation,
                            SearchResultReference searchReference)
```
    Writes a message to the access logger with information about the search result reference returned while processing the associated search operation.
    
    Parameters:
    searchOperation - The search operation with which the search result reference is associated.
    searchReference - The search result reference to be logged.
  - logSearchResultDone
```
public static void logSearchResultDone(SearchOperation searchOperation)
```
    Writes a message to the access logger with information about the completion of the provided search operation.
    
    Parameters:
    searchOperation - The search operation containing the information to use to log the search result done message.
  - logUnbind
```
public static void logUnbind(UnbindOperation unbindOperation)
```
    Writes a message to the access logger with information about the unbind request associated with the provided unbind operation.
    
    Parameters:
    unbindOperation - The unbind operation containing the information to use to log the unbind request.
  - addLogPublisher
```
public final void addLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)
```
    Add a log publisher to the logger.
    
    Specified by:
    
    addLogPublisher in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
    
    Parameters:
    publisher - The log publisher to add.
  - removeLogPublisher
```
public final boolean removeLogPublisher(AccessLogPublisher<AccessLogPublisherCfg> publisher)
```
    Remove a log publisher from the logger.
    
    Specified by:
    
    removeLogPublisher in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>
    
    Parameters:
    publisher - The log publisher to remove.
    
    Returns:
    True if the log publisher is removed or false otherwise.
  - removeAllLogPublishers
```
public final void removeAllLogPublishers()
```
    Description copied from class: AbstractLogger
    
    Removes all existing log publishers from the logger.
    
    Specified by:
    
    removeAllLogPublishers in class AbstractLogger<AccessLogPublisher<AccessLogPublisherCfg>,AccessLogPublisherCfg>

Class AccessLogger

Nested Class Summary

Nested classes/interfaces inherited from class org.opends.server.loggers.AbstractLogger

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

getJavaClassPropertyDefinition

getLogPublishers

getInstance

logConnect

logDisconnect

logAbandonRequest

logAbandonResult

logAddRequest

logAddResponse

logBindRequest

logBindResponse

logCompareRequest

logCompareResponse

logDeleteRequest

logDeleteResponse

logExtendedRequest

logExtendedResponse

logModifyRequest

logModifyResponse

logModifyDNRequest

logModifyDNResponse

logSearchRequest

logSearchResultEntry

logSearchResultReference

logSearchResultDone

logUnbind

addLogPublisher

removeLogPublisher

removeAllLogPublishers