Interface BackupBackendCfg
-
- All Superinterfaces:
BackendCfg,Configuration,LocalBackendCfg
public interface BackupBackendCfg extends LocalBackendCfg
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 OpenDJ.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)Register to be notified when this Backup Backend is changed.Class<? extends BackupBackendCfg>configurationClass()Gets the configuration class associated with this Backup Backend.SortedSet<String>getBackupDirectory()Gets the "backup-directory" property.StringgetJavaClass()Gets the "java-class" property.LocalBackendCfgDefn.WritabilityModegetWritabilityMode()Gets the "writability-mode" property.voidremoveBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener)Deregister an existing Backup Backend configuration change listener.-
Methods inherited from interface org.forgerock.opendj.server.config.server.BackendCfg
addChangeListener, getBackendId, getBaseDN, isEnabled, removeChangeListener
-
Methods inherited from interface org.forgerock.opendj.config.Configuration
dn, name
-
Methods inherited from interface org.forgerock.opendj.server.config.server.LocalBackendCfg
addLocalChangeListener, removeLocalChangeListener
-
-
-
-
Method Detail
-
configurationClass
Class<? extends BackupBackendCfg> configurationClass()
Gets the configuration class associated with this Backup Backend.- Specified by:
configurationClassin interfaceBackendCfg- Specified by:
configurationClassin interfaceConfiguration- Specified by:
configurationClassin interfaceLocalBackendCfg- 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
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 an unmodifiable set containing the values of the "backup-directory" property.
-
getJavaClass
String getJavaClass()
Gets the "java-class" property.Specifies the fully-qualified name of the Java class that provides the backend implementation.
- Specified by:
getJavaClassin interfaceBackendCfg- Specified by:
getJavaClassin interfaceLocalBackendCfg- Returns:
- Returns the value of the "java-class" property.
-
getWritabilityMode
LocalBackendCfgDefn.WritabilityMode getWritabilityMode()
Gets the "writability-mode" property.Specifies the behavior that the backend should use when processing write operations.
- Specified by:
getWritabilityModein interfaceLocalBackendCfg- Returns:
- Returns the value of the "writability-mode" property.
-
-