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

Interface FreeDiskSpaceLogRetentionPolicyCfgClient

All Superinterfaces:

ConfigurationClient, LogRetentionPolicyCfgClient

public interface FreeDiskSpaceLogRetentionPolicyCfgClient
extends LogRetentionPolicyCfgClient

A client-side interface for reading and modifying Free Disk Space Log Retention Policy settings.

Retention policy based on the free disk space available.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient,? extends FreeDiskSpaceLogRetentionPolicyCfg>	definition()	Get the configuration definition associated with this Free Disk Space Log Retention Policy.
ValueOrExpression<Long>	getFreeDiskSpace()	Gets the "free-disk-space" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setFreeDiskSpace(ValueOrExpression<Long> value)	Sets the "free-disk-space" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient,? extends FreeDiskSpaceLogRetentionPolicyCfg> definition()

Get the configuration definition associated with this Free Disk Space Log Retention Policy.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogRetentionPolicyCfgClient

Returns:

Returns the configuration definition associated with this Free Disk Space Log Retention Policy.

getFreeDiskSpace

@MandatoryProperty
ValueOrExpression<Long> getFreeDiskSpace()

Gets the "free-disk-space" property.

Specifies the minimum amount of free disk space that should be available on the file system on which the archived log files are stored.

Returns:

Returns the value of the "free-disk-space" property.

setFreeDiskSpace

@MandatoryProperty
void setFreeDiskSpace(ValueOrExpression<Long> value)
               throws PropertyException

Sets the "free-disk-space" property.

Specifies the minimum amount of free disk space that should be available on the file system on which the archived log files are stored.

Parameters:

value - The value of the "free-disk-space" 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 Free Disk Space Log Retention Policy implementation.

Default value: org.opends.server.loggers.FreeDiskSpaceRetentionPolicy

Specified by:

getJavaClass in interface LogRetentionPolicyCfgClient

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 Free Disk Space Log Retention Policy implementation.

Specified by:

setJavaClass in interface LogRetentionPolicyCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.