| | |
| | | * CDDL HEADER END |
| | | * |
| | | * |
| | | * Portions Copyright 2006-2007 Sun Microsystems, Inc. |
| | | * Portions Copyright 2007 Sun Microsystems, Inc. |
| | | */ |
| | | package org.opends.server.api; |
| | | |
| | | |
| | | |
| | | import org.opends.server.admin.std.server.AccessLogPublisherCfg; |
| | | import org.opends.server.config.ConfigException; |
| | | import org.opends.server.core.*; |
| | | import org.opends.server.types.InitializationException; |
| | | import org.opends.server.types.DisconnectReason; |
| | | import org.opends.server.types.SearchResultEntry; |
| | | import org.opends.server.types.SearchResultReference; |
| | | import org.opends.server.core.*; |
| | | |
| | | |
| | | |
| | | /** |
| | | * This class defines the set of methods and structures that must be |
| | | * implemented for a Directory Server access log publisher. |
| | | * |
| | | * @param <T> The type of access log publisher configuration handled |
| | | * by this log publisher implementation. |
| | | * @param <T> The type of access log publisher configuration handled |
| | | * by this log publisher implementation. |
| | | */ |
| | | public abstract class AccessLogPublisher |
| | | <T extends AccessLogPublisherCfg> |
| | | <T extends AccessLogPublisherCfg> |
| | | { |
| | | /** |
| | | * Indicates if internal operations should be omited in the messages |
| | |
| | | */ |
| | | protected boolean suppressInternalOperations = true; |
| | | |
| | | |
| | | |
| | | /** |
| | | * Initializes this access publisher provider based on the |
| | | * information in the provided debug publisher configuration. |
| | | * |
| | | * @param config |
| | | * The access publisher configuration that contains the |
| | | * information to use to initialize this access publisher. |
| | | * @throws org.opends.server.config.ConfigException |
| | | * If an unrecoverable problem arises in the process of |
| | | * performing the initialization as a result of the server |
| | | * configuration. |
| | | * @throws org.opends.server.types.InitializationException |
| | | * If a problem occurs during initialization that is not |
| | | * related to the server configuration. |
| | | * @param config The access publisher configuration that contains |
| | | * the information to use to initialize this access |
| | | * publisher. |
| | | * |
| | | * @throws ConfigException If an unrecoverable problem arises in |
| | | * the process of performing the |
| | | * initialization as a result of the |
| | | * server configuration. |
| | | * |
| | | * @throws InitializationException If a problem occurs during |
| | | * initialization that is not |
| | | * related to the server |
| | | * configuration. |
| | | */ |
| | | public abstract void initializeAccessLogPublisher(T config) |
| | | throws ConfigException, InitializationException; |
| | | throws ConfigException, InitializationException; |
| | | |
| | | |
| | | |
| | | /** |
| | | * Close this publisher. |
| | | */ |
| | | public abstract void close(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Writes a message to the access logger with information about a |
| | | * new client connection that has been established, regardless of |
| | |
| | | * provide additional information about |
| | | * the disconnect. |
| | | */ |
| | | public abstract void |
| | | logDisconnect(ClientConnection clientConnection, |
| | | DisconnectReason disconnectReason, |
| | | String message); |
| | | public abstract void logDisconnect( |
| | | ClientConnection clientConnection, |
| | | DisconnectReason disconnectReason, |
| | | String message); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the abandon |
| | | * request. |
| | | */ |
| | | public abstract void logAbandonRequest(AbandonOperation |
| | | abandonOperation); |
| | | public abstract void logAbandonRequest( |
| | | AbandonOperation abandonOperation); |
| | | |
| | | |
| | | |
| | | /** |
| | |
| | | * information to use to log the abandon |
| | | * request. |
| | | */ |
| | | public abstract void logAbandonResult(AbandonOperation |
| | | abandonOperation); |
| | | public abstract void logAbandonResult( |
| | | AbandonOperation abandonOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the compare |
| | | * request. |
| | | */ |
| | | public abstract void logCompareRequest(CompareOperation |
| | | compareOperation); |
| | | public abstract void logCompareRequest( |
| | | CompareOperation compareOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the compare |
| | | * response. |
| | | */ |
| | | public abstract void logCompareResponse(CompareOperation |
| | | compareOperation); |
| | | public abstract void logCompareResponse( |
| | | CompareOperation compareOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the delete |
| | | * request. |
| | | */ |
| | | public abstract void logDeleteRequest(DeleteOperation |
| | | deleteOperation); |
| | | public abstract void logDeleteRequest( |
| | | DeleteOperation deleteOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the delete |
| | | * response. |
| | | */ |
| | | public abstract void logDeleteResponse(DeleteOperation |
| | | deleteOperation); |
| | | public abstract void logDeleteResponse( |
| | | DeleteOperation deleteOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the extended |
| | | * request. |
| | | */ |
| | | public abstract void logExtendedRequest(ExtendedOperation |
| | | extendedOperation); |
| | | public abstract void logExtendedRequest( |
| | | ExtendedOperation extendedOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the extended |
| | | * response. |
| | | */ |
| | | public abstract void logExtendedResponse(ExtendedOperation |
| | | extendedOperation); |
| | | public abstract void logExtendedResponse( |
| | | ExtendedOperation extendedOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the modify |
| | | * request. |
| | | */ |
| | | public abstract void logModifyRequest(ModifyOperation |
| | | modifyOperation); |
| | | public abstract void logModifyRequest( |
| | | ModifyOperation modifyOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the modify |
| | | * response. |
| | | */ |
| | | public abstract void logModifyResponse(ModifyOperation |
| | | modifyOperation); |
| | | public abstract void logModifyResponse( |
| | | ModifyOperation modifyOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the modify |
| | | * DN request. |
| | | */ |
| | | public abstract void logModifyDNRequest(ModifyDNOperation |
| | | modifyDNOperation); |
| | | public abstract void logModifyDNRequest( |
| | | ModifyDNOperation modifyDNOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the modify |
| | | * DN response. |
| | | */ |
| | | public abstract void logModifyDNResponse(ModifyDNOperation |
| | | modifyDNOperation); |
| | | public abstract void logModifyDNResponse( |
| | | ModifyDNOperation modifyDNOperation); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the search |
| | | * request. |
| | | */ |
| | | public abstract void logSearchRequest(SearchOperation |
| | | searchOperation); |
| | | public abstract void logSearchRequest( |
| | | SearchOperation searchOperation); |
| | | |
| | | |
| | | |
| | |
| | | * @param searchEntry The search result entry to be logged. |
| | | */ |
| | | public abstract void logSearchResultEntry( |
| | | SearchOperation searchOperation, |
| | | SearchResultEntry searchEntry); |
| | | SearchOperation searchOperation, |
| | | SearchResultEntry searchEntry); |
| | | |
| | | |
| | | |
| | |
| | | * logged. |
| | | */ |
| | | public abstract void logSearchResultReference( |
| | | SearchOperation searchOperation, |
| | | SearchResultReference searchReference); |
| | | SearchOperation searchOperation, |
| | | SearchResultReference searchReference); |
| | | |
| | | |
| | | |
| | |
| | | * information to use to log the search |
| | | * result done message. |
| | | */ |
| | | public abstract void logSearchResultDone(SearchOperation |
| | | searchOperation); |
| | | public abstract void logSearchResultDone( |
| | | SearchOperation searchOperation); |
| | | |
| | | |
| | | |
| | |
| | | */ |
| | | public abstract void logUnbind(UnbindOperation unbindOperation); |
| | | } |
| | | |