org.opends.server.admin.std.server
Interface SizeLimitLogRetentionPolicyCfg

All Superinterfaces:
Configuration, LogRetentionPolicyCfg

public interface SizeLimitLogRetentionPolicyCfg
extends LogRetentionPolicyCfg

A server-side interface for querying Size Limit Log Retention Policy settings.

Retention policy based on the amount of space taken by all the log files on disk.


Method Summary
 void addSizeLimitChangeListener(ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg> listener)
          Register to be notified when this Size Limit Log Retention Policy is changed.
 java.lang.Class<? extends SizeLimitLogRetentionPolicyCfg> configurationClass()
          Gets the configuration class associated with this Size Limit Log Retention Policy.
 long getDiskSpaceUsed()
          Gets the "disk-space-used" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void removeSizeLimitChangeListener(ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg> listener)
          Deregister an existing Size Limit Log Retention Policy configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.LogRetentionPolicyCfg
addChangeListener, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends SizeLimitLogRetentionPolicyCfg> configurationClass()
Gets the configuration class associated with this Size Limit Log Retention Policy.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface LogRetentionPolicyCfg
Returns:
Returns the configuration class associated with this Size Limit Log Retention Policy.

addSizeLimitChangeListener

void addSizeLimitChangeListener(ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg> listener)
Register to be notified when this Size Limit Log Retention Policy is changed.

Parameters:
listener - The Size Limit Log Retention Policy configuration change listener.

removeSizeLimitChangeListener

void removeSizeLimitChangeListener(ConfigurationChangeListener<SizeLimitLogRetentionPolicyCfg> listener)
Deregister an existing Size Limit Log Retention Policy configuration change listener.

Parameters:
listener - The Size Limit Log Retention Policy configuration change listener.

getDiskSpaceUsed

long getDiskSpaceUsed()
Gets the "disk-space-used" property.

Specifies the maximum total disk space used by the log files.

Returns:
Returns the value of the "disk-space-used" property.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Size Limit Log Retention Policy implementation.

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