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

Interface SizeLimitLogRetentionPolicyCfgClient

All Superinterfaces:

ConfigurationClient, LogRetentionPolicyCfgClient

public interface SizeLimitLogRetentionPolicyCfgClient
extends LogRetentionPolicyCfgClient

A client-side interface for reading and modifying Size Limit Log Retention Policy settings.

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

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends SizeLimitLogRetentionPolicyCfgClient,? extends SizeLimitLogRetentionPolicyCfg>	definition()	Get the configuration definition associated with this Size Limit Log Retention Policy.
Long	getDiskSpaceUsed()	Gets the "disk-space-used" property.
String	getJavaClass()	Gets the "java-class" property.
void	setDiskSpaceUsed(long value)	Sets the "disk-space-used" property.
void	setJavaClass(String value)	Sets the "java-class" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends SizeLimitLogRetentionPolicyCfgClient,? extends SizeLimitLogRetentionPolicyCfg> definition()

Get the configuration definition associated with this Size Limit Log Retention Policy.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogRetentionPolicyCfgClient

Returns:

Returns the configuration definition associated with this Size Limit Log Retention Policy.

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.

setDiskSpaceUsed

void setDiskSpaceUsed(long value)
               throws PropertyException

Sets the "disk-space-used" property.

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

Parameters:

value - The value of the "disk-space-used" 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 Size Limit Log Retention Policy implementation.

Specified by:

getJavaClass in interface LogRetentionPolicyCfgClient

Returns:

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

setJavaClass

void setJavaClass(String value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Size Limit 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.