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

Interface CASBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient, LocalBackendCfgClient, PluggableBackendCfgClient

public interface CASBackendCfgClient
extends PluggableBackendCfgClient

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

A CAS Backend stores application data in a Apache Cassandra cluster.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends CASBackendCfgClient,? extends CASBackendCfg>	definition()	Get the configuration definition associated with this CAS Backend.
String	getDBDirectory()	Gets the "db-directory" property.
String	getJavaClass()	Gets the "java-class" property.
void	setDBDirectory(String value)	Sets the "db-directory" property.
void	setJavaClass(String value)	Sets the "java-class" 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

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

createBackendIndex, createBackendVLVIndex, getBackendIndex, getBackendVLVIndex, getCipherKeyLength, getCipherTransformation, getImportOffheapMemorySize, getIndexEntryLimit, getIndexFilterAnalyzerMaxFilters, getPreloadTimeLimit, getWritabilityMode, isCompactEncoding, isConfidentialityEnabled, isEntriesCompressed, isIndexFilterAnalyzerEnabled, listBackendIndexes, listBackendVLVIndexes, removeBackendIndex, removeBackendVLVIndex, setCipherKeyLength, setCipherTransformation, setCompactEncoding, setConfidentialityEnabled, setEntriesCompressed, setImportOffheapMemorySize, setIndexEntryLimit, setIndexFilterAnalyzerEnabled, setIndexFilterAnalyzerMaxFilters, setPreloadTimeLimit, setWritabilityMode

Method Detail

definition

ManagedObjectDefinition<? extends CASBackendCfgClient,? extends CASBackendCfg> definition()

Get the configuration definition associated with this CAS Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LocalBackendCfgClient

Specified by:

definition in interface PluggableBackendCfgClient

Returns:

Returns the configuration definition associated with this CAS Backend.

getDBDirectory

String getDBDirectory()

Gets the "db-directory" property.

Specifies the keyspace name

The path may be either an absolute path or a path relative to the directory containing the base of the OpenDJ directory server installation. The path may be any valid directory path in which the server has appropriate permissions to read and write files and has sufficient space to hold the database contents.

Returns:

Returns the value of the "db-directory" property.

setDBDirectory

void setDBDirectory(String value)
             throws PropertyException

Sets the "db-directory" property.

Specifies the keyspace name

The path may be either an absolute path or a path relative to the directory containing the base of the OpenDJ directory server installation. The path may be any valid directory path in which the server has appropriate permissions to read and write files and has sufficient space to hold the database contents.

Parameters:

value - The value of the "db-directory" property.

Throws:

PropertyException - If the new value is invalid.

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.