|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocalDBBackendCfgClient
A client-side interface for reading and modifying Local DB Backend settings.
The Local DB Backend uses the Berkeley DB Java Edition to store user-provided data in a local repository.
Method Summary | ||
---|---|---|
|
createLocalDBIndex(ManagedObjectDefinition<C,? extends LocalDBIndexCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Local DB Index. |
|
|
createLocalDBVLVIndex(ManagedObjectDefinition<C,? extends LocalDBVLVIndexCfg> d,
java.lang.String name,
java.util.Collection<DefaultBehaviorException> exceptions)
Creates a new Local DB VLV Index. |
|
ManagedObjectDefinition<? extends LocalDBBackendCfgClient,? extends LocalDBBackendCfg> |
definition()
Get the configuration definition associated with this Local DB Backend. |
|
int |
getDBCachePercent()
Gets the "db-cache-percent" property. |
|
long |
getDBCacheSize()
Gets the "db-cache-size" property. |
|
long |
getDBCheckpointerBytesInterval()
Gets the "db-checkpointer-bytes-interval" property. |
|
long |
getDBCheckpointerWakeupInterval()
Gets the "db-checkpointer-wakeup-interval" property. |
|
int |
getDBCleanerMinUtilization()
Gets the "db-cleaner-min-utilization" property. |
|
java.lang.String |
getDBDirectory()
Gets the "db-directory" property. |
|
java.lang.String |
getDBDirectoryPermissions()
Gets the "db-directory-permissions" property. |
|
int |
getDBEvictorNodesPerScan()
Gets the "db-evictor-nodes-per-scan" property. |
|
long |
getDBLogFileMax()
Gets the "db-log-file-max" property. |
|
java.lang.String |
getDBLoggingLevel()
Gets the "db-logging-level" property. |
|
int |
getDBNumCleanerThreads()
Gets the "db-num-cleaner-threads" property. |
|
int |
getDBNumLockTables()
Gets the "db-num-lock-tables" property. |
|
int |
getDeadlockRetryLimit()
Gets the "deadlock-retry-limit" property. |
|
int |
getImportQueueSize()
Gets the "import-queue-size" property. |
|
int |
getImportThreadCount()
Gets the "import-thread-count" property. |
|
int |
getIndexEntryLimit()
Gets the "index-entry-limit" property. |
|
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
|
java.util.SortedSet<java.lang.String> |
getJEProperty()
Gets the "je-property" property. |
|
LocalDBIndexCfgClient |
getLocalDBIndex(java.lang.String name)
Gets the named Local DB Index. |
|
LocalDBVLVIndexCfgClient |
getLocalDBVLVIndex(java.lang.String name)
Gets the named Local DB VLV Index. |
|
long |
getPreloadTimeLimit()
Gets the "preload-time-limit" property. |
|
int |
getSubtreeDeleteBatchSize()
Gets the "subtree-delete-batch-size" property. |
|
int |
getSubtreeDeleteSizeLimit()
Gets the "subtree-delete-size-limit" property. |
|
BackendCfgDefn.WritabilityMode |
getWritabilityMode()
Gets the "writability-mode" property. |
|
boolean |
isCompactEncoding()
Gets the "compact-encoding" property. |
|
boolean |
isDBEvictorLruOnly()
Gets the "db-evictor-lru-only" property. |
|
boolean |
isDBLoggingFileHandlerOn()
Gets the "db-logging-file-handler-on" property. |
|
boolean |
isDBRunCleaner()
Gets the "db-run-cleaner" property. |
|
boolean |
isDBTxnNoSync()
Gets the "db-txn-no-sync" property. |
|
boolean |
isDBTxnWriteNoSync()
Gets the "db-txn-write-no-sync" property. |
|
boolean |
isEntriesCompressed()
Gets the "entries-compressed" property. |
|
java.lang.String[] |
listLocalDBIndexes()
Lists the Local DB Indexes. |
|
java.lang.String[] |
listLocalDBVLVIndexes()
Lists the Local DB VLV Indexes. |
|
void |
removeLocalDBIndex(java.lang.String name)
Removes the named Local DB Index. |
|
void |
removeLocalDBVLVIndex(java.lang.String name)
Removes the named Local DB VLV Index. |
|
void |
setCompactEncoding(java.lang.Boolean value)
Sets the "compact-encoding" property. |
|
void |
setDBCachePercent(java.lang.Integer value)
Sets the "db-cache-percent" property. |
|
void |
setDBCacheSize(java.lang.Long value)
Sets the "db-cache-size" property. |
|
void |
setDBCheckpointerBytesInterval(java.lang.Long value)
Sets the "db-checkpointer-bytes-interval" property. |
|
void |
setDBCheckpointerWakeupInterval(java.lang.Long value)
Sets the "db-checkpointer-wakeup-interval" property. |
|
void |
setDBCleanerMinUtilization(java.lang.Integer value)
Sets the "db-cleaner-min-utilization" property. |
|
void |
setDBDirectory(java.lang.String value)
Sets the "db-directory" property. |
|
void |
setDBDirectoryPermissions(java.lang.String value)
Sets the "db-directory-permissions" property. |
|
void |
setDBEvictorLruOnly(java.lang.Boolean value)
Sets the "db-evictor-lru-only" property. |
|
void |
setDBEvictorNodesPerScan(java.lang.Integer value)
Sets the "db-evictor-nodes-per-scan" property. |
|
void |
setDBLogFileMax(java.lang.Long value)
Sets the "db-log-file-max" property. |
|
void |
setDBLoggingFileHandlerOn(java.lang.Boolean value)
Sets the "db-logging-file-handler-on" property. |
|
void |
setDBLoggingLevel(java.lang.String value)
Sets the "db-logging-level" property. |
|
void |
setDBNumCleanerThreads(java.lang.Integer value)
Sets the "db-num-cleaner-threads" property. |
|
void |
setDBNumLockTables(java.lang.Integer value)
Sets the "db-num-lock-tables" property. |
|
void |
setDBRunCleaner(java.lang.Boolean value)
Sets the "db-run-cleaner" property. |
|
void |
setDBTxnNoSync(java.lang.Boolean value)
Sets the "db-txn-no-sync" property. |
|
void |
setDBTxnWriteNoSync(java.lang.Boolean value)
Sets the "db-txn-write-no-sync" property. |
|
void |
setDeadlockRetryLimit(java.lang.Integer value)
Sets the "deadlock-retry-limit" property. |
|
void |
setEntriesCompressed(java.lang.Boolean value)
Sets the "entries-compressed" property. |
|
void |
setImportQueueSize(java.lang.Integer value)
Sets the "import-queue-size" property. |
|
void |
setImportThreadCount(java.lang.Integer value)
Sets the "import-thread-count" property. |
|
void |
setIndexEntryLimit(java.lang.Integer value)
Sets the "index-entry-limit" property. |
|
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
|
void |
setJEProperty(java.util.Collection<java.lang.String> values)
Sets the "je-property" property. |
|
void |
setPreloadTimeLimit(java.lang.Long value)
Sets the "preload-time-limit" property. |
|
void |
setSubtreeDeleteBatchSize(java.lang.Integer value)
Sets the "subtree-delete-batch-size" property. |
|
void |
setSubtreeDeleteSizeLimit(java.lang.Integer value)
Sets the "subtree-delete-size-limit" property. |
|
void |
setWritabilityMode(BackendCfgDefn.WritabilityMode value)
Sets the "writability-mode" property. |
Methods inherited from interface org.opends.server.admin.std.client.BackendCfgClient |
---|
getBackendId, getBaseDN, isEnabled, setBackendId, setBaseDN, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends LocalDBBackendCfgClient,? extends LocalDBBackendCfg> definition()
definition
in interface BackendCfgClient
definition
in interface ConfigurationClient
boolean isCompactEncoding()
Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets.
Note that this property applies only to the entries themselves and does not impact the index data.
void setCompactEncoding(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets.
Note that this property applies only to the entries themselves and does not impact the index data.
value
- The value of the "compact-encoding" property.
IllegalPropertyValueException
- If the new value is invalid.int 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(java.lang.Integer value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- 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(java.lang.Long value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.long getDBCheckpointerBytesInterval()
Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint.
This can be used to bound the recovery time that may be required if the database environment is opened without having been properly closed. If this property is set to a non-zero value, the checkpointer wakeup interval is not used. To use time-based checkpointing, set this property to zero.
void setDBCheckpointerBytesInterval(java.lang.Long value) throws IllegalPropertyValueException
Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint.
This can be used to bound the recovery time that may be required if the database environment is opened without having been properly closed. If this property is set to a non-zero value, the checkpointer wakeup interval is not used. To use time-based checkpointing, set this property to zero.
value
- The value of the "db-checkpointer-bytes-interval" property.
IllegalPropertyValueException
- If the new value is invalid.long getDBCheckpointerWakeupInterval()
Specifies the maximum length of time that may pass between checkpoints.
Note that this is only used if the value of the checkpointer bytes interval is zero.
void setDBCheckpointerWakeupInterval(java.lang.Long value) throws IllegalPropertyValueException
Specifies the maximum length of time that may pass between checkpoints.
Note that this is only used if the value of the checkpointer bytes interval is zero.
value
- The value of the "db-checkpointer-wakeup-interval" property.
IllegalPropertyValueException
- If the new value is invalid.int getDBCleanerMinUtilization()
Specifies the minimum percentage of "live" data that the database cleaner attempts to keep in database log files.
If the amount of live data in any database log file drops below this percentage, then the cleaner moves the remaining live data in that file to the end of the database and deletes the original file in order to keep the database relatively compact.
void setDBCleanerMinUtilization(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the minimum percentage of "live" data that the database cleaner attempts to keep in database log files.
If the amount of live data in any database log file drops below this percentage, then the cleaner moves the remaining live data in that file to the end of the database and deletes the original file in order to keep the database relatively compact.
value
- The value of the "db-cleaner-min-utilization" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getDBDirectory()
Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition 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 OpenDS 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(java.lang.String value) throws IllegalPropertyValueException
Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition 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 OpenDS 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.
IllegalPropertyValueException
- If the new value is invalid.java.lang.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(java.lang.String value) throws IllegalPropertyValueException
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.
IllegalPropertyValueException
- If the new value is invalid.boolean isDBEvictorLruOnly()
Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first).
If set to "false", then the eviction keeps internal nodes of the underlying Btree in the cache over leaf notes, even if the leaf nodes have been accessed more recently. This may be a better configuration for databases in which only a very small portion of the data is cached.
void setDBEvictorLruOnly(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first).
If set to "false", then the eviction keeps internal nodes of the underlying Btree in the cache over leaf notes, even if the leaf nodes have been accessed more recently. This may be a better configuration for databases in which only a very small portion of the data is cached.
value
- The value of the "db-evictor-lru-only" property.
IllegalPropertyValueException
- If the new value is invalid.int getDBEvictorNodesPerScan()
Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information.
Changes to this property do not take effect until the backend is restarted. It is recommended that you also change this property when you set db-evictor-lru-only to false. This setting controls the number of Btree nodes that are considered, or sampled, each time a node is evicted. A setting of 100 often produces good results, but this may vary from application to application. The larger the nodes per scan, the more accurate the algorithm. However, setting it too high is detrimental; the need to consider larger numbers of nodes for each eviction may delay the completion of a given database operation, which will impact the response time of the application thread.
void setDBEvictorNodesPerScan(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information.
Changes to this property do not take effect until the backend is restarted. It is recommended that you also change this property when you set db-evictor-lru-only to false. This setting controls the number of Btree nodes that are considered, or sampled, each time a node is evicted. A setting of 100 often produces good results, but this may vary from application to application. The larger the nodes per scan, the more accurate the algorithm. However, setting it too high is detrimental; the need to consider larger numbers of nodes for each eviction may delay the completion of a given database operation, which will impact the response time of the application thread.
value
- The value of the "db-evictor-nodes-per-scan" property.
IllegalPropertyValueException
- If the new value is invalid.long getDBLogFileMax()
Specifies the maximum size for a database log file.
void setDBLogFileMax(java.lang.Long value) throws IllegalPropertyValueException
Specifies the maximum size for a database log file.
value
- The value of the "db-log-file-max" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isDBLoggingFileHandlerOn()
Indicates whether the database should maintain a je.info file in the same directory as the database log directory.
This file contains information about the internal processing performed by the underlying database.
void setDBLoggingFileHandlerOn(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the database should maintain a je.info file in the same directory as the database log directory.
This file contains information about the internal processing performed by the underlying database.
value
- The value of the "db-logging-file-handler-on" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getDBLoggingLevel()
Specifies the log level that should be used by the database when it is writing information into the je.info file.
The database trace logging level is (in increasing order of verbosity) chosen from: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL.
void setDBLoggingLevel(java.lang.String value) throws IllegalPropertyValueException
Specifies the log level that should be used by the database when it is writing information into the je.info file.
The database trace logging level is (in increasing order of verbosity) chosen from: OFF, SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL.
value
- The value of the "db-logging-level" property.
IllegalPropertyValueException
- If the new value is invalid.int getDBNumCleanerThreads()
Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization.
In environments with high write throughput, multiple cleaner threads may be required to maintain the desired utilization.
void setDBNumCleanerThreads(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization.
In environments with high write throughput, multiple cleaner threads may be required to maintain the desired utilization.
value
- The value of the "db-num-cleaner-threads" property.
IllegalPropertyValueException
- If the new value is invalid.int getDBNumLockTables()
Specifies the number of lock tables that are used by the underlying database.
This can be particularly important to help improve scalability by avoiding contention on systems with large numbers of CPUs. The value of this configuration property should be set to a prime number that is less than or equal to the number of worker threads configured for use in the server.
void setDBNumLockTables(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the number of lock tables that are used by the underlying database.
This can be particularly important to help improve scalability by avoiding contention on systems with large numbers of CPUs. The value of this configuration property should be set to a prime number that is less than or equal to the number of worker threads configured for use in the server.
value
- The value of the "db-num-lock-tables" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isDBRunCleaner()
Indicates whether the database cleaner threads should be enabled.
The cleaner threads are used to periodically compact the database by identifying database files with a low (that is, less than the amount specified by the db-cleaner-min-utilization property) percentage of live data, moving the remaining live data to the end of the log and deleting that file.
void setDBRunCleaner(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the database cleaner threads should be enabled.
The cleaner threads are used to periodically compact the database by identifying database files with a low (that is, less than the amount specified by the db-cleaner-min-utilization property) percentage of live data, moving the remaining live data to the end of the log and deleting that file.
value
- The value of the "db-run-cleaner" property.
IllegalPropertyValueException
- 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 OpenDS 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(java.lang.Boolean value) throws IllegalPropertyValueException
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 OpenDS 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.
IllegalPropertyValueException
- If the new value is invalid.boolean isDBTxnWriteNoSync()
Indicates whether the database should synchronously flush data as it is written to disk.
If this value is set to "false", then all data written to disk is synchronously flushed to persistent storage and thereby providing full durability. If it is set to "true", then data may be cached for a period of time by the underlying operating system before actually being written to disk. This may improve performance, but could cause the most recent changes to be lost in the event of an underlying OS or hardware failure (but not in the case that the OpenDS Directory Server or the JVM exits abnormally).
void setDBTxnWriteNoSync(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the database should synchronously flush data as it is written to disk.
If this value is set to "false", then all data written to disk is synchronously flushed to persistent storage and thereby providing full durability. If it is set to "true", then data may be cached for a period of time by the underlying operating system before actually being written to disk. This may improve performance, but could cause the most recent changes to be lost in the event of an underlying OS or hardware failure (but not in the case that the OpenDS Directory Server or the JVM exits abnormally).
value
- The value of the "db-txn-write-no-sync" property.
IllegalPropertyValueException
- If the new value is invalid.int getDeadlockRetryLimit()
Specifies the number of times that the server should retry an attempted operation in the backend if a deadlock results from two concurrent requests that interfere with each other in a conflicting manner.
A value of "0" indicates no limit.
void setDeadlockRetryLimit(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the number of times that the server should retry an attempted operation in the backend if a deadlock results from two concurrent requests that interfere with each other in a conflicting manner.
A value of "0" indicates no limit.
value
- The value of the "deadlock-retry-limit" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isEntriesCompressed()
Indicates whether the backend should attempt to compress entries before storing them in the database.
Note that this property applies only to the entries themselves and does not impact the index data. Further, the effectiveness of the compression is based on the type of data contained in the entry.
void setEntriesCompressed(java.lang.Boolean value) throws IllegalPropertyValueException
Indicates whether the backend should attempt to compress entries before storing them in the database.
Note that this property applies only to the entries themselves and does not impact the index data. Further, the effectiveness of the compression is based on the type of data contained in the entry.
value
- The value of the "entries-compressed" property.
IllegalPropertyValueException
- If the new value is invalid.int getImportQueueSize()
Specifies the size (in number of entries) of the queue that is used to hold the entries read during an LDIF import.
void setImportQueueSize(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the size (in number of entries) of the queue that is used to hold the entries read during an LDIF import.
value
- The value of the "import-queue-size" property.
IllegalPropertyValueException
- If the new value is invalid.int getImportThreadCount()
Specifies the number of threads that is used for concurrent processing during an LDIF import.
This should generally be a small multiple (for example, 2x) of the number of CPUs in the system for a traditional system, or equal to the number of CPU strands for a CMT system.
void setImportThreadCount(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the number of threads that is used for concurrent processing during an LDIF import.
This should generally be a small multiple (for example, 2x) of the number of CPUs in the system for a traditional system, or equal to the number of CPU strands for a CMT system.
value
- The value of the "import-thread-count" property.
IllegalPropertyValueException
- If the new value is invalid.int getIndexEntryLimit()
Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained.
This property is analogous to the ALL IDs threshold in the Sun Java System Directory Server. Note that this is the default limit for the backend, and it may be overridden on a per-attribute basis.A value of 0 means there is no limit.
void setIndexEntryLimit(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained.
This property is analogous to the ALL IDs threshold in the Sun Java System Directory Server. Note that this is the default limit for the backend, and it may be overridden on a per-attribute basis.A value of 0 means there is no limit.
value
- The value of the "index-entry-limit" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
getJavaClass
in interface BackendCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the backend implementation.
setJavaClass
in interface BackendCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getJEProperty()
Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to OpenDS documentation for further information on related properties, their implications, and range values. The definitive identification of all the property parameters is available in the example.properties file of Berkeley DB Java Edition distribution.
void setJEProperty(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend.
Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to OpenDS documentation for further information on related properties, their implications, and range values. The definitive identification of all the property parameters is available in the example.properties file of Berkeley DB Java Edition distribution.
values
- The values of the "je-property" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.long getPreloadTimeLimit()
Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized.
The pre-load process is used to pre-populate the database cache, so that it can be more quickly available when the server is processing requests. A duration of zero means there is no pre-load.
void setPreloadTimeLimit(java.lang.Long value) throws IllegalPropertyValueException
Specifies the length of time that the backend is allowed to spend "pre-loading" data when it is initialized.
The pre-load process is used to pre-populate the database cache, so that it can be more quickly available when the server is processing requests. A duration of zero means there is no pre-load.
value
- The value of the "preload-time-limit" property.
IllegalPropertyValueException
- If the new value is invalid.int getSubtreeDeleteBatchSize()
Specifies the maximum number of entries that may be deleted from the backend when using the subtree delete control within a single transaction.
If a subtree delete operation targets a subtree with more than this number of entries, then additional transactions are used to remove the remaining entries in that subtree.
void setSubtreeDeleteBatchSize(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the maximum number of entries that may be deleted from the backend when using the subtree delete control within a single transaction.
If a subtree delete operation targets a subtree with more than this number of entries, then additional transactions are used to remove the remaining entries in that subtree.
value
- The value of the "subtree-delete-batch-size" property.
IllegalPropertyValueException
- If the new value is invalid.int getSubtreeDeleteSizeLimit()
Specifies the maximum number of entries that may be deleted from the backend when using the subtree delete control.
If a subtree delete operation targets a subtree with more than this number of entries, then multiple passes may be required to remove all entries in that subtree.
void setSubtreeDeleteSizeLimit(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the maximum number of entries that may be deleted from the backend when using the subtree delete control.
If a subtree delete operation targets a subtree with more than this number of entries, then multiple passes may be required to remove all entries in that subtree.
value
- The value of the "subtree-delete-size-limit" property.
IllegalPropertyValueException
- If the new value is invalid.BackendCfgDefn.WritabilityMode getWritabilityMode()
Specifies the behavior that the backend should use when processing write operations.
getWritabilityMode
in interface BackendCfgClient
void setWritabilityMode(BackendCfgDefn.WritabilityMode value) throws IllegalPropertyValueException
Specifies the behavior that the backend should use when processing write operations.
setWritabilityMode
in interface BackendCfgClient
value
- The value of the "writability-mode" property.
IllegalPropertyValueException
- If the new value is invalid.java.lang.String[] listLocalDBIndexes() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to list the Local DB Indexes
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.LocalDBIndexCfgClient getLocalDBIndex(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Local DB Index to retrieve.
DefinitionDecodingException
- If the named Local DB Index was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Local DB Index was found but one or more
of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Local DB Index was not found on the
server.
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to retrieve the named Local DB
Index because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends LocalDBIndexCfgClient> C createLocalDBIndex(ManagedObjectDefinition<C,? extends LocalDBIndexCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Local DB Index being created.d
- The definition of the Local DB Index to be created.name
- The name of the new Local DB Index.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Local
DB Index. This argument can be null.
- Returns:
- Returns a new Local DB Index configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Local DB Index is invalid.
void removeLocalDBIndex(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Local DB Index to remove.
ManagedObjectNotFoundException
- If the Local DB Index does not exist.
OperationRejectedException
- If the server refuses to remove the Local DB Index due
to some server-side constraint which cannot be satisfied
(for example, if it is referenced by another managed
object).
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to remove the Local DB Index
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.java.lang.String[] listLocalDBVLVIndexes() throws ConcurrentModificationException, AuthorizationException, CommunicationException
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to list the Local DB VLV Indexes
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.LocalDBVLVIndexCfgClient getLocalDBVLVIndex(java.lang.String name) throws DefinitionDecodingException, ManagedObjectDecodingException, ManagedObjectNotFoundException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Local DB VLV Index to retrieve.
DefinitionDecodingException
- If the named Local DB VLV Index was found but its type
could not be determined.
ManagedObjectDecodingException
- If the named Local DB VLV Index was found but one or
more of its properties could not be decoded.
ManagedObjectNotFoundException
- If the named Local DB VLV Index was not found on the
server.
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to retrieve the named Local DB
VLV Index because the client does not have the correct
privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.<C extends LocalDBVLVIndexCfgClient> C createLocalDBVLVIndex(ManagedObjectDefinition<C,? extends LocalDBVLVIndexCfg> d, java.lang.String name, java.util.Collection<DefaultBehaviorException> exceptions) throws IllegalManagedObjectNameException
ConfigurationClient.commit()
method.
C
- The type of the Local DB VLV Index being created.d
- The definition of the Local DB VLV Index to be created.name
- The name of the new Local DB VLV Index.exceptions
- An optional collection in which to place any DefaultBehaviorException
s that occurred whilst
attempting to determine the default values of the Local
DB VLV Index. This argument can be null.
- Returns:
- Returns a new Local DB VLV Index configuration instance.
- Throws:
IllegalManagedObjectNameException
- If the name of the new Local DB VLV Index is invalid.
void removeLocalDBVLVIndex(java.lang.String name) throws ManagedObjectNotFoundException, OperationRejectedException, ConcurrentModificationException, AuthorizationException, CommunicationException
name
- The name of the Local DB VLV Index to remove.
ManagedObjectNotFoundException
- If the Local DB VLV Index does not exist.
OperationRejectedException
- If the server refuses to remove the Local DB VLV Index
due to some server-side constraint which cannot be
satisfied (for example, if it is referenced by another
managed object).
ConcurrentModificationException
- If this Local DB Backend has been removed from the
server by another client.
AuthorizationException
- If the server refuses to remove the Local DB VLV Index
because the client does not have the correct privileges.
CommunicationException
- If the client cannot contact the server due to an
underlying communication problem.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |