org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends FreeDiskSpaceLogRetentionPolicyCfgClient,? extends FreeDiskSpaceLogRetentionPolicyCfg> definition()
          Get the configuration definition associated with this Free Disk Space Log Retention Policy.
 java.lang.Long getFreeDiskSpace()
          Gets the "free-disk-space" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setFreeDiskSpace(long value)
          Sets the "free-disk-space" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.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

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

void setFreeDiskSpace(long value)
                      throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

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

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

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.