org.opends.server.admin.std.server
Interface BackupBackendCfg

All Superinterfaces:
BackendCfg, Configuration

public interface BackupBackendCfg
extends BackendCfg

A server-side interface for querying Backup Backend settings.

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


Method Summary
 void addBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)
          Register to be notified when this Backup Backend is changed.
 java.lang.Class<? extends BackupBackendCfg> configurationClass()
          Gets the configuration class associated with this Backup Backend.
 java.util.SortedSet<java.lang.String> getBackupDirectory()
          Gets the "backup-directory" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 BackendCfgDefn.WritabilityMode getWritabilityMode()
          Gets the "writability-mode" property.
 void removeBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)
          Deregister an existing Backup Backend configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.BackendCfg
addChangeListener, getBackendId, getBaseDN, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends BackupBackendCfg> configurationClass()
Gets the configuration class associated with this Backup Backend.

Specified by:
configurationClass in interface BackendCfg
Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Backup Backend.

addBackupChangeListener

void addBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)
Register to be notified when this Backup Backend is changed.

Parameters:
listener - The Backup Backend configuration change listener.

removeBackupChangeListener

void removeBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)
Deregister an existing Backup Backend configuration change listener.

Parameters:
listener - The Backup Backend configuration change listener.

getBackupDirectory

java.util.SortedSet<java.lang.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 OpenDS Directory Server installation.

Returns:
Returns an unmodifiable set containing the values of the "backup-directory" property.

getJavaClass

java.lang.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 BackendCfg
Returns:
Returns the value of the "java-class" property.

getWritabilityMode

BackendCfgDefn.WritabilityMode getWritabilityMode()
Gets the "writability-mode" property.

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

Specified by:
getWritabilityMode in interface BackendCfg
Returns:
Returns the value of the "writability-mode" property.