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

Class FixedTimeLogRotationPolicyCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FixedTimeLogRotationPolicyCfgClient,FixedTimeLogRotationPolicyCfg>

org.forgerock.opendj.server.config.meta.FixedTimeLogRotationPolicyCfgDefn

public final class FixedTimeLogRotationPolicyCfgDefn
extends ManagedObjectDefinition<FixedTimeLogRotationPolicyCfgClient,FixedTimeLogRotationPolicyCfg>

An interface for querying the Fixed Time Log Rotation Policy managed object definition meta information.

Rotation policy based on a fixed time of day.

Method Summary

Modifier and Type	Method	Description
FixedTimeLogRotationPolicyCfgClient	createClientConfiguration(ManagedObject<? extends FixedTimeLogRotationPolicyCfgClient> impl)	Creates a client configuration view of the provided managed object.
FixedTimeLogRotationPolicyCfg	createServerConfiguration(ServerManagedObject<? extends FixedTimeLogRotationPolicyCfg> impl)	Creates a server configuration view of the provided server managed object.
static FixedTimeLogRotationPolicyCfgDefn	getInstance()	Get the Fixed Time Log Rotation Policy configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<FixedTimeLogRotationPolicyCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getTimeOfDayPropertyDefinition()	Get the "time-of-day" property 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 FixedTimeLogRotationPolicyCfgDefn getInstance()

Get the Fixed Time Log Rotation Policy configuration definition singleton.

Returns:

Returns the Fixed Time Log Rotation Policy configuration definition singleton.

createClientConfiguration

public FixedTimeLogRotationPolicyCfgClient createClientConfiguration(ManagedObject<? extends FixedTimeLogRotationPolicyCfgClient> 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<FixedTimeLogRotationPolicyCfgClient,FixedTimeLogRotationPolicyCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FixedTimeLogRotationPolicyCfgClient,FixedTimeLogRotationPolicyCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FixedTimeLogRotationPolicyCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FixedTimeLogRotationPolicyCfgClient,FixedTimeLogRotationPolicyCfg>

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 Fixed Time Log Rotation Policy implementation.

Returns:

Returns the "java-class" property definition.

getTimeOfDayPropertyDefinition

public StringPropertyDefinition getTimeOfDayPropertyDefinition()

Get the "time-of-day" property definition.

Specifies the time of day at which log rotation should occur.

Returns:

Returns the "time-of-day" property definition.