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

Interface BackendCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

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

public interface BackendCfgClient
extends ConfigurationClient

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

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

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg>	definition()	Get the configuration definition associated with this Backend.
ValueOrExpression<String>	getBackendId()	Gets the "backend-id" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Boolean>	isEnabled()	Gets the "enabled" property.
void	setBackendId(ValueOrExpression<String> value)	Sets the "backend-id" property.
void	setEnabled(ValueOrExpression<Boolean> value)	Sets the "enabled" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends BackendCfgClient,? extends BackendCfg> definition()

Get the configuration definition associated with this Backend.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Backend.

getBackendId

@MandatoryProperty
ValueOrExpression<String> getBackendId()

Gets the "backend-id" property.

Specifies a name to identify the associated backend.

The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.

Returns:

Returns the value of the "backend-id" property.

setBackendId

@MandatoryProperty
void setBackendId(ValueOrExpression<String> value)
           throws PropertyException,
                  PropertyException

Sets the "backend-id" property.

Specifies a name to identify the associated backend.

The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.

This property is read-only and can only be modified during creation of a Backend.

Parameters:

value - The value of the "backend-id" property.

Throws:

PropertyException - If the new value is invalid.

PropertyException - If this Backend is not being initialized.

isEnabled

@MandatoryProperty
ValueOrExpression<Boolean> isEnabled()

Gets the "enabled" property.

Indicates whether the backend is enabled in the server.

If a backend is not enabled, then its contents are not accessible when processing operations.

Returns:

Returns the value of the "enabled" property.

setEnabled

@MandatoryProperty
void setEnabled(ValueOrExpression<Boolean> value)
         throws PropertyException

Sets the "enabled" property.

Indicates whether the backend is enabled in the server.

If a backend is not enabled, then its contents are not accessible when processing operations.

Parameters:

value - The value of the "enabled" property.

Throws:

PropertyException - If the new value is invalid.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Returns:

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

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.