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

Interface PDBBackendCfgClient

    • Method Detail

      • getDBCachePercent

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

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

      • setDBCachePercent

        void setDBCachePercent​(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.

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

      • getDBCacheSize

        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.

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

      • setDBCacheSize

        void setDBCacheSize​(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.

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

      • getDBCheckpointerWakeupInterval

        long getDBCheckpointerWakeupInterval()
        Gets the "db-checkpointer-wakeup-interval" property.

        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.

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

      • setDBCheckpointerWakeupInterval

        void setDBCheckpointerWakeupInterval​(Long value)
                              throws PropertyException
        Sets the "db-checkpointer-wakeup-interval" property.

        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.

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

      • getDBDirectory

        String getDBDirectory()
        Gets the "db-directory" property.

        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.

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

      • setDBDirectory

        void setDBDirectory​(String value)
             throws PropertyException
        Sets the "db-directory" property.

        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.

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

      • getDBDirectoryPermissions

        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.

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

      • setDBDirectoryPermissions

        void setDBDirectoryPermissions​(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.

      • isDBTxnNoSync

        boolean isDBTxnNoSync()
        Gets the "db-txn-no-sync" property.

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

        Returns:
        Returns the value of the "db-txn-no-sync" property.

      • setDBTxnNoSync

        void setDBTxnNoSync​(Boolean value)
             throws PropertyException
        Sets the "db-txn-no-sync" property.

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

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

      • getDiskFullThreshold

        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​(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

        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​(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

        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 BackendCfgClient
        Specified by:
        getJavaClass in interface LocalBackendCfgClient
        Returns:
        Returns the value of the "java-class" property.