org.opends.server.admin.std.server
Interface ErrorLogPublisherCfg

All Superinterfaces:
Configuration, LogPublisherCfg
All Known Subinterfaces:
FileBasedErrorLogPublisherCfg

public interface ErrorLogPublisherCfg
extends LogPublisherCfg

A server-side interface for querying Error Log Publisher settings.

Error Log Publishers are responsible for distributing error log messages from the error logger to a destination.


Method Summary
 void addErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener)
          Register to be notified when this Error Log Publisher is changed.
 java.lang.Class<? extends ErrorLogPublisherCfg> configurationClass()
          Gets the configuration class associated with this Error Log Publisher.
 java.util.SortedSet<ErrorLogPublisherCfgDefn.DefaultSeverity> getDefaultSeverity()
          Gets the "default-severity" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<java.lang.String> getOverrideSeverity()
          Gets the "override-severity" property.
 void removeErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener)
          Deregister an existing Error Log Publisher configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.LogPublisherCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends ErrorLogPublisherCfg> configurationClass()
Gets the configuration class associated with this Error Log Publisher.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface LogPublisherCfg
Returns:
Returns the configuration class associated with this Error Log Publisher.

addErrorChangeListener

void addErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener)
Register to be notified when this Error Log Publisher is changed.

Parameters:
listener - The Error Log Publisher configuration change listener.

removeErrorChangeListener

void removeErrorChangeListener(ConfigurationChangeListener<ErrorLogPublisherCfg> listener)
Deregister an existing Error Log Publisher configuration change listener.

Parameters:
listener - The Error Log Publisher configuration change listener.

getDefaultSeverity

java.util.SortedSet<ErrorLogPublisherCfgDefn.DefaultSeverity> getDefaultSeverity()
Gets the "default-severity" property.

Specifies the default severity levels for the logger.

Returns:
Returns an unmodifiable set containing the values of the "default-severity" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

The fully-qualified name of the Java class that provides the Error Log Publisher implementation.

Returns:
Returns the value of the "java-class" property.

getOverrideSeverity

java.util.SortedSet<java.lang.String> getOverrideSeverity()
Gets the "override-severity" property.

Specifies the override severity levels for the logger based on the category of the messages.

Each override severity level should include the category and the severity levels to log for that category, for example, core=mild-error,info,mild-warning. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, sync, version, quicksetup, admin-tool, dsconfig, user-defined. Valid severities are: all, fatal-error, info, mild-error, mild-warning, notice, severe-error, severe-warning, debug.

Returns:
Returns an unmodifiable set containing the values of the "override-severity" property.