Class ErrorLogPublisherCfgDefn
Error Log Publishers are responsible for distributing error log messages from the error logger to a destination.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumDefines the set of permissible values for the "default-severity" property. -
Method Summary
Modifier and TypeMethodDescriptioncreateClientConfiguration(ManagedObject<? extends ErrorLogPublisherCfgClient> impl) Creates a client configuration view of the provided managed object.createServerConfiguration(ServerManagedObject<? extends ErrorLogPublisherCfg> impl) Creates a server configuration view of the provided server managed object.Get the "default-severity" property definition.Get the "enabled" property definition.static ErrorLogPublisherCfgDefnGet the Error Log Publisher configuration definition singleton.Get the "java-class" property definition.Get the "json-output" property definition.Get the "override-severity" property definition.Gets the server configuration class instance associated with this managed object definition.Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition
getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString
-
Method Details
-
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) Description copied from class:ManagedObjectDefinitionCreates 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:
createClientConfigurationin classManagedObjectDefinition<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) Description copied from class:ManagedObjectDefinitionCreates a server configuration view of the provided server managed object.- Specified by:
createServerConfigurationin classManagedObjectDefinition<ErrorLogPublisherCfgClient,ErrorLogPublisherCfg> - Parameters:
impl- The server managed object.- Returns:
- Returns a server configuration view of the provided server managed object.
-
getServerConfigurationClass
Description copied from class:ManagedObjectDefinitionGets the server configuration class instance associated with this managed object definition.- Specified by:
getServerConfigurationClassin classManagedObjectDefinition<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 level for the logger.
- Returns:
- Returns the "default-severity" property definition.
-
getEnabledPropertyDefinition
Get the "enabled" property definition.Indicates whether the Error Log Publisher is enabled for use.
- Returns:
- Returns the "enabled" property definition.
-
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.
-
getJsonOutputPropertyDefinition
Get the "json-output" property definition.Output log lines using JSON format (structured logging) instead of free form text.
- Returns:
- Returns the "json-output" property definition.
-
getOverrideSeverityPropertyDefinition
Get the "override-severity" property definition.Specifies the override severity level for the logger based on the category of the messages.
Each override severity level should include the category and the severity level to log for that category, for example, core=info. Valid categories are: core, extensions, protocol, config, log, util, schema, plugin, jeb, backend, tools, task, access-control, admin, sync, version, setup, admin-tool, dsconfig, user-defined. Valid severities are: error, warning, notice, info, debug.
- Returns:
- Returns the "override-severity" property definition.
-