public interface PDBBackendCfgClient extends PluggableBackendCfgClient
A PDB Backend stores application data in a Persistit database.
| Modifier and Type | Method and Description |
|---|---|
ManagedObjectDefinition<? extends PDBBackendCfgClient,? extends PDBBackendCfg> |
definition()
Get the configuration definition associated with this PDB Backend.
|
int |
getDBCachePercent()
Gets the "db-cache-percent" property.
|
long |
getDBCacheSize()
Gets the "db-cache-size" property.
|
long |
getDBCheckpointerWakeupInterval()
Gets the "db-checkpointer-wakeup-interval" property.
|
String |
getDBDirectory()
Gets the "db-directory" property.
|
String |
getDBDirectoryPermissions()
Gets the "db-directory-permissions" property.
|
long |
getDiskFullThreshold()
Gets the "disk-full-threshold" property.
|
long |
getDiskLowThreshold()
Gets the "disk-low-threshold" property.
|
String |
getJavaClass()
Gets the "java-class" property.
|
boolean |
isDBTxnNoSync()
Gets the "db-txn-no-sync" property.
|
void |
setDBCachePercent(Integer value)
Sets the "db-cache-percent" property.
|
void |
setDBCacheSize(Long value)
Sets the "db-cache-size" property.
|
void |
setDBCheckpointerWakeupInterval(Long value)
Sets the "db-checkpointer-wakeup-interval" property.
|
void |
setDBDirectory(String value)
Sets the "db-directory" property.
|
void |
setDBDirectoryPermissions(String value)
Sets the "db-directory-permissions" property.
|
void |
setDBTxnNoSync(Boolean value)
Sets the "db-txn-no-sync" property.
|
void |
setDiskFullThreshold(Long value)
Sets the "disk-full-threshold" property.
|
void |
setDiskLowThreshold(Long value)
Sets the "disk-low-threshold" property.
|
void |
setJavaClass(String value)
Sets the "java-class" property.
|
createBackendIndex, createBackendVLVIndex, getBackendIndex, getBackendVLVIndex, getIndexEntryLimit, getIndexFilterAnalyzerMaxFilters, getPreloadTimeLimit, getWritabilityMode, isCompactEncoding, isEntriesCompressed, isIndexFilterAnalyzerEnabled, listBackendIndexes, listBackendVLVIndexes, removeBackendIndex, removeBackendVLVIndex, setCompactEncoding, setEntriesCompressed, setIndexEntryLimit, setIndexFilterAnalyzerEnabled, setIndexFilterAnalyzerMaxFilters, setPreloadTimeLimit, setWritabilityModegetBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabledcommit, propertiesManagedObjectDefinition<? extends PDBBackendCfgClient,? extends PDBBackendCfg> definition()
definition in interface BackendCfgClientdefinition in interface ConfigurationClientdefinition in interface PluggableBackendCfgClientint getDBCachePercent()
Specifies the percentage of JVM memory to allocate to the database cache.
Specifies the percentage of memory available to the JVM that should be used for caching database contents. Note that this is only used if the value of the db-cache-size property is set to "0 MB". Otherwise, the value of that property is used instead to control the cache size configuration.
void setDBCachePercent(Integer value) throws PropertyException
Specifies the percentage of JVM memory to allocate to the database cache.
Specifies the percentage of memory available to the JVM that should be used for caching database contents. Note that this is only used if the value of the db-cache-size property is set to "0 MB". Otherwise, the value of that property is used instead to control the cache size configuration.
value - The value of the "db-cache-percent" property.PropertyException - If the new value is invalid.long getDBCacheSize()
The amount of JVM memory to allocate to the database cache.
Specifies the amount of memory that should be used for caching database contents. A value of "0 MB" indicates that the db-cache-percent property should be used instead to specify the cache size.
void setDBCacheSize(Long value) throws PropertyException
The amount of JVM memory to allocate to the database cache.
Specifies the amount of memory that should be used for caching database contents. A value of "0 MB" indicates that the db-cache-percent property should be used instead to specify the cache size.
value - The value of the "db-cache-size" property.PropertyException - If the new value is invalid.long getDBCheckpointerWakeupInterval()
Specifies the maximum length of time that may pass between checkpoints.
This setting controls the elapsed time between attempts to write a checkpoint to the journal. A longer interval allows more updates to accumulate in buffers before they are required to be written to disk, but also potentially causes recovery from an abrupt termination (crash) to take more time.
void setDBCheckpointerWakeupInterval(Long value) throws PropertyException
Specifies the maximum length of time that may pass between checkpoints.
This setting controls the elapsed time between attempts to write a checkpoint to the journal. A longer interval allows more updates to accumulate in buffers before they are required to be written to disk, but also potentially causes recovery from an abrupt termination (crash) to take more time.
value - The value of the "db-checkpointer-wakeup-interval" property.PropertyException - If the new value is invalid.String getDBDirectory()
Specifies the path to the filesystem directory that is used to hold the Persistit database files containing the data for this backend.
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.
void setDBDirectory(String value) throws PropertyException
Specifies the path to the filesystem directory that is used to hold the Persistit database files containing the data for this backend.
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.
value - The value of the "db-directory" property.PropertyException - If the new value is invalid.String getDBDirectoryPermissions()
Specifies the permissions that should be applied to the directory containing the server database files.
They should be expressed as three-digit octal values, which is the traditional representation for UNIX file permissions. The three digits represent the permissions that are available for the directory's owner, group members, and other users (in that order), and each digit is the octal representation of the read, write, and execute bits. Note that this only impacts permissions on the database directory and not on the files written into that directory. On UNIX systems, the user's umask controls permissions given to the database files.
void setDBDirectoryPermissions(String value) throws PropertyException
Specifies the permissions that should be applied to the directory containing the server database files.
They should be expressed as three-digit octal values, which is the traditional representation for UNIX file permissions. The three digits represent the permissions that are available for the directory's owner, group members, and other users (in that order), and each digit is the octal representation of the read, write, and execute bits. Note that this only impacts permissions on the database directory and not on the files written into that directory. On UNIX systems, the user's umask controls permissions given to the database files.
value - The value of the "db-directory-permissions" property.PropertyException - If the new value is invalid.boolean isDBTxnNoSync()
Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk.
Setting the value of this configuration attribute to "true" may improve write performance but could cause the most recent changes to be lost if the OpenDJ directory server or the underlying JVM exits abnormally, or if an OS or hardware failure occurs (a behavior similar to running with transaction durability disabled in the Sun Java System Directory Server).
void setDBTxnNoSync(Boolean value) throws PropertyException
Indicates whether database writes should be primarily written to an internal buffer but not immediately written to disk.
Setting the value of this configuration attribute to "true" may improve write performance but could cause the most recent changes to be lost if the OpenDJ directory server or the underlying JVM exits abnormally, or if an OS or hardware failure occurs (a behavior similar to running with transaction durability disabled in the Sun Java System Directory Server).
value - The value of the "db-txn-no-sync" property.PropertyException - If the new value is invalid.long getDiskFullThreshold()
Full disk threshold to limit database updates
When the available free space on the disk used by this database instance falls below the value specified, no updates are permitted and the server returns an UNWILLING_TO_PERFORM error. Updates are allowed again as soon as free space rises above the threshold.
void setDiskFullThreshold(Long value) throws PropertyException
Full disk threshold to limit database updates
When the available free space on the disk used by this database instance falls below the value specified, no updates are permitted and the server returns an UNWILLING_TO_PERFORM error. Updates are allowed again as soon as free space rises above the threshold.
value - The value of the "disk-full-threshold" property.PropertyException - If the new value is invalid.long getDiskLowThreshold()
Low disk threshold to limit database updates
Specifies the "low" free space on the disk. When the available free space on the disk used by this database instance falls below the value specified, protocol updates on this database are permitted only by a user with the BYPASS_LOCKDOWN privilege.
void setDiskLowThreshold(Long value) throws PropertyException
Low disk threshold to limit database updates
Specifies the "low" free space on the disk. When the available free space on the disk used by this database instance falls below the value specified, protocol updates on this database are permitted only by a user with the BYPASS_LOCKDOWN privilege.
value - The value of the "disk-low-threshold" property.PropertyException - If the new value is invalid.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass in interface BackendCfgClientvoid setJavaClass(String value) throws PropertyException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass in interface BackendCfgClientvalue - The value of the "java-class" property.PropertyException - If the new value is invalid.Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.