org.opends.server.admin.std.meta
Class FileSystemEntryCacheCfgDefn

java.lang.Object
  extended by org.opends.server.admin.AbstractManagedObjectDefinition<C,S>
      extended by org.opends.server.admin.ManagedObjectDefinition<FileSystemEntryCacheCfgClient,FileSystemEntryCacheCfg>
          extended by org.opends.server.admin.std.meta.FileSystemEntryCacheCfgDefn

public final class FileSystemEntryCacheCfgDefn
extends ManagedObjectDefinition<FileSystemEntryCacheCfgClient,FileSystemEntryCacheCfg>

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

The File System Entry Cache is an entry cache implementation which uses a JE database to keep track of the entries.


Nested Class Summary
static class FileSystemEntryCacheCfgDefn.CacheType
          Defines the set of permissable values for the "cache-type" property.
 
Method Summary
 FileSystemEntryCacheCfgClient createClientConfiguration(ManagedObject<? extends FileSystemEntryCacheCfgClient> impl)
          Creates a client configuration view of the provided managed object.
 FileSystemEntryCacheCfg createServerConfiguration(ServerManagedObject<? extends FileSystemEntryCacheCfg> impl)
          Creates a server configuration view of the provided server managed object.
 StringPropertyDefinition getCacheDirectoryPropertyDefinition()
          Get the "cache-directory" property definition.
 IntegerPropertyDefinition getCacheLevelPropertyDefinition()
          Get the "cache-level" property definition.
 EnumPropertyDefinition<FileSystemEntryCacheCfgDefn.CacheType> getCacheTypePropertyDefinition()
          Get the "cache-type" property definition.
 BooleanPropertyDefinition getCompactEncodingPropertyDefinition()
          Get the "compact-encoding" property definition.
 IntegerPropertyDefinition getDBCachePercentPropertyDefinition()
          Get the "db-cache-percent" property definition.
 SizePropertyDefinition getDBCacheSizePropertyDefinition()
          Get the "db-cache-size" 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 FileSystemEntryCacheCfgDefn getInstance()
          Get the File System Entry Cache configuration definition singleton.
 ClassPropertyDefinition getJavaClassPropertyDefinition()
          Get the "java-class" property definition.
 StringPropertyDefinition getJEPropertyPropertyDefinition()
          Get the "je-property" property definition.
 DurationPropertyDefinition getLockTimeoutPropertyDefinition()
          Get the "lock-timeout" property definition.
 IntegerPropertyDefinition getMaxEntriesPropertyDefinition()
          Get the "max-entries" property definition.
 SizePropertyDefinition getMaxMemorySizePropertyDefinition()
          Get the "max-memory-size" property definition.
 BooleanPropertyDefinition getPersistentCachePropertyDefinition()
          Get the "persistent-cache" property definition.
 java.lang.Class<FileSystemEntryCacheCfg> getServerConfigurationClass()
          Gets the server configuration class instance associated with this managed object definition.
 
Methods inherited from class org.opends.server.admin.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 FileSystemEntryCacheCfgDefn getInstance()
Get the File System Entry Cache configuration definition singleton.

Returns:
Returns the File System Entry Cache configuration definition singleton.

createClientConfiguration

public FileSystemEntryCacheCfgClient createClientConfiguration(ManagedObject<? extends FileSystemEntryCacheCfgClient> 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<FileSystemEntryCacheCfgClient,FileSystemEntryCacheCfg>
Parameters:
impl - The managed object.
Returns:
Returns a client configuration view of the provided managed object.

createServerConfiguration

public FileSystemEntryCacheCfg createServerConfiguration(ServerManagedObject<? extends FileSystemEntryCacheCfg> impl)
Creates a server configuration view of the provided server managed object.

Specified by:
createServerConfiguration in class ManagedObjectDefinition<FileSystemEntryCacheCfgClient,FileSystemEntryCacheCfg>
Parameters:
impl - The server managed object.
Returns:
Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public java.lang.Class<FileSystemEntryCacheCfg> getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition.

Specified by:
getServerConfigurationClass in class ManagedObjectDefinition<FileSystemEntryCacheCfgClient,FileSystemEntryCacheCfg>
Returns:
Returns the server configuration class instance associated with this managed object definition.

getCacheDirectoryPropertyDefinition

public StringPropertyDefinition getCacheDirectoryPropertyDefinition()
Get the "cache-directory" property definition.

Specifies the directory in which the JE environment should store the cache.

Returns:
Returns the "cache-directory" property 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.

getCacheTypePropertyDefinition

public EnumPropertyDefinition<FileSystemEntryCacheCfgDefn.CacheType> getCacheTypePropertyDefinition()
Get the "cache-type" property definition.

Specifies the policy which should be used for purging entries from the cache.

Returns:
Returns the "cache-type" property definition.

getCompactEncodingPropertyDefinition

public BooleanPropertyDefinition getCompactEncodingPropertyDefinition()
Get the "compact-encoding" property definition.

Indicates whether the cache should use a compact form when encoding cache entries by compressing the attribute descriptions and object class sets.

Note that compression does not preserve user-supplied capitalization in the object class and attribute type names.

Returns:
Returns the "compact-encoding" property definition.

getDBCachePercentPropertyDefinition

public IntegerPropertyDefinition getDBCachePercentPropertyDefinition()
Get the "db-cache-percent" property definition.

Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory.

Returns:
Returns the "db-cache-percent" property definition.

getDBCacheSizePropertyDefinition

public SizePropertyDefinition getDBCacheSizePropertyDefinition()
Get the "db-cache-size" property definition.

Specifies the maximum JVM memory usage in bytes for the internal JE cache.

Returns:
Returns the "db-cache-size" property definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()
Get the "enabled" property definition.

Indicates whether the File System 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 File System Entry Cache implementation.

Returns:
Returns the "java-class" property definition.

getJEPropertyPropertyDefinition

public StringPropertyDefinition getJEPropertyPropertyDefinition()
Get the "je-property" property definition.

Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache.

Any Berkeley DB Java Edition property can be specified using the following form: property-name=property-value. Refer to the OpenDS documentation for further information on related properties, their implications and range values. The definitive identification of all the property parameters available in the example.properties file in the Berkeley DB Java Edition distribution.

Returns:
Returns the "je-property" property definition.

getLockTimeoutPropertyDefinition

public DurationPropertyDefinition getLockTimeoutPropertyDefinition()
Get the "lock-timeout" property definition.

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.

The maximum number of entries allowed in the cache.

Returns:
Returns the "max-entries" property definition.

getMaxMemorySizePropertyDefinition

public SizePropertyDefinition getMaxMemorySizePropertyDefinition()
Get the "max-memory-size" property definition.

The maximum size of the entry cache in bytes.

Returns:
Returns the "max-memory-size" property definition.

getPersistentCachePropertyDefinition

public BooleanPropertyDefinition getPersistentCachePropertyDefinition()
Get the "persistent-cache" property definition.

Specifies whether the cache should persist across restarts.

Returns:
Returns the "persistent-cache" property definition.