Package org.forgerock.opendj.server.config.client

Interface ErrorLogPublisherCfgClient

All Superinterfaces:

ConfigurationClient, LogPublisherCfgClient

All Known Subinterfaces:

ConsoleErrorLogPublisherCfgClient, 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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ErrorLogPublisherCfgClient,? extends ErrorLogPublisherCfg>	definition()	Get the configuration definition associated with this Error Log Publisher.
ValueOrExpression<ErrorLogPublisherCfgDefn.DefaultSeverity>	getDefaultSeverity()	Gets the "default-severity" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
SortedSet<ValueOrExpression<String>>	getOverrideSeverity()	Gets the "override-severity" property.
ValueOrExpression<Boolean>	isJsonOutput()	Gets the "json-output" property.
void	setDefaultSeverity(ValueOrExpression<ErrorLogPublisherCfgDefn.DefaultSeverity> value)	Sets the "default-severity" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setJsonOutput(ValueOrExpression<Boolean> value)	Sets the "json-output" property.
void	setOverrideSeverity(Collection<ValueOrExpression<String>> values)	Sets the "override-severity" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.LogPublisherCfgClient

isEnabled, setEnabled

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

ValueOrExpression<ErrorLogPublisherCfgDefn.DefaultSeverity> getDefaultSeverity()

Gets the "default-severity" property.

Specifies the default severity level for the logger.

Default value: notice

Returns:

Returns the value of the "default-severity" property.

setDefaultSeverity

void setDefaultSeverity(ValueOrExpression<ErrorLogPublisherCfgDefn.DefaultSeverity> value)
                 throws PropertyException

Sets the "default-severity" property.

Specifies the default severity level for the logger.

Parameters:

value - The value of the "default-severity" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.loggers.ErrorLogPublisher

Specified by:

getJavaClass in interface LogPublisherCfgClient

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Specified by:

setJavaClass in interface LogPublisherCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

isJsonOutput

ValueOrExpression<Boolean> isJsonOutput()

Gets the "json-output" property.

Output log lines using JSON format (structured logging) instead of free form text.

Default value: false

Returns:

Returns the value of the "json-output" property.

setJsonOutput

void setJsonOutput(ValueOrExpression<Boolean> value)
            throws PropertyException

Sets the "json-output" property.

Output log lines using JSON format (structured logging) instead of free form text.

Parameters:

value - The value of the "json-output" property.

Throws:

PropertyException - If the new value is invalid.

getOverrideSeverity

SortedSet<ValueOrExpression<String>> getOverrideSeverity()

Gets the "override-severity" property.

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

setOverrideSeverity

void setOverrideSeverity(Collection<ValueOrExpression<String>> values)
                  throws PropertyException

Sets the "override-severity" property.

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.

Parameters:

values - The values of the "override-severity" property.

Throws:

PropertyException - If one or more of the new values are invalid.