dsconfig create-entry-cache — Creates Entry Caches
dsconfig create-entry-cache
{options}
The dsconfig create-entry-cache command takes the following options:
--cache-name {name}
The name of the new Entry Cache.
Entry Cache properties depend on the Entry Cache type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following Entry Cache types:
Default {name}: FIFO Entry Cache
Enabled by default: true
See the section called “FIFO Entry Cache” for the properties of this Entry Cache type.
Default {name}: Soft Reference Entry Cache
Enabled by default: true
See the section called “Soft Reference Entry Cache” for the properties of this Entry Cache type.
--set {PROP:VALUE}
Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.
Entry Cache properties depend on the Entry Cache type, which depends on the --cache-name {name}
option.
-t | --type {type}
The type of Entry Cache which should be created. The value for TYPE can be one of: custom | fifo | soft-reference.
Entry Cache properties depend on the Entry Cache type, which depends on the {type} you provide.
By default, OpenDJ directory server supports the following Entry Cache types:
Default {type}: FIFO Entry Cache
Enabled by default: true
See the section called “FIFO Entry Cache” for the properties of this Entry Cache type.
Default {type}: Soft Reference Entry Cache
Enabled by default: true
See the section called “Soft Reference Entry Cache” for the properties of this Entry Cache type.
Entry Caches of type fifo-entry-cache have the following properties:
Specifies the cache level in the cache order if more than one instance of the cache is configured.
None
An integer value. Lower value is 1.
No
Yes
None
No
No
Indicates whether the Entry Cache is enabled.
None
true
false
No
Yes
None
No
No
The set of filters that define the entries that should be excluded from the cache.
None
A String
Yes
No
None
No
No
The set of filters that define the entries that should be included in the cache.
None
A String
Yes
No
None
No
No
Specifies the fully-qualified name of the Java class that provides the FIFO Entry Cache implementation.
org.opends.server.extensions.FIFOEntryCache
A Java class that implements or extends the class(es): org.opends.server.api.EntryCache
No
Yes
The Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the length of time to wait while attempting to acquire a read or write lock.
2000.0ms
Some property values take a time duration.
Durations are expressed as numbers followed by units.
For example 1 s
means one second,
and 2 w
means two weeks.
Some durations have minimum granularity or maximum units,
so you cannot necessary specify every duration
in milliseconds or weeks for example.
Some durations allow you to use a special value to mean unlimited.
Units are specified as follows.
ms
: milliseconds
s
: seconds
m
: minutes
h
: hours
d
: days
w
: weeks
A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.
No
No
None
Yes (Use --advanced in interactive mode.)
No
Specifies the maximum number of entries that we will allow in the cache.
2147483647
An integer value. Lower value is 0.
No
No
None
No
No
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.
90
An integer value. Lower value is 1. Upper value is 100.
No
No
None
No
No
Entry Caches of type soft-reference-entry-cache have the following properties:
Specifies the cache level in the cache order if more than one instance of the cache is configured.
None
An integer value. Lower value is 1.
No
Yes
None
No
No
Indicates whether the Entry Cache is enabled.
None
true
false
No
Yes
None
No
No
The set of filters that define the entries that should be excluded from the cache.
None
A String
Yes
No
None
No
No
The set of filters that define the entries that should be included in the cache.
None
A String
Yes
No
None
No
No
Specifies the fully-qualified name of the Java class that provides the Soft Reference Entry Cache implementation.
org.opends.server.extensions.SoftReferenceEntryCache
A Java class that implements or extends the class(es): org.opends.server.api.EntryCache
No
Yes
The Entry Cache must be disabled and re-enabled for changes to this setting to take effect
Yes (Use --advanced in interactive mode.)
No
Specifies the length of time in milliseconds to wait while attempting to acquire a read or write lock.
3000ms
Some property values take a time duration.
Durations are expressed as numbers followed by units.
For example 1 s
means one second,
and 2 w
means two weeks.
Some durations have minimum granularity or maximum units,
so you cannot necessary specify every duration
in milliseconds or weeks for example.
Some durations allow you to use a special value to mean unlimited.
Units are specified as follows.
ms
: milliseconds
s
: seconds
m
: minutes
h
: hours
d
: days
w
: weeks
A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.
No
No
None
Yes (Use --advanced in interactive mode.)
No