|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FileSystemEntryCacheCfgClient
A client-side interface for reading and modifying File System Entry Cache settings.
The File System Entry Cache is an entry cache implementation which uses a JE database to keep track of the entries.
Method Summary | |
---|---|
ManagedObjectDefinition<? extends FileSystemEntryCacheCfgClient,? extends FileSystemEntryCacheCfg> |
definition()
Get the configuration definition associated with this File System Entry Cache. |
java.lang.String |
getCacheDirectory()
Gets the "cache-directory" property. |
FileSystemEntryCacheCfgDefn.CacheType |
getCacheType()
Gets the "cache-type" property. |
int |
getDBCachePercent()
Gets the "db-cache-percent" property. |
long |
getDBCacheSize()
Gets the "db-cache-size" property. |
java.util.SortedSet<java.lang.String> |
getExcludeFilter()
Gets the "exclude-filter" property. |
java.util.SortedSet<java.lang.String> |
getIncludeFilter()
Gets the "include-filter" property. |
java.lang.String |
getJavaClass()
Gets the "java-class" property. |
java.util.SortedSet<java.lang.String> |
getJEProperty()
Gets the "je-property" property. |
long |
getLockTimeout()
Gets the "lock-timeout" property. |
int |
getMaxEntries()
Gets the "max-entries" property. |
long |
getMaxMemorySize()
Gets the "max-memory-size" property. |
boolean |
isCompactEncoding()
Gets the "compact-encoding" property. |
boolean |
isPersistentCache()
Gets the "persistent-cache" property. |
void |
setCacheDirectory(java.lang.String value)
Sets the "cache-directory" property. |
void |
setCacheType(FileSystemEntryCacheCfgDefn.CacheType value)
Sets the "cache-type" property. |
void |
setCompactEncoding(java.lang.Boolean value)
Sets the "compact-encoding" property. |
void |
setDBCachePercent(java.lang.Integer value)
Sets the "db-cache-percent" property. |
void |
setDBCacheSize(java.lang.Long value)
Sets the "db-cache-size" property. |
void |
setExcludeFilter(java.util.Collection<java.lang.String> values)
Sets the "exclude-filter" property. |
void |
setIncludeFilter(java.util.Collection<java.lang.String> values)
Sets the "include-filter" property. |
void |
setJavaClass(java.lang.String value)
Sets the "java-class" property. |
void |
setJEProperty(java.util.Collection<java.lang.String> values)
Sets the "je-property" property. |
void |
setLockTimeout(java.lang.Long value)
Sets the "lock-timeout" property. |
void |
setMaxEntries(java.lang.Integer value)
Sets the "max-entries" property. |
void |
setMaxMemorySize(java.lang.Long value)
Sets the "max-memory-size" property. |
void |
setPersistentCache(java.lang.Boolean value)
Sets the "persistent-cache" property. |
Methods inherited from interface org.opends.server.admin.std.client.EntryCacheCfgClient |
---|
getCacheLevel, isEnabled, setCacheLevel, setEnabled |
Methods inherited from interface org.opends.server.admin.ConfigurationClient |
---|
commit, properties |
Method Detail |
---|
ManagedObjectDefinition<? extends FileSystemEntryCacheCfgClient,? extends FileSystemEntryCacheCfg> definition()
definition
in interface ConfigurationClient
definition
in interface EntryCacheCfgClient
java.lang.String getCacheDirectory()
Specifies the directory in which the JE environment should store the cache.
void setCacheDirectory(java.lang.String value) throws IllegalPropertyValueException
Specifies the directory in which the JE environment should store the cache.
value
- The value of the "cache-directory" property.
IllegalPropertyValueException
- If the new value is invalid.FileSystemEntryCacheCfgDefn.CacheType getCacheType()
Specifies the policy which should be used for purging entries from the cache.
void setCacheType(FileSystemEntryCacheCfgDefn.CacheType value) throws IllegalPropertyValueException
Specifies the policy which should be used for purging entries from the cache.
value
- The value of the "cache-type" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isCompactEncoding()
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.
void setCompactEncoding(java.lang.Boolean value) throws IllegalPropertyValueException
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.
value
- The value of the "compact-encoding" property.
IllegalPropertyValueException
- If the new value is invalid.int getDBCachePercent()
Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory.
void setDBCachePercent(java.lang.Integer value) throws IllegalPropertyValueException
Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory.
value
- The value of the "db-cache-percent" property.
IllegalPropertyValueException
- If the new value is invalid.long getDBCacheSize()
Specifies the maximum JVM memory usage in bytes for the internal JE cache.
void setDBCacheSize(java.lang.Long value) throws IllegalPropertyValueException
Specifies the maximum JVM memory usage in bytes for the internal JE cache.
value
- The value of the "db-cache-size" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getExcludeFilter()
The set of filters that define the entries that should be excluded from the cache.
void setExcludeFilter(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
The set of filters that define the entries that should be excluded from the cache.
values
- The values of the "exclude-filter" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.util.SortedSet<java.lang.String> getIncludeFilter()
The set of filters that define the entries that should be included in the cache.
void setIncludeFilter(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
The set of filters that define the entries that should be included in the cache.
values
- The values of the "include-filter" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.java.lang.String getJavaClass()
Specifies the fully-qualified name of the Java class that provides the File System Entry Cache implementation.
getJavaClass
in interface EntryCacheCfgClient
void setJavaClass(java.lang.String value) throws IllegalPropertyValueException
Specifies the fully-qualified name of the Java class that provides the File System Entry Cache implementation.
setJavaClass
in interface EntryCacheCfgClient
value
- The value of the "java-class" property.
IllegalPropertyValueException
- If the new value is invalid.java.util.SortedSet<java.lang.String> getJEProperty()
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.
void setJEProperty(java.util.Collection<java.lang.String> values) throws IllegalPropertyValueException
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.
values
- The values of the "je-property" property.
IllegalPropertyValueException
- If one or more of the new values are invalid.long getLockTimeout()
The length of time to wait while attempting to acquire a read or write lock.
void setLockTimeout(java.lang.Long value) throws IllegalPropertyValueException
The length of time to wait while attempting to acquire a read or write lock.
value
- The value of the "lock-timeout" property.
IllegalPropertyValueException
- If the new value is invalid.int getMaxEntries()
The maximum number of entries allowed in the cache.
void setMaxEntries(java.lang.Integer value) throws IllegalPropertyValueException
The maximum number of entries allowed in the cache.
value
- The value of the "max-entries" property.
IllegalPropertyValueException
- If the new value is invalid.long getMaxMemorySize()
The maximum size of the entry cache in bytes.
void setMaxMemorySize(java.lang.Long value) throws IllegalPropertyValueException
The maximum size of the entry cache in bytes.
value
- The value of the "max-memory-size" property.
IllegalPropertyValueException
- If the new value is invalid.boolean isPersistentCache()
Specifies whether the cache should persist across restarts.
void setPersistentCache(java.lang.Boolean value) throws IllegalPropertyValueException
Specifies whether the cache should persist across restarts.
value
- The value of the "persistent-cache" property.
IllegalPropertyValueException
- If the new value is invalid.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |