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

Interface LogPublisherCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

AccessLogPublisherCfgClient, CommonAuditAccessLogPublisherCfgClient, ConsoleErrorLogPublisherCfgClient, CsvFileAccessLogPublisherCfgClient, CsvFileHttpAccessLogPublisherCfgClient, ErrorLogPublisherCfgClient, ExternalAccessLogPublisherCfgClient, ExternalHttpAccessLogPublisherCfgClient, FileBasedAccessLogPublisherCfgClient, FileBasedAuditLogPublisherCfgClient, FileBasedErrorLogPublisherCfgClient, FileBasedHttpAccessLogPublisherCfgClient, HttpAccessLogPublisherCfgClient, JsonFileAccessLogPublisherCfgClient, JsonFileHttpAccessLogPublisherCfgClient

public interface LogPublisherCfgClient
extends ConfigurationClient

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

Log Publishers are responsible for distributing log messages from different loggers to a destination.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LogPublisherCfgClient,? extends LogPublisherCfg>	definition()	Get the configuration definition associated with this Log Publisher.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Details

definition

ManagedObjectDefinition<? extends LogPublisherCfgClient,? extends LogPublisherCfg> definition()

Get the configuration definition associated with this Log Publisher.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Log Publisher.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the Log Publisher is enabled for use.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the Log Publisher is enabled for use.

Parameters:

value - The value of the "enabled" 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 Log Publisher implementation.

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 Log Publisher implementation.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.