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

Interface FileCountLogRetentionPolicyCfgClient

All Superinterfaces:

ConfigurationClient, LogRetentionPolicyCfgClient

public interface FileCountLogRetentionPolicyCfgClient
extends LogRetentionPolicyCfgClient

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

Retention policy based on the number of rotated log files on disk.

Method Summary

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends FileCountLogRetentionPolicyCfgClient,? extends FileCountLogRetentionPolicyCfg>	definition()	Get the configuration definition associated with this File Count Log Retention Policy.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<Integer>	getNumberOfFiles()	Gets the "number-of-files" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setNumberOfFiles(ValueOrExpression<Integer> value)	Sets the "number-of-files" property.

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

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends FileCountLogRetentionPolicyCfgClient,? extends FileCountLogRetentionPolicyCfg> definition()

Get the configuration definition associated with this File Count Log Retention Policy.

Specified by:

definition in interface ConfigurationClient

Specified by:

definition in interface LogRetentionPolicyCfgClient

Returns:

Returns the configuration definition associated with this File Count 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 File Count Log Retention Policy implementation.

Default value: org.opends.server.loggers.FileNumberRetentionPolicy

Specified by:

getJavaClass in interface LogRetentionPolicyCfgClient

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 File Count 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.

getNumberOfFiles

@MandatoryProperty
ValueOrExpression<Integer> getNumberOfFiles()

Gets the "number-of-files" property.

Specifies the number of archived log files to retain before the oldest ones are cleaned.

Returns:

Returns the value of the "number-of-files" property.

setNumberOfFiles

@MandatoryProperty
void setNumberOfFiles(ValueOrExpression<Integer> value)
               throws PropertyException

Sets the "number-of-files" property.

Specifies the number of archived log files to retain before the oldest ones are cleaned.

Parameters:

value - The value of the "number-of-files" property.

Throws:

PropertyException - If the new value is invalid.