001/*
002 * CDDL HEADER START
003 *
004 * The contents of this file are subject to the terms of the
005 * Common Development and Distribution License, Version 1.0 only
006 * (the "License").  You may not use this file except in compliance
007 * with the License.
008 *
009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.ErrorLogPublisherCfgDefn.DefaultSeverity;
035import org.opends.server.admin.std.server.ErrorLogPublisherCfg;
036
037
038
039/**
040 * A client-side interface for reading and modifying Error Log
041 * Publisher settings.
042 * <p>
043 * Error Log Publishers are responsible for distributing error log
044 * messages from the error logger to a destination.
045 */
046public interface ErrorLogPublisherCfgClient extends LogPublisherCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Error Log Publisher.
050   *
051   * @return Returns the configuration definition associated with this Error Log Publisher.
052   */
053  ManagedObjectDefinition<? extends ErrorLogPublisherCfgClient, ? extends ErrorLogPublisherCfg> definition();
054
055
056
057  /**
058   * Gets the "default-severity" property.
059   * <p>
060   * Specifies the default severity levels for the logger.
061   *
062   * @return Returns the values of the "default-severity" property.
063   */
064  SortedSet<DefaultSeverity> getDefaultSeverity();
065
066
067
068  /**
069   * Sets the "default-severity" property.
070   * <p>
071   * Specifies the default severity levels for the logger.
072   *
073   * @param values The values of the "default-severity" property.
074   * @throws PropertyException
075   *           If one or more of the new values are invalid.
076   */
077  void setDefaultSeverity(Collection<DefaultSeverity> values) throws PropertyException;
078
079
080
081  /**
082   * Gets the "java-class" property.
083   * <p>
084   * The fully-qualified name of the Java class that provides the
085   * Error Log Publisher implementation.
086   *
087   * @return Returns the value of the "java-class" property.
088   */
089  String getJavaClass();
090
091
092
093  /**
094   * Sets the "java-class" property.
095   * <p>
096   * The fully-qualified name of the Java class that provides the
097   * Error Log Publisher implementation.
098   *
099   * @param value The value of the "java-class" property.
100   * @throws PropertyException
101   *           If the new value is invalid.
102   */
103  void setJavaClass(String value) throws PropertyException;
104
105
106
107  /**
108   * Gets the "override-severity" property.
109   * <p>
110   * Specifies the override severity levels for the logger based on
111   * the category of the messages.
112   * <p>
113   * Each override severity level should include the category and the
114   * severity levels to log for that category, for example,
115   * core=error,info,warning. Valid categories are: core, extensions,
116   * protocol, config, log, util, schema, plugin, jeb, backend, tools,
117   * task, access-control, admin, sync, version, quicksetup,
118   * admin-tool, dsconfig, user-defined. Valid severities are: all,
119   * error, info, warning, notice, debug.
120   *
121   * @return Returns the values of the "override-severity" property.
122   */
123  SortedSet<String> getOverrideSeverity();
124
125
126
127  /**
128   * Sets the "override-severity" property.
129   * <p>
130   * Specifies the override severity levels for the logger based on
131   * the category of the messages.
132   * <p>
133   * Each override severity level should include the category and the
134   * severity levels to log for that category, for example,
135   * core=error,info,warning. Valid categories are: core, extensions,
136   * protocol, config, log, util, schema, plugin, jeb, backend, tools,
137   * task, access-control, admin, sync, version, quicksetup,
138   * admin-tool, dsconfig, user-defined. Valid severities are: all,
139   * error, info, warning, notice, debug.
140   *
141   * @param values The values of the "override-severity" property.
142   * @throws PropertyException
143   *           If one or more of the new values are invalid.
144   */
145  void setOverrideSeverity(Collection<String> values) throws PropertyException;
146
147}