001/* 002 * The contents of this file are subject to the terms of the Common Development and 003 * Distribution License (the License). You may not use this file except in compliance with the 004 * License. 005 * 006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the 007 * specific language governing permission and limitations under the License. 008 * 009 * When distributing Covered Software, include this CDDL Header Notice in each file and include 010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL 011 * Header, with the fields enclosed by brackets [] replaced by your own identifying 012 * information: "Portions Copyright [year] [name of copyright owner]". 013 * 014 * Copyright 2008 Sun Microsystems, Inc. 015 */ 016package org.forgerock.opendj.server.config.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022import org.forgerock.opendj.server.config.meta.ErrorLogPublisherCfgDefn.DefaultSeverity; 023 024 025 026/** 027 * A server-side interface for querying Error Log Publisher settings. 028 * <p> 029 * Error Log Publishers are responsible for distributing error log 030 * messages from the error logger to a destination. 031 */ 032public interface ErrorLogPublisherCfg extends LogPublisherCfg { 033 034 /** 035 * Gets the configuration class associated with this Error Log Publisher. 036 * 037 * @return Returns the configuration class associated with this Error Log Publisher. 038 */ 039 Class<? extends ErrorLogPublisherCfg> configurationClass(); 040 041 042 043 /** 044 * Register to be notified when this Error Log Publisher is changed. 045 * 046 * @param listener 047 * The Error Log Publisher configuration change listener. 048 */ 049 void addErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener); 050 051 052 053 /** 054 * Deregister an existing Error Log Publisher configuration change listener. 055 * 056 * @param listener 057 * The Error Log Publisher configuration change listener. 058 */ 059 void removeErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener); 060 061 062 063 /** 064 * Gets the "default-severity" property. 065 * <p> 066 * Specifies the default severity levels for the logger. 067 * 068 * @return Returns an unmodifiable set containing the values of the "default-severity" property. 069 */ 070 SortedSet<DefaultSeverity> getDefaultSeverity(); 071 072 073 074 /** 075 * Gets the "java-class" property. 076 * <p> 077 * The fully-qualified name of the Java class that provides the 078 * Error Log Publisher implementation. 079 * 080 * @return Returns the value of the "java-class" property. 081 */ 082 String getJavaClass(); 083 084 085 086 /** 087 * Gets the "override-severity" property. 088 * <p> 089 * Specifies the override severity levels for the logger based on 090 * the category of the messages. 091 * <p> 092 * Each override severity level should include the category and the 093 * severity levels to log for that category, for example, 094 * core=error,info,warning. Valid categories are: core, extensions, 095 * protocol, config, log, util, schema, plugin, jeb, backend, tools, 096 * task, access-control, admin, sync, version, quicksetup, 097 * admin-tool, dsconfig, user-defined. Valid severities are: all, 098 * error, info, warning, notice, debug. 099 * 100 * @return Returns an unmodifiable set containing the values of the "override-severity" property. 101 */ 102 SortedSet<String> getOverrideSeverity(); 103 104}