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

Class SizeLimitLogRetentionPolicyCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<SizeLimitLogRetentionPolicyCfgClient,SizeLimitLogRetentionPolicyCfg>

org.forgerock.opendj.server.config.meta.SizeLimitLogRetentionPolicyCfgDefn

public final class SizeLimitLogRetentionPolicyCfgDefn
extends ManagedObjectDefinition<SizeLimitLogRetentionPolicyCfgClient,SizeLimitLogRetentionPolicyCfg>

An interface for querying the Size Limit Log Retention Policy managed object definition meta information.

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

Method Summary

Modifier and Type	Method	Description
SizeLimitLogRetentionPolicyCfgClient	createClientConfiguration(ManagedObject<? extends SizeLimitLogRetentionPolicyCfgClient> impl)	Creates a client configuration view of the provided managed object.
SizeLimitLogRetentionPolicyCfg	createServerConfiguration(ServerManagedObject<? extends SizeLimitLogRetentionPolicyCfg> impl)	Creates a server configuration view of the provided server managed object.
SizePropertyDefinition	getDiskSpaceUsedPropertyDefinition()	Get the "disk-space-used" property definition.
static SizeLimitLogRetentionPolicyCfgDefn	getInstance()	Get the Size Limit Log Retention Policy configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<SizeLimitLogRetentionPolicyCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.

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

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, 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 Detail

getInstance

public static SizeLimitLogRetentionPolicyCfgDefn getInstance()

Get the Size Limit Log Retention Policy configuration definition singleton.

Returns:

Returns the Size Limit Log Retention Policy configuration definition singleton.

createClientConfiguration

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

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<SizeLimitLogRetentionPolicyCfgClient,SizeLimitLogRetentionPolicyCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SizeLimitLogRetentionPolicyCfgClient,SizeLimitLogRetentionPolicyCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SizeLimitLogRetentionPolicyCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SizeLimitLogRetentionPolicyCfgClient,SizeLimitLogRetentionPolicyCfg>

Returns:

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

getDiskSpaceUsedPropertyDefinition

public SizePropertyDefinition getDiskSpaceUsedPropertyDefinition()

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

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

Returns:

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

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

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

Returns:

Returns the "java-class" property definition.