From 62914469967c1c2c20648f40c9b29aa572db01f5 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Fri, 07 Oct 2011 13:26:28 +0000
Subject: [PATCH] Preparation work for OPENDJ-308: Implement access log filtering and configurable message format

---
 opendj-sdk/opends/src/server/org/opends/server/api/AccessLogPublisher.java |  309 ---------------------------------------------------
 1 files changed, 1 insertions(+), 308 deletions(-)

diff --git a/opendj-sdk/opends/src/server/org/opends/server/api/AccessLogPublisher.java b/opendj-sdk/opends/src/server/org/opends/server/api/AccessLogPublisher.java
index 421cd53..4468ff9 100644
--- a/opendj-sdk/opends/src/server/org/opends/server/api/AccessLogPublisher.java
+++ b/opendj-sdk/opends/src/server/org/opends/server/api/AccessLogPublisher.java
@@ -23,13 +23,13 @@
  *
  *
  *      Copyright 2008-2009 Sun Microsystems, Inc.
+ *      Portions copyright 2011 ForgeRock AS.
  */
 package org.opends.server.api;
 
 
 
 import java.util.List;
-import java.util.Map;
 
 import org.opends.server.admin.std.server.AccessLogPublisherCfg;
 import org.opends.server.config.ConfigException;
@@ -133,30 +133,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided client connection.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param clientConnection
-   *          The client connection that has been established.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logConnectIntermediateMessage(
-      ClientConnection clientConnection, String category,
-      Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * termination of an existing client connection.
    * <p>
@@ -180,30 +156,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided client disconnection.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param clientConnection
-   *          The client connection that has been terminated.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logDisconnectIntermediateMessage(
-      ClientConnection clientConnection, String category,
-      Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * abandon request associated with the provided abandon operation.
    * <p>
@@ -221,35 +173,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided abandon operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param abandonOperation
-   *          The abandon operation containing the information to use
-   *          to log the abandon request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logAbandonIntermediateMessage(
-      AbandonOperation abandonOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing.
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * result of the provided abandon operation.
    * <p>
@@ -284,34 +207,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided add operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param addOperation
-   *          The add operation containing the information to use to
-   *          log the add request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logAddIntermediateMessage(AddOperation addOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * add response associated with the provided add operation.
    * <p>
@@ -346,34 +241,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided bind operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param bindOperation
-   *          The bind operation containing the information to use to
-   *          log the bind request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logBindIntermediateMessage(BindOperation bindOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * bind response associated with the provided bind operation.
    * <p>
@@ -408,35 +275,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided compare operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param compareOperation
-   *          The compare operation containing the information to use
-   *          to log the abandon compare.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logCompareIntermediateMessage(
-      CompareOperation compareOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * compare response associated with the provided compare operation.
    * <p>
@@ -471,35 +309,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided delete operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param deleteOperation
-   *          The delete operation containing the information to use
-   *          to log the delete request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logDeleteIntermediateMessage(
-      DeleteOperation deleteOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * delete response associated with the provided delete operation.
    * <p>
@@ -534,35 +343,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided extended operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param extendedOperation
-   *          The extended operation containing the information to use
-   *          to log the extended request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logExtendedIntermediateMessage(
-      ExtendedOperation extendedOperation, String category,
-      Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * extended response associated with the provided extended
    * operation.
@@ -598,35 +378,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided modify operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param modifyOperation
-   *          The modify operation containing the information to use
-   *          to log the modify request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logModifyIntermediateMessage(
-      ModifyOperation modifyOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * modify response associated with the provided modify operation.
    * <p>
@@ -662,35 +413,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided modify DN operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param modifyDNOperation
-   *          The modify DN operation containing the information to
-   *          use to log the modify DN request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logModifyDNIntermediateMessage(
-      ModifyDNOperation modifyDNOperation, String category,
-      Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * modify DN response associated with the provided modify DN
    * operation.
@@ -726,35 +448,6 @@
 
 
   /**
-   * Writes a message to the access logger containing additional
-   * information associated with the provided search operation.
-   * <p>
-   * This method will only be called after the request has been logged
-   * and before the response. Implementations can choose to ignore
-   * intermediate responses or filter them based on their category.
-   * <p>
-   * The default implementation is to not log anything.
-   *
-   * @param searchOperation
-   *          The search operation containing the information to use
-   *          to log the search request.
-   * @param category
-   *          The category of the intermediate message.
-   * @param content
-   *          The content of the intermediate message. This comprises
-   *          of one or more key/value pairs which form the content of
-   *          the intermediate message.
-   */
-  public void logSearchIntermediateMessage(
-      SearchOperation searchOperation,
-      String category, Map<String, String> content)
-  {
-    // Do nothing
-  }
-
-
-
-  /**
    * Writes a message to the access logger with information about the
    * search result entry that matches the criteria associated with the
    * provided search operation.

--
Gitblit v1.10.0