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

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

AccessLogPublisherCfgClient, DebugLogPublisherCfgClient, ErrorLogPublisherCfgClient, FileBasedAccessLogPublisherCfgClient, FileBasedDebugLogPublisherCfgClient, FileBasedErrorLogPublisherCfgClient

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

ManagedObjectDefinition<? extends LogPublisherCfgClient,? extends LogPublisherCfg>	definition() Get the configuration definition associated with this Log Publisher.
java.lang.Boolean	isEnabled() Gets the "enabled" property.
void	setEnabled(boolean value) Sets the "enabled" property.

Methods inherited from interface org.opends.server.admin.ConfigurationClient

commit, properties

Method Detail

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

java.lang.Boolean isEnabled()

Gets the "enabled" property.

Indicates whether the Log Publisher is enabled for use.

Returns:

Returns the value of the "enabled" property.

setEnabled

void setEnabled(boolean value)
                throws IllegalPropertyValueException

Sets the "enabled" property.

Indicates whether the Log Publisher is enabled for use.

Parameters:

value - The value of the "enabled" property.

Throws:

IllegalPropertyValueException - If the new value is invalid.