Package org.forgerock.opendj.server.config.client

Interface JeBackendCfgClient

All Superinterfaces:
BackendCfgClient, ConfigurationClient, LocalBackendCfgClient, PluggableBackendCfgClient
public interface JeBackendCfgClient extends PluggableBackendCfgClient
A client-side interface for reading and modifying JE Backend settings.

A JE Backend stores application data in a Berkeley DB Java Edition database.

  • Method Details

    • definition

      ManagedObjectDefinition<? extends JeBackendCfgClient,? extends JeBackendCfg> definition()
      Get the configuration definition associated with this JE Backend.
      Specified by:
      definition in interface BackendCfgClient
      Specified by:
      definition in interface ConfigurationClient
      Specified by:
      definition in interface LocalBackendCfgClient
      Specified by:
      definition in interface PluggableBackendCfgClient
      Returns:
      Returns the configuration definition associated with this JE Backend.

    • getDbCacheMode

      ValueOrExpression<JeBackendCfgDefn.DbCacheMode> getDbCacheMode()
      Gets the "db-cache-mode" property.

      The strategy that will be used for caching database content in memory.

      Specifies whether the database heap cache should keep only internal nodes or both internal and leaf nodes.

      Default value: cache-ln

      Returns:
      Returns the value of the "db-cache-mode" property.

    • setDbCacheMode

      void setDbCacheMode(ValueOrExpression<JeBackendCfgDefn.DbCacheMode> value) throws PropertyException
      Sets the "db-cache-mode" property.

      The strategy that will be used for caching database content in memory.

      Specifies whether the database heap cache should keep only internal nodes or both internal and leaf nodes.

      Parameters:
      value - The value of the "db-cache-mode" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbCachePercent

      ValueOrExpression<Integer> getDbCachePercent()
      Gets the "db-cache-percent" property.

      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. Note also that this option is ignored if the global option je-backend-shared-cache-enabled is true.

      Default value: 50

      Returns:
      Returns the value of the "db-cache-percent" property.

    • setDbCachePercent

      void setDbCachePercent(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-cache-percent" property.

      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. Note also that this option is ignored if the global option je-backend-shared-cache-enabled is true.

      Parameters:
      value - The value of the "db-cache-percent" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbCacheSize

      ValueOrExpression<Long> getDbCacheSize()
      Gets the "db-cache-size" property.

      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. Note also that this option is ignored if the global option je-backend-shared-cache-enabled is true.

      Default value: 0 MB

      Returns:
      Returns the value of the "db-cache-size" property.

    • setDbCacheSize

      void setDbCacheSize(ValueOrExpression<Long> value) throws PropertyException
      Sets the "db-cache-size" property.

      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. Note also that this option is ignored if the global option je-backend-shared-cache-enabled is true.

      Parameters:
      value - The value of the "db-cache-size" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbCheckpointerBytesInterval

      ValueOrExpression<Long> getDbCheckpointerBytesInterval()
      Gets the "db-checkpointer-bytes-interval" property.

      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.

      Default value: 500mb

      Returns:
      Returns the value of the "db-checkpointer-bytes-interval" property.

    • setDbCheckpointerBytesInterval

      void setDbCheckpointerBytesInterval(ValueOrExpression<Long> value) throws PropertyException
      Sets the "db-checkpointer-bytes-interval" property.

      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.

      Parameters:
      value - The value of the "db-checkpointer-bytes-interval" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbCheckpointerWakeupInterval

      ValueOrExpression<Long> getDbCheckpointerWakeupInterval()
      Gets the "db-checkpointer-wakeup-interval" property.

      Specifies the maximum length of time that may pass between checkpoints, when there are updates to the database.

      Note that this is only used if the value of the checkpointer bytes interval is zero.

      Default value: 30s

      Returns:
      Returns the value of the "db-checkpointer-wakeup-interval" property.

    • setDbCheckpointerWakeupInterval

      void setDbCheckpointerWakeupInterval(ValueOrExpression<Long> value) throws PropertyException
      Sets the "db-checkpointer-wakeup-interval" property.

      Specifies the maximum length of time that may pass between checkpoints, when there are updates to the database.

      Note that this is only used if the value of the checkpointer bytes interval is zero.

      Parameters:
      value - The value of the "db-checkpointer-wakeup-interval" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbCleanerMinUtilization

      ValueOrExpression<Integer> getDbCleanerMinUtilization()
      Gets the "db-cleaner-min-utilization" property.

      Specifies the occupancy percentage for "live" data in this backend's database.

      When the amount of "live" data in the database drops below this value, cleaners will act to increase the occupancy percentage by compacting the database.

      Default value: 50

      Returns:
      Returns the value of the "db-cleaner-min-utilization" property.

    • setDbCleanerMinUtilization

      void setDbCleanerMinUtilization(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-cleaner-min-utilization" property.

      Specifies the occupancy percentage for "live" data in this backend's database.

      When the amount of "live" data in the database drops below this value, cleaners will act to increase the occupancy percentage by compacting the database.

      Parameters:
      value - The value of the "db-cleaner-min-utilization" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbDirectory

      @MandatoryProperty ValueOrExpression<String> getDbDirectory()
      Gets the "db-directory" property.

      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 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.

      Default value: db

      Returns:
      Returns the value of the "db-directory" property.

    • setDbDirectory

      @MandatoryProperty void setDbDirectory(ValueOrExpression<String> value) throws PropertyException
      Sets the "db-directory" property.

      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 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.

      Parameters:
      value - The value of the "db-directory" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbDirectoryPermissions

      ValueOrExpression<String> getDbDirectoryPermissions()
      Gets the "db-directory-permissions" property.

      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.

      Default value: 700

      Returns:
      Returns the value of the "db-directory-permissions" property.

    • setDbDirectoryPermissions

      void setDbDirectoryPermissions(ValueOrExpression<String> value) throws PropertyException
      Sets the "db-directory-permissions" property.

      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.

      Parameters:
      value - The value of the "db-directory-permissions" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbDurability

      ValueOrExpression<JeBackendCfgDefn.DbDurability> getDbDurability()
      Gets the "db-durability" property.

      Configures the durability level that will be used when committing a transaction.

      High levels of durability offer a greater guarantee that the transaction is persisted to disk, but trade that off for lower performance.

      Default value: medium

      Returns:
      Returns the value of the "db-durability" property.

    • setDbDurability

      void setDbDurability(ValueOrExpression<JeBackendCfgDefn.DbDurability> value) throws PropertyException
      Sets the "db-durability" property.

      Configures the durability level that will be used when committing a transaction.

      High levels of durability offer a greater guarantee that the transaction is persisted to disk, but trade that off for lower performance.

      Parameters:
      value - The value of the "db-durability" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbEvictorCoreThreads

      ValueOrExpression<Integer> getDbEvictorCoreThreads()
      Gets the "db-evictor-core-threads" property.

      Specifies the core number of threads in the eviction thread pool.

      Specifies the core number of threads in the eviction thread pool. These threads help keep memory usage within cache bounds, offloading work from application threads. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Default value: 1

      Returns:
      Returns the value of the "db-evictor-core-threads" property.

    • setDbEvictorCoreThreads

      void setDbEvictorCoreThreads(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-evictor-core-threads" property.

      Specifies the core number of threads in the eviction thread pool.

      Specifies the core number of threads in the eviction thread pool. These threads help keep memory usage within cache bounds, offloading work from application threads. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Parameters:
      value - The value of the "db-evictor-core-threads" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbEvictorKeepAlive

      ValueOrExpression<Long> getDbEvictorKeepAlive()
      Gets the "db-evictor-keep-alive" property.

      The duration that excess threads in the eviction thread pool will stay idle. After this period, idle threads will terminate.

      The duration that excess threads in the eviction thread pool will stay idle. After this period, idle threads will terminate. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Default value: 600s

      Returns:
      Returns the value of the "db-evictor-keep-alive" property.

    • setDbEvictorKeepAlive

      void setDbEvictorKeepAlive(ValueOrExpression<Long> value) throws PropertyException
      Sets the "db-evictor-keep-alive" property.

      The duration that excess threads in the eviction thread pool will stay idle. After this period, idle threads will terminate.

      The duration that excess threads in the eviction thread pool will stay idle. After this period, idle threads will terminate. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Parameters:
      value - The value of the "db-evictor-keep-alive" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbEvictorMaxThreads

      ValueOrExpression<Integer> getDbEvictorMaxThreads()
      Gets the "db-evictor-max-threads" property.

      Specifies the maximum number of threads in the eviction thread pool.

      Specifies the maximum number of threads in the eviction thread pool. These threads help keep memory usage within cache bounds, offloading work from application threads. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Default value: 10

      Returns:
      Returns the value of the "db-evictor-max-threads" property.

    • setDbEvictorMaxThreads

      void setDbEvictorMaxThreads(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-evictor-max-threads" property.

      Specifies the maximum number of threads in the eviction thread pool.

      Specifies the maximum number of threads in the eviction thread pool. These threads help keep memory usage within cache bounds, offloading work from application threads. db-evictor-core-threads, db-evictor-max-threads and db-evictor-keep-alive are used to configure the core, max and keepalive attributes for the eviction thread pool.

      Parameters:
      value - The value of the "db-evictor-max-threads" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbLogFilecacheSize

      ValueOrExpression<Integer> getDbLogFilecacheSize()
      Gets the "db-log-filecache-size" property.

      Specifies the size of the file handle cache.

      The file handle cache is used to keep as much opened log files as possible. When the cache is smaller than the number of logs, the database needs to close some handles and open log files it needs, resulting in less optimal performances. Ideally, the size of the cache should be higher than the number of files contained in the database. Make sure the OS number of open files per process is also tuned appropriately.

      Default value: 200

      Returns:
      Returns the value of the "db-log-filecache-size" property.

    • setDbLogFilecacheSize

      void setDbLogFilecacheSize(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-log-filecache-size" property.

      Specifies the size of the file handle cache.

      The file handle cache is used to keep as much opened log files as possible. When the cache is smaller than the number of logs, the database needs to close some handles and open log files it needs, resulting in less optimal performances. Ideally, the size of the cache should be higher than the number of files contained in the database. Make sure the OS number of open files per process is also tuned appropriately.

      Parameters:
      value - The value of the "db-log-filecache-size" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbLogFileMax

      ValueOrExpression<Long> getDbLogFileMax()
      Gets the "db-log-file-max" property.

      Specifies the maximum size of each individual database log file.

      Default value: 1gb

      Returns:
      Returns the value of the "db-log-file-max" property.

    • setDbLogFileMax

      void setDbLogFileMax(ValueOrExpression<Long> value) throws PropertyException
      Sets the "db-log-file-max" property.

      Specifies the maximum size of each individual database log file.

      Parameters:
      value - The value of the "db-log-file-max" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isDbLoggingFileHandlerOn

      ValueOrExpression<Boolean> isDbLoggingFileHandlerOn()
      Gets the "db-logging-file-handler-on" property.

      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.

      Default value: true

      Returns:
      Returns the value of the "db-logging-file-handler-on" property.

    • setDbLoggingFileHandlerOn

      void setDbLoggingFileHandlerOn(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "db-logging-file-handler-on" property.

      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.

      Parameters:
      value - The value of the "db-logging-file-handler-on" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbLoggingLevel

      ValueOrExpression<String> getDbLoggingLevel()
      Gets the "db-logging-level" property.

      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.

      Default value: CONFIG

      Returns:
      Returns the value of the "db-logging-level" property.

    • setDbLoggingLevel

      void setDbLoggingLevel(ValueOrExpression<String> value) throws PropertyException
      Sets the "db-logging-level" property.

      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.

      Parameters:
      value - The value of the "db-logging-level" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbLogVerifierSchedule

      ValueOrExpression<String> getDbLogVerifierSchedule()
      Gets the "db-log-verifier-schedule" property.

      Specifies when the background log verifier should run if enabled. By default, verification is performed every day at midnight, local time.

      The schedule is specified using a Crontab style format string as defined in https://en.wikipedia.org/wiki/Cron#Configuration_file. Note that times and dates are specified in local time, not UTC time. If the verifier is already running at the scheduled time, the scheduled run is skipped.

      Default value: 0 0 * * *

      Returns:
      Returns the value of the "db-log-verifier-schedule" property.

    • setDbLogVerifierSchedule

      void setDbLogVerifierSchedule(ValueOrExpression<String> value) throws PropertyException
      Sets the "db-log-verifier-schedule" property.

      Specifies when the background log verifier should run if enabled. By default, verification is performed every day at midnight, local time.

      The schedule is specified using a Crontab style format string as defined in https://en.wikipedia.org/wiki/Cron#Configuration_file. Note that times and dates are specified in local time, not UTC time. If the verifier is already running at the scheduled time, the scheduled run is skipped.

      Parameters:
      value - The value of the "db-log-verifier-schedule" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbNumCleanerThreads

      ValueOrExpression<Integer> getDbNumCleanerThreads()
      Gets the "db-num-cleaner-threads" property.

      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.

      Returns:
      Returns the value of the "db-num-cleaner-threads" property.

    • setDbNumCleanerThreads

      void setDbNumCleanerThreads(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-num-cleaner-threads" property.

      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.

      Parameters:
      value - The value of the "db-num-cleaner-threads" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDbNumLockTables

      ValueOrExpression<Integer> getDbNumLockTables()
      Gets the "db-num-lock-tables" property.

      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.

      Returns:
      Returns the value of the "db-num-lock-tables" property.

    • setDbNumLockTables

      void setDbNumLockTables(ValueOrExpression<Integer> value) throws PropertyException
      Sets the "db-num-lock-tables" property.

      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.

      Parameters:
      value - The value of the "db-num-lock-tables" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isDbRunCleaner

      ValueOrExpression<Boolean> isDbRunCleaner()
      Gets the "db-run-cleaner" property.

      Indicates whether the cleaner threads should be enabled to compact the database.

      The cleaner threads are used to periodically compact the database when it reaches a percentage of occupancy lower than the amount specified by the db-cleaner-min-utilization property. They identify database files with a low percentage of live data, and relocate their remaining live data to the end of the log.

      Default value: true

      Returns:
      Returns the value of the "db-run-cleaner" property.

    • setDbRunCleaner

      void setDbRunCleaner(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "db-run-cleaner" property.

      Indicates whether the cleaner threads should be enabled to compact the database.

      The cleaner threads are used to periodically compact the database when it reaches a percentage of occupancy lower than the amount specified by the db-cleaner-min-utilization property. They identify database files with a low percentage of live data, and relocate their remaining live data to the end of the log.

      Parameters:
      value - The value of the "db-run-cleaner" property.
      Throws:
      PropertyException - If the new value is invalid.

    • isDbRunLogVerifier

      ValueOrExpression<Boolean> isDbRunLogVerifier()
      Gets the "db-run-log-verifier" property.

      Indicates whether the background verifier should verify checksums in the database log.

      If enabled, the entire log is periodically read sequentially and verified. The schedule can be controlled using the db-log-verifier-schedule property. If the verification process detects backend database corruption then the server logs an error message and the backend is taken offline. The corrupted backend should be restored from backup before it can be used again.

      Default value: true

      Returns:
      Returns the value of the "db-run-log-verifier" property.

    • setDbRunLogVerifier

      void setDbRunLogVerifier(ValueOrExpression<Boolean> value) throws PropertyException
      Sets the "db-run-log-verifier" property.

      Indicates whether the background verifier should verify checksums in the database log.

      If enabled, the entire log is periodically read sequentially and verified. The schedule can be controlled using the db-log-verifier-schedule property. If the verification process detects backend database corruption then the server logs an error message and the backend is taken offline. The corrupted backend should be restored from backup before it can be used again.

      Parameters:
      value - The value of the "db-run-log-verifier" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDiskFullThreshold

      ValueOrExpression<Long> getDiskFullThreshold()
      Gets the "disk-full-threshold" property.

      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.

      Returns:
      Returns the value of the "disk-full-threshold" property.

    • setDiskFullThreshold

      void setDiskFullThreshold(ValueOrExpression<Long> value) throws PropertyException
      Sets the "disk-full-threshold" property.

      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.

      Parameters:
      value - The value of the "disk-full-threshold" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getDiskLowThreshold

      ValueOrExpression<Long> getDiskLowThreshold()
      Gets the "disk-low-threshold" property.

      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.

      Returns:
      Returns the value of the "disk-low-threshold" property.

    • setDiskLowThreshold

      void setDiskLowThreshold(ValueOrExpression<Long> value) throws PropertyException
      Sets the "disk-low-threshold" property.

      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.

      Parameters:
      value - The value of the "disk-low-threshold" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJavaClass

      @MandatoryProperty ValueOrExpression<String> getJavaClass()
      Gets the "java-class" property.

      Specifies the fully-qualified name of the Java class that provides the backend implementation.

      Default value: org.opends.server.backends.jeb.JEBackend

      Specified by:
      getJavaClass in interface BackendCfgClient
      Returns:
      Returns the value of the "java-class" property.

    • setJavaClass

      @MandatoryProperty void setJavaClass(ValueOrExpression<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
      Parameters:
      value - The value of the "java-class" property.
      Throws:
      PropertyException - If the new value is invalid.

    • getJeProperty

      SortedSet<ValueOrExpression<String>> getJeProperty()
      Gets the "je-property" property.

      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 OpenDJ 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.

      Default value is undefined

      Returns:
      Returns the values of the "je-property" property.

    • setJeProperty

      void setJeProperty(Collection<ValueOrExpression<String>> values) throws PropertyException
      Sets the "je-property" property.

      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 OpenDJ 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.

      Parameters:
      values - The values of the "je-property" property.
      Throws:
      PropertyException - If one or more of the new values are invalid.