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

Interface LocalBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient

All Known Subinterfaces:

BackupBackendCfgClient, JEBackendCfgClient, LDIFBackendCfgClient, MemoryBackendCfgClient, MonitorBackendCfgClient, NullBackendCfgClient, PDBBackendCfgClient, PluggableBackendCfgClient, SchemaBackendCfgClient, TaskBackendCfgClient, TrustStoreBackendCfgClient

public interface LocalBackendCfgClient
extends BackendCfgClient

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

Local Backends are responsible for providing access to the underlying data presented by the server.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LocalBackendCfgClient,? extends LocalBackendCfg>	definition()	Get the configuration definition associated with this Local 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 LocalBackendCfgClient,? extends LocalBackendCfg> definition()

Get the configuration definition associated with this Local Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Local 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

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

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.

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.

Parameters:

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

Throws:

PropertyException - If the new value is invalid.