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

Class SoftReferenceEntryCacheCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<SoftReferenceEntryCacheCfgClient,SoftReferenceEntryCacheCfg>

org.forgerock.opendj.server.config.meta.SoftReferenceEntryCacheCfgDefn

public final class SoftReferenceEntryCacheCfgDefn
extends ManagedObjectDefinition<SoftReferenceEntryCacheCfgClient,SoftReferenceEntryCacheCfg>

An interface for querying the Soft Reference Entry Cache managed object definition meta information.

The Soft Reference Entry Cache is a directory server entry cache implementation that uses soft references to manage objects to allow them to be freed if the JVM is running low on memory.

Method Summary

Modifier and Type	Method	Description
SoftReferenceEntryCacheCfgClient	createClientConfiguration(ManagedObject<? extends SoftReferenceEntryCacheCfgClient> impl)	Creates a client configuration view of the provided managed object.
SoftReferenceEntryCacheCfg	createServerConfiguration(ServerManagedObject<? extends SoftReferenceEntryCacheCfg> impl)	Creates a server configuration view of the provided server managed object.
IntegerPropertyDefinition	getCacheLevelPropertyDefinition()	Get the "cache-level" property definition.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
StringPropertyDefinition	getExcludeFilterPropertyDefinition()	Get the "exclude-filter" property definition.
StringPropertyDefinition	getIncludeFilterPropertyDefinition()	Get the "include-filter" property definition.
static SoftReferenceEntryCacheCfgDefn	getInstance()	Get the Soft Reference Entry Cache configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
DurationPropertyDefinition	getLockTimeoutPropertyDefinition()	Get the "lock-timeout" property definition.
Class<SoftReferenceEntryCacheCfg>	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 SoftReferenceEntryCacheCfgDefn getInstance()

Get the Soft Reference Entry Cache configuration definition singleton.

Returns:

Returns the Soft Reference Entry Cache configuration definition singleton.

createClientConfiguration

public SoftReferenceEntryCacheCfgClient createClientConfiguration(ManagedObject<? extends SoftReferenceEntryCacheCfgClient> 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<SoftReferenceEntryCacheCfgClient,SoftReferenceEntryCacheCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SoftReferenceEntryCacheCfgClient,SoftReferenceEntryCacheCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SoftReferenceEntryCacheCfg> getServerConfigurationClass()

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SoftReferenceEntryCacheCfgClient,SoftReferenceEntryCacheCfg>

Returns:

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

getCacheLevelPropertyDefinition

public IntegerPropertyDefinition getCacheLevelPropertyDefinition()

Get the "cache-level" property definition.

Specifies the cache level in the cache order if more than one instance of the cache is configured.

Returns:

Returns the "cache-level" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Soft Reference Entry Cache is enabled.

Returns:

Returns the "enabled" property definition.

getExcludeFilterPropertyDefinition

public StringPropertyDefinition getExcludeFilterPropertyDefinition()

Get the "exclude-filter" property definition.

The set of filters that define the entries that should be excluded from the cache.

Returns:

Returns the "exclude-filter" property definition.

getIncludeFilterPropertyDefinition

public StringPropertyDefinition getIncludeFilterPropertyDefinition()

Get the "include-filter" property definition.

The set of filters that define the entries that should be included in the cache.

Returns:

Returns the "include-filter" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Soft Reference Entry Cache implementation.

Returns:

Returns the "java-class" property definition.

getLockTimeoutPropertyDefinition

public DurationPropertyDefinition getLockTimeoutPropertyDefinition()

Get the "lock-timeout" property definition.

Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.

Returns:

Returns the "lock-timeout" property definition.