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

Interface LogRetentionPolicyCfgClient

All Superinterfaces:

ConfigurationClient

All Known Subinterfaces:

FileCountLogRetentionPolicyCfgClient, FreeDiskSpaceLogRetentionPolicyCfgClient, SizeLimitLogRetentionPolicyCfgClient

public interface LogRetentionPolicyCfgClient
extends ConfigurationClient

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

Log Retention Policies are used to specify when log files should be cleaned.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends LogRetentionPolicyCfgClient,? extends LogRetentionPolicyCfg>	definition()	Get the configuration definition associated with this Log Retention Policy.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.

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

commit, properties

Method Details

definition

ManagedObjectDefinition<? extends LogRetentionPolicyCfgClient,? extends LogRetentionPolicyCfg> definition()

Get the configuration definition associated with this Log Retention Policy.

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Log Retention Policy.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

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

Parameters:

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

Throws:

PropertyException - If the new value is invalid.