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

Class FreeDiskSpaceLogRetentionPolicyCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FreeDiskSpaceLogRetentionPolicyCfgClient,FreeDiskSpaceLogRetentionPolicyCfg>

org.forgerock.opendj.server.config.meta.FreeDiskSpaceLogRetentionPolicyCfgDefn

public final class FreeDiskSpaceLogRetentionPolicyCfgDefn
extends ManagedObjectDefinition<FreeDiskSpaceLogRetentionPolicyCfgClient,FreeDiskSpaceLogRetentionPolicyCfg>

An interface for querying the Free Disk Space Log Retention Policy managed object definition meta information.

Retention policy based on the free disk space available.

Method Summary

Modifier and Type	Method	Description
FreeDiskSpaceLogRetentionPolicyCfgClient	createClientConfiguration(ManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfgClient> impl)	Creates a client configuration view of the provided managed object.
FreeDiskSpaceLogRetentionPolicyCfg	createServerConfiguration(ServerManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfg> impl)	Creates a server configuration view of the provided server managed object.
SizePropertyDefinition	getFreeDiskSpacePropertyDefinition()	Get the "free-disk-space" property definition.
static FreeDiskSpaceLogRetentionPolicyCfgDefn	getInstance()	Get the Free Disk Space Log Retention Policy configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<FreeDiskSpaceLogRetentionPolicyCfg>	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 FreeDiskSpaceLogRetentionPolicyCfgDefn getInstance()

Get the Free Disk Space Log Retention Policy configuration definition singleton.

Returns:

Returns the Free Disk Space Log Retention Policy configuration definition singleton.

createClientConfiguration

public FreeDiskSpaceLogRetentionPolicyCfgClient createClientConfiguration(ManagedObject<? extends FreeDiskSpaceLogRetentionPolicyCfgClient> 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<FreeDiskSpaceLogRetentionPolicyCfgClient,FreeDiskSpaceLogRetentionPolicyCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FreeDiskSpaceLogRetentionPolicyCfgClient,FreeDiskSpaceLogRetentionPolicyCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FreeDiskSpaceLogRetentionPolicyCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FreeDiskSpaceLogRetentionPolicyCfgClient,FreeDiskSpaceLogRetentionPolicyCfg>

Returns:

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

getFreeDiskSpacePropertyDefinition

public SizePropertyDefinition getFreeDiskSpacePropertyDefinition()

Get the "free-disk-space" property definition.

Specifies the minimum amount of free disk space that should be available on the file system on which the archived log files are stored.

Returns:

Returns the "free-disk-space" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.