/*
|
* 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
|
*
|
*
|
* Copyright 2008 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.api;
|
import org.opends.messages.Message;
|
|
|
|
import java.util.HashSet;
|
import java.util.HashMap;
|
import java.util.List;
|
|
import org.opends.server.admin.std.server.ErrorLogPublisherCfg;
|
import org.opends.server.config.ConfigException;
|
|
|
import org.opends.server.types.InitializationException;
|
import org.opends.server.types.DN;
|
import org.opends.messages.Severity;
|
import org.opends.messages.Category;
|
|
|
/**
|
* This class defines the set of methods and structures that must be
|
* implemented for a Directory Server error log publisher.
|
*
|
* @param <T> The type of error log publisher configuration handled
|
* by this log publisher implementation.
|
*/
|
@org.opends.server.types.PublicAPI(
|
stability=org.opends.server.types.StabilityLevel.VOLATILE,
|
mayInstantiate=false,
|
mayExtend=true,
|
mayInvoke=false)
|
public abstract class ErrorLogPublisher
|
<T extends ErrorLogPublisherCfg>
|
{
|
/**
|
* The hash map that will be used to define specific log severities
|
* for the various categories.
|
*/
|
protected HashMap<Category,HashSet<Severity>>
|
definedSeverities =
|
new HashMap<Category, HashSet<Severity>>();
|
|
|
|
/**
|
* The set of default log severities that will be used if no custom
|
* severities have been defined for the associated category.
|
*/
|
protected HashSet<Severity>
|
defaultSeverities = new HashSet<Severity>();
|
|
|
|
/**
|
* Initializes this access publisher provider based on the
|
* information in the provided debug publisher configuration.
|
*
|
* @param config The error publisher configuration that contains
|
* the information to use to initialize this error
|
* 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 initializeErrorLogPublisher(T config)
|
throws ConfigException, InitializationException;
|
|
|
|
/**
|
* Indicates whether the provided configuration is acceptable for
|
* this error log publisher. It should be possible to call this
|
* method on an uninitialized error log publisher instance in
|
* order to determine whether the error log publisher would be able
|
* to use the provided configuration.
|
* <BR><BR>
|
* Note that implementations which use a subclass of the provided
|
* configuration class will likely need to cast the configuration
|
* to the appropriate subclass type.
|
*
|
* @param configuration The error log publisher
|
* configuration for which to make the
|
* determination.
|
* @param unacceptableReasons A list that may be used to hold the
|
* reasons that the provided
|
* configuration is not acceptable.
|
*
|
* @return {@code true} if the provided configuration is acceptable
|
* for this error log publisher, or {@code false} if not.
|
*/
|
public boolean isConfigurationAcceptable(
|
ErrorLogPublisherCfg configuration,
|
List<Message> unacceptableReasons)
|
{
|
// This default implementation does not perform any special
|
// validation. It should be overridden by error log publisher
|
// implementations that wish to perform more detailed validation.
|
return true;
|
}
|
|
|
|
/**
|
* Close this publisher.
|
*/
|
public abstract void close();
|
|
|
|
/**
|
* Writes a message to the error log using the provided information.
|
* The message's category and severity information will be used to
|
* determine whether to actually log this message.
|
*
|
* @param message The message to be logged.
|
*/
|
public abstract void logError(Message message);
|
|
/**
|
* Gets the DN of the configuration entry for this error log
|
* publisher.
|
*
|
* @return The configuration entry DN.
|
*/
|
public abstract DN getDN();
|
|
}
|
