org.opends.server.admin.std.client
Interface ErrorLogPublisherCfgClient

All Superinterfaces:
ConfigurationClient, LogPublisherCfgClient
All Known Subinterfaces:
FileBasedErrorLogPublisherCfgClient

public interface ErrorLogPublisherCfgClient
extends LogPublisherCfgClient

A client-side interface for reading and modifying Error Log Publisher settings.

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


Method Summary
 ManagedObjectDefinition<? extends ErrorLogPublisherCfgClient,? extends ErrorLogPublisherCfg> definition()
          Get the configuration definition 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 setDefaultSeverity(java.util.Collection<ErrorLogPublisherCfgDefn.DefaultSeverity> values)
          Sets the "default-severity" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setOverrideSeverity(java.util.Collection<java.lang.String> values)
          Sets the "override-severity" property.
 
Methods inherited from interface org.opends.server.admin.std.client.LogPublisherCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends ErrorLogPublisherCfgClient,? extends ErrorLogPublisherCfg> definition()
Get the configuration definition associated with this Error Log Publisher.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface LogPublisherCfgClient
Returns:
Returns the configuration definition associated with this Error Log Publisher.

getDefaultSeverity

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

Specifies the default severity levels for the logger.

Returns:
Returns the values of the "default-severity" property.

setDefaultSeverity

void setDefaultSeverity(java.util.Collection<ErrorLogPublisherCfgDefn.DefaultSeverity> values)
                        throws IllegalPropertyValueException
Sets the "default-severity" property.

Specifies the default severity levels for the logger.

Parameters:
values - The values of the "default-severity" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.

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.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
Sets the "java-class" property.

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

Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

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 the values of the "override-severity" property.

setOverrideSeverity

void setOverrideSeverity(java.util.Collection<java.lang.String> values)
                         throws IllegalPropertyValueException
Sets 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.

Parameters:
values - The values of the "override-severity" property.
Throws:
IllegalPropertyValueException - If one or more of the new values are invalid.