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

Class FifoEntryCacheCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<FifoEntryCacheCfgClient,FifoEntryCacheCfg>

org.forgerock.opendj.server.config.meta.FifoEntryCacheCfgDefn

public final class FifoEntryCacheCfgDefn
extends ManagedObjectDefinition<FifoEntryCacheCfgClient,FifoEntryCacheCfg>

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

FIFO Entry Caches use a FIFO queue to keep track of the cached entries.

Method Summary

Modifier and Type	Method	Description
FifoEntryCacheCfgClient	createClientConfiguration(ManagedObject<? extends FifoEntryCacheCfgClient> impl)	Creates a client configuration view of the provided managed object.
FifoEntryCacheCfg	createServerConfiguration(ServerManagedObject<? extends FifoEntryCacheCfg> 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 FifoEntryCacheCfgDefn	getInstance()	Get the FIFO Entry Cache configuration definition singleton.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
DurationPropertyDefinition	getLockTimeoutPropertyDefinition()	Get the "lock-timeout" property definition.
IntegerPropertyDefinition	getMaxEntriesPropertyDefinition()	Get the "max-entries" property definition.
IntegerPropertyDefinition	getMaxMemoryPercentPropertyDefinition()	Get the "max-memory-percent" property definition.
Class<FifoEntryCacheCfg>	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, 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 Detail

getInstance

public static FifoEntryCacheCfgDefn getInstance()

Get the FIFO Entry Cache configuration definition singleton.

Returns:

Returns the FIFO Entry Cache configuration definition singleton.

createClientConfiguration

public FifoEntryCacheCfgClient createClientConfiguration(ManagedObject<? extends FifoEntryCacheCfgClient> 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<FifoEntryCacheCfgClient,FifoEntryCacheCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FifoEntryCacheCfgClient,FifoEntryCacheCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<FifoEntryCacheCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FifoEntryCacheCfgClient,FifoEntryCacheCfg>

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 FIFO 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 FIFO 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 to wait while attempting to acquire a read or write lock.

Returns:

Returns the "lock-timeout" property definition.

getMaxEntriesPropertyDefinition

public IntegerPropertyDefinition getMaxEntriesPropertyDefinition()

Get the "max-entries" property definition.

Specifies the maximum number of entries that we will allow in the cache.

Returns:

Returns the "max-entries" property definition.

getMaxMemoryPercentPropertyDefinition

public IntegerPropertyDefinition getMaxMemoryPercentPropertyDefinition()

Get the "max-memory-percent" property definition.

Specifies the maximum percentage of JVM memory used by the server before the entry caches stops caching and begins purging itself.

Very low settings such as 10 or 20 (percent) can prevent this entry cache from having enough space to hold any of the entries to cache, making it appear that the server is ignoring or skipping the entry cache entirely.

Returns:

Returns the "max-memory-percent" property definition.