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

Interface LocalBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient

All Known Subinterfaces:

JeBackendCfgClient, LdifBackendCfgClient, MemoryBackendCfgClient, MonitorBackendCfgClient, NullBackendCfgClient, PluggableBackendCfgClient, SchemaBackendCfgClient, TaskBackendCfgClient

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.
ValueOrExpression<LocalBackendCfgDefn.WritabilityMode>	getWritabilityMode()	Gets the "writability-mode" property.
void	setWritabilityMode(ValueOrExpression<LocalBackendCfgDefn.WritabilityMode> value)	Sets the "writability-mode" property.

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

getBackendId, getJavaClass, isEnabled, setBackendId, setEnabled, setJavaClass

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

commit, properties

Method Details

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.

getWritabilityMode

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setWritabilityMode(ValueOrExpression<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.