/*
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * 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
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  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
 *
 *
 *      Portions Copyright 2006-2007 Sun Microsystems, Inc.
 */
package org.opends.server.api;

import org.opends.server.loggers.LogRecord;
import org.opends.server.loggers.LoggerErrorHandler;

/**
 * LogPublishers are reponsible for distributing logged messages from
 * the Logger object to a destination.
 */
public interface LogPublisher
{
  /**
   * Sends the log message to the logging destination. Every
   * LogPublisher must implement the publish method for
   * the generic LogRecord. Specialized LogPublishers should
   * also include an implementation to publish specialized
   * LogRecords (ie. DebugLogRecord).
   *
   * @param record the log record to publish.
   * @param handler the error handler to use when an error occurs.
   */
  public void publish(LogRecord record, LoggerErrorHandler handler);

  /**
   * Releases any resources and prepare for close.
   */
  public void shutdown();
}