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

Class LogRetentionPolicyCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>

org.forgerock.opendj.server.config.meta.LogRetentionPolicyCfgDefn

public final class LogRetentionPolicyCfgDefn
extends ManagedObjectDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>

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

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

Method Summary

Modifier and Type	Method	Description
LogRetentionPolicyCfgClient	createClientConfiguration(ManagedObject<? extends LogRetentionPolicyCfgClient> impl)	Creates a client configuration view of the provided managed object.
LogRetentionPolicyCfg	createServerConfiguration(ServerManagedObject<? extends LogRetentionPolicyCfg> impl)	Creates a server configuration view of the provided server managed object.
static LogRetentionPolicyCfgDefn	getInstance()	Get the Log Retention Policy configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<LogRetentionPolicyCfg>	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 LogRetentionPolicyCfgDefn getInstance()

Get the Log Retention Policy configuration definition singleton.

Returns:

Returns the Log Retention Policy configuration definition singleton.

createClientConfiguration

public LogRetentionPolicyCfgClient createClientConfiguration(ManagedObject<? extends LogRetentionPolicyCfgClient> 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<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<LogRetentionPolicyCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<LogRetentionPolicyCfgClient,LogRetentionPolicyCfg>

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

Returns:

Returns the "java-class" property definition.