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