Package org.forgerock.opendj.server.config.meta

Class ErrorLogPublisherCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg>

org.forgerock.opendj.server.config.meta.ErrorLogPublisherCfgDefn

public final class ErrorLogPublisherCfgDefn
extends ManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg>

An interface for querying the Error Log Publisher managed object definition meta information.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ErrorLogPublisherCfgDefn.DefaultSeverity	Defines the set of permissable values for the "default-severity" property.

Method Summary

Modifier and Type	Method	Description
ErrorLogPublisherCfgClient	createClientConfiguration(ManagedObject<? extends ErrorLogPublisherCfgClient> impl)	Creates a client configuration view of the provided managed object.
ErrorLogPublisherCfg	createServerConfiguration(ServerManagedObject<? extends ErrorLogPublisherCfg> impl)	Creates a server configuration view of the provided server managed object.
EnumPropertyDefinition<ErrorLogPublisherCfgDefn.DefaultSeverity>	getDefaultSeverityPropertyDefinition()	Get the "default-severity" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static ErrorLogPublisherCfgDefn	getInstance()	Get the Error Log Publisher configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
StringPropertyDefinition	getOverrideSeverityPropertyDefinition()	Get the "override-severity" property definition.
Class<ErrorLogPublisherCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static ErrorLogPublisherCfgDefn getInstance()

Get the Error Log Publisher configuration definition singleton.

Returns:

Returns the Error Log Publisher configuration definition singleton.

createClientConfiguration

public ErrorLogPublisherCfgClient createClientConfiguration(ManagedObject<? extends ErrorLogPublisherCfgClient> impl)

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public ErrorLogPublisherCfg createServerConfiguration(ServerManagedObject<? extends ErrorLogPublisherCfg> impl)

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<ErrorLogPublisherCfg> getServerConfigurationClass()

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getDefaultSeverityPropertyDefinition

public EnumPropertyDefinition<ErrorLogPublisherCfgDefn.DefaultSeverity> getDefaultSeverityPropertyDefinition()

Get the "default-severity" property definition.

Specifies the default severity levels for the logger.

Returns:

Returns the "default-severity" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Error Log Publisher is enabled for use.

Returns:

Returns the "enabled" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getOverrideSeverityPropertyDefinition

public StringPropertyDefinition getOverrideSeverityPropertyDefinition()

Get the "override-severity" property definition.

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=error,info,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, error, info, warning, notice, debug.

Returns:

Returns the "override-severity" property definition.