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

All Superinterfaces:

BackendCfgClient, ConfigurationClient

public interface ConfigFileHandlerBackendCfgClient
extends BackendCfgClient

A client-side interface for reading and modifying Config File Handler Backend settings.

The Config File Handler Backend allows clients to access the server configuration over protocol, and allow both read and write operations. Note: Modify DN operations are not supported for entries in the server configuration.

Method Summary

ManagedObjectDefinition<? extends ConfigFileHandlerBackendCfgClient,? extends ConfigFileHandlerBackendCfg>	definition() Get the configuration definition associated with this Config File Handler Backend.
java.lang.String	getJavaClass() Gets the "java-class" property.
BackendCfgDefn.WritabilityMode	getWritabilityMode() Gets the "writability-mode" property.
void	setJavaClass(java.lang.String value) Sets the "java-class" property.
void	setWritabilityMode(BackendCfgDefn.WritabilityMode value) Sets the "writability-mode" property.

Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient

getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends ConfigFileHandlerBackendCfgClient,? extends ConfigFileHandlerBackendCfg> definition()

Get the configuration definition associated with this Config File Handler Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Config File Handler Backend.

getJavaClass

java.lang.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

Returns:

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException

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

Parameters:

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

Throws:

IllegalPropertyValueException - If the new value is invalid.

getWritabilityMode

BackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

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

Specified by:

getWritabilityMode in interface BackendCfgClient

Returns:

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

setWritabilityMode

void setWritabilityMode(BackendCfgDefn.WritabilityMode value)
                        throws IllegalPropertyValueException

Sets the "writability-mode" property.

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

Specified by:

setWritabilityMode in interface BackendCfgClient

Parameters:

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

Throws:

IllegalPropertyValueException - If the new value is invalid.