org.forgerock.opendj.server.config.client

Interface BackupBackendCfgClient

All Superinterfaces:

BackendCfgClient, ConfigurationClient, LocalBackendCfgClient

public interface BackupBackendCfgClient
extends LocalBackendCfgClient

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

The Backup Backend provides read-only access to the set of backups that are available for OpenDJ.

Method Summary

Modifier and Type	Method and Description
ManagedObjectDefinition<? extends BackupBackendCfgClient,? extends BackupBackendCfg>	definition() Get the configuration definition associated with this Backup Backend.
SortedSet<String>	getBackupDirectory() Gets the "backup-directory" property.
String	getJavaClass() Gets the "java-class" property.
LocalBackendCfgDefn.WritabilityMode	getWritabilityMode() Gets the "writability-mode" property.
void	setBackupDirectory(Collection<String> values) Sets the "backup-directory" 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 BackupBackendCfgClient,? extends BackupBackendCfg> definition()

Get the configuration definition associated with this Backup Backend.

Specified by:

definition in interface BackendCfgClient

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LocalBackendCfgClient

Returns:

Returns the configuration definition associated with this Backup Backend.

getBackupDirectory

SortedSet<String> getBackupDirectory()

Gets the "backup-directory" property.

Specifies the path to a backup directory containing one or more backups for a particular backend.

This is a multivalued property. Each value may specify a different backup directory if desired (one for each backend for which backups are taken). Values may be either absolute paths or paths that are relative to the base of the OpenDJ directory server installation.

Returns:

Returns the values of the "backup-directory" property.

setBackupDirectory

void setBackupDirectory(Collection<String> values)
                 throws PropertyException

Sets the "backup-directory" property.

Specifies the path to a backup directory containing one or more backups for a particular backend.

This is a multivalued property. Each value may specify a different backup directory if desired (one for each backend for which backups are taken). Values may be either absolute paths or paths that are relative to the base of the OpenDJ directory server installation.

Parameters:

values - The values of the "backup-directory" property.

Throws:

PropertyException - If one or more of the new values are 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.

getWritabilityMode

LocalBackendCfgDefn.WritabilityMode getWritabilityMode()

Gets the "writability-mode" property.

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

Specified by:

getWritabilityMode in interface LocalBackendCfgClient

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.

Specified by:

setWritabilityMode in interface LocalBackendCfgClient

Parameters:

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

Throws:

PropertyException - If the new value is invalid.