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

Interface FreeDiskSpaceLogRetentionPolicyCfg

All Superinterfaces:

Configuration, LogRetentionPolicyCfg

public interface FreeDiskSpaceLogRetentionPolicyCfg
extends LogRetentionPolicyCfg

A server-side interface for querying Free Disk Space Log Retention Policy settings.

Retention policy based on the free disk space available.

Method Summary

Modifier and Type	Method	Description
void	addFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener)	Register to be notified when this Free Disk Space Log Retention Policy is changed.
Class<? extends FreeDiskSpaceLogRetentionPolicyCfg>	configurationClass()	Gets the configuration class associated with this Free Disk Space Log Retention Policy.
long	getFreeDiskSpace()	Gets the "free-disk-space" property.
String	getJavaClass()	Gets the "java-class" property.
void	removeFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener)	Deregister an existing Free Disk Space Log Retention Policy configuration change listener.

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

dn, name

Methods inherited from interface org.forgerock.opendj.server.config.server.LogRetentionPolicyCfg

addChangeListener, removeChangeListener

Method Detail

configurationClass

Class<? extends FreeDiskSpaceLogRetentionPolicyCfg> configurationClass()

Gets the configuration class associated with this Free Disk Space Log Retention Policy.

Specified by:

configurationClass in interface Configuration

Specified by:

configurationClass in interface LogRetentionPolicyCfg

Returns:

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

addFreeDiskSpaceChangeListener

void addFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener)

Register to be notified when this Free Disk Space Log Retention Policy is changed.

Parameters:

listener - The Free Disk Space Log Retention Policy configuration change listener.

removeFreeDiskSpaceChangeListener

void removeFreeDiskSpaceChangeListener(ConfigurationChangeListener<FreeDiskSpaceLogRetentionPolicyCfg> listener)

Deregister an existing Free Disk Space Log Retention Policy configuration change listener.

Parameters:

listener - The Free Disk Space Log Retention Policy configuration change listener.

getFreeDiskSpace

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.

getJavaClass

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 LogRetentionPolicyCfg

Returns:

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