org.forgerock.opendj.server.config.client

Interface MonitorBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient, LocalBackendCfgClient

public interface MonitorBackendCfgClient
extends LocalBackendCfgClient

A client-side interface for reading and modifying Monitor Backend settings.

The Monitor Backend allows clients to access the information made available by directory server monitor providers.

Method Summary

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends MonitorBackendCfgClient,? extends MonitorBackendCfg>	definition() Get the configuration definition associated with this Monitor Backend.
String	getJavaClass() Gets the "java-class" property.
LocalBackendCfgDefn.WritabilityMode	getWritabilityMode() Gets the "writability-mode" property.
void	setJavaClass(String value) Sets the "java-class" property.
void	setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value) Sets the "writability-mode" property.

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

getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends MonitorBackendCfgClient,? extends MonitorBackendCfg> definition()

Get the configuration definition associated with this Monitor Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LocalBackendCfgClient

Returns:

Returns the configuration definition associated with this Monitor Backend.

getJavaClass

String getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

getJavaClass in interface BackendCfgClient

Specified by:

getJavaClass in interface LocalBackendCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the backend implementation.

Specified by:

setJavaClass in interface BackendCfgClient

Specified by:

setJavaClass in interface LocalBackendCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.

getWritabilityMode

LocalBackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

getWritabilityMode in interface LocalBackendCfgClient

Returns:

Returns the value of the "writability-mode" property.

setWritabilityMode

void setWritabilityMode(LocalBackendCfgDefn.WritabilityMode value)
                 throws PropertyException

Sets the "writability-mode" property.

Specifies the behavior that the backend should use when processing write operations.

Specified by:

setWritabilityMode in interface LocalBackendCfgClient

Parameters:

value - The value of the "writability-mode" property.

Throws:

PropertyException - If the new value is invalid.