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

Class FileCountLogRetentionPolicyCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient,FileCountLogRetentionPolicyCfg>

org.forgerock.opendj.server.config.meta.FileCountLogRetentionPolicyCfgDefn

public final class FileCountLogRetentionPolicyCfgDefn
extends ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient,FileCountLogRetentionPolicyCfg>

An interface for querying the File Count Log Retention Policy managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
FileCountLogRetentionPolicyCfgClient	createClientConfiguration(ManagedObject<? extends FileCountLogRetentionPolicyCfgClient> impl)	Creates a client configuration view of the provided managed object.
FileCountLogRetentionPolicyCfg	createServerConfiguration(ServerManagedObject<? extends FileCountLogRetentionPolicyCfg> impl)	Creates a server configuration view of the provided server managed object.
static FileCountLogRetentionPolicyCfgDefn	getInstance()	Get the File Count Log Retention Policy configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
IntegerPropertyDefinition	getNumberOfFilesPropertyDefinition()	Get the "number-of-files" property definition.
Class<FileCountLogRetentionPolicyCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getInstance

public static FileCountLogRetentionPolicyCfgDefn getInstance()

Get the File Count Log Retention Policy configuration definition singleton.

Returns:

Returns the File Count Log Retention Policy configuration definition singleton.

createClientConfiguration

public FileCountLogRetentionPolicyCfgClient createClientConfiguration(ManagedObject<? extends FileCountLogRetentionPolicyCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient,FileCountLogRetentionPolicyCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public FileCountLogRetentionPolicyCfg createServerConfiguration(ServerManagedObject<? extends FileCountLogRetentionPolicyCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient,FileCountLogRetentionPolicyCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<FileCountLogRetentionPolicyCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FileCountLogRetentionPolicyCfgClient,FileCountLogRetentionPolicyCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.

getNumberOfFilesPropertyDefinition

public IntegerPropertyDefinition getNumberOfFilesPropertyDefinition()

Get the "number-of-files" property definition.

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

Returns:

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