server/loggers/CommonAuditHTTPAccessLogPublisher.java

	CommonAuditHTTPAccessLogPublisher.java revision e433824f46514e6ed863eb6b95c70038331c8c24
/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 * or http://forgerock.org/license/CDDLv1.0.html.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at legal-notices/CDDLv1_0.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2015 ForgeRock AS
 */
package org.opends.server.loggers;

import java.util.List;

import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.json.resource.RequestHandler;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.std.server.HTTPAccessLogPublisherCfg;
import org.opends.server.core.ServerContext;
import org.opends.server.types.DN;

/**
 * Publishes HTTP access events to the common audit service.
 * <p>
 * This class actually does nothing because HTTP access logging is managed by a CHF filter.
 * (See LdapHttpApplication)
 *
 * @param <T> the type of configuration
 */
class CommonAuditHTTPAccessLogPublisher<T extends HTTPAccessLogPublisherCfg>
  extends HTTPAccessLogPublisher<T>
  implements CommonAuditLogPublisher, ConfigurationChangeListener<T>
{

  /** Current configuration for this publisher. */
  private T config;

  @Override
  public void setRequestHandler(RequestHandler handler)
  {
    // nothing to do
  }

  T getConfig()
  {
    return config;
  }

  @Override
  public void initializeLogPublisher(final T cfg, ServerContext serverContext)
  {
    config = cfg;
  }

  @Override
  public final DN getDN()
  {
    return config != null ? config.dn() : null;
  }

  @Override
  public ConfigChangeResult applyConfigurationChange(final T config)
  {
    this.config = config;
    return new ConfigChangeResult();
  }

  @Override
  public boolean isConfigurationAcceptable(final T configuration,
      final List<LocalizableMessage> unacceptableReasons)
  {
    return true;
  }

  @Override
  public boolean isConfigurationChangeAcceptable(final T config, final List<LocalizableMessage> unacceptableReasons)
  {
    return true;
  }

  @Override
  public void logRequestInfo(HTTPRequestInfo requestInfo)
  {
    // nothing to do
  }

  @Override
  public void close()
  {
    // nothing to do
  }

}