The <init-param> element in the Coherence operational configuration deployment descriptor defines initialization parameters for a service or filter. The parameters that appear under init-param will be different, depending on the service or filter you are working with.
The following sections describe the parameters that can be configured for these services and filters:
The tables in each section describe the specific <param-name> — <param-value> pairs that can be configured for various elements. The Parameter Name column refers to the value of the param-name element and Value Description column refers to the possible values for the corresponding param-value element.
For example, the sample entry in Table I-1 means that the init-params element may look like the configuration in Example I-1 or Example I-2.
| Parameter Value | Value Description |
|---|---|
|
|
Specifies whether this member of the |
Example I-1 Sample init-param Configuration
...
<init-params>
<init-param>
<param-name>local-storage</param-name>
<param-value>false</param-value>
</init-param>
</init-params>
...
or as follows:
Example I-2 Another Sample init-param Configuration
...
<init-params>
<init-param>
<param-name>local-storage</param-name>
<param-value>true</param-value>
</init-param>
</init-params>
...
DistributedCache <services> elements support the parameters described in Table I-2. These settings may also be specified as part of the <distributed-scheme> element in the Cache Configuration Elements descriptor coherence-cache-config.xml.
Table I-2 DistributedCache Service Parameters
| Parameter Name | Value, Description |
|---|---|
|
|
Specifies the number of members of the DistributedCache service that hold the backup data for each unit of storage in the cache. Value of 0 means that in the case of abnormal termination, some portion of the data in the cache will be lost. Value of N means that if up to N cluster nodes terminate immediately, the cache data will be preserved. To maintain the distributed cache of size M, the total memory usage in the cluster does not depend on the number of cluster nodes and will be in the order of M*(N+1). Recommended values are 0, 1 or 2. Default value is 1. |
|
|
Only applicable with the custom type. Specifies a class name for the custom storage implementation. If the class implements |
|
|
Only applicable with the file-mapped type. Specifies the path name for the directory that the disk persistence manager ( Default value is the default temporary directory designated by the Java runtime. |
|
|
Only applicable with the off-heap and file-mapped types.Specifies the initial buffer size in bytes.The value of this element must be in the following format:
If the value does not contain a factor, a factor of Legal values are positive integers between Default value is |
|
|
Only applicable with the off-heap and file-mapped types.Specifies the maximum buffer size in bytes.The value of this element must be in the following format:
If the value does not contain a factor, a factor of Legal values are positive integers between Default value is |
|
|
Only applicable with the scheme type. Specifies a scheme name for the |
|
|
Specifies the type of the storage used to hold the backup data. Legal values are:
Default value is Preconfigured value is |
|
|
Specifies the name of a class that implements the |
|
|
Specifies the name of a class that implements the |
|
|
Specifies the lease ownership granularity. Available since release 2.3.Legal values are:
A value of Default value is |
|
|
Specifies whether this member of the DistributedCache service enables local storage. Normally this value should be left unspecified within the configuration file, and instead set on a per-process basis using the Legal values are Preconfigured value is |
|
|
Specifies the number of partitions that a distributed cache will be "chopped up" into. Each member running the distributed cache service that has the A list of first 1,000 primes can be found at http://www.utm.edu/research/primes/lists/small/1000.txt. Legal values are prime numbers. Default value is 257. |
|
|
Specifies the name of a class that implements the |
|
|
Specifies the maximum amount of time a client will wait for a response before abandoning the original request. The request time is measured on the client side as the time elapsed from the moment a request is sent for execution to the corresponding server node(s) and includes the following:
Legal values are positive integers or zero (indicating no default timeout). |
|
|
Specifies the duration of the standard lease in milliseconds. When a lease has aged past this number of milliseconds, the lock will automatically be released. Set this value to zero to specify a lease that never expires. The purpose of this setting is to avoid deadlocks or blocks caused by stuck threads; the value should be set higher than the longest expected lock duration (for example, higher than a transaction timeout). It's also recommended to set this value higher then Legal values are from positive long numbers or zero. Default value is 0. |
|
|
Specifies the amount of time in milliseconds that a task can execute before it is considered "hung". Note: a posted task that has not yet started is never considered as hung. This attribute is applied only if the Thread pool is used (the Legal values are positive integers or zero (indicating no default timeout). |
|
|
Specifies the default timeout value in milliseconds for tasks that can be timed-out (for example, implement the Legal values are positive integers or zero (indicating no default timeout). |
|
Specifies the number of daemon threads used by the distributed cache service. If zero, all relevant tasks are performed on the service thread. Legal values are from positive integers or zero. Default value is 0. Preconfigured value is |
|
|
|
Specifies the threshold for the primary buckets distribution in kilobytes. When a new node joins the distributed cache service or when a member of the service leaves, the remaining nodes perform a task of bucket ownership re-distribution. During this process, the existing data gets rebalanced along with the ownership information. This parameter indicates a preferred message size for data transfer communications. Setting this value lower will make the distribution process take longer, but will reduce network bandwidth utilization during this activity. Legal values are integers greater then zero. Default value is 512 (0.5MB). Preconfigured value is |
ReplicatedCache services elements support the parameters described in Table I-3. These settings may also be specified as part of the replicated-scheme element in the Cache Configuration Elements descriptor coherence-cache-config.xml.
Table I-3 ReplicatedCache Service Parameters
| Parameter Name | Value Description |
|---|---|
|
|
Specifies the lease ownership granularity. Available since release 2.3.Legal values are:
A value of Default value is |
|
|
Specifies whether lease issues should be transferred to the most recent lock holders. Legal values are Default value is |
|
|
Specifies the duration of the standard lease in milliseconds. When a lease has aged past this number of milliseconds, the lock will automatically be released. Set this value to zero to specify a lease that never expires. The purpose of this setting is to avoid deadlocks or blocks caused by stuck threads; the value should be set higher than the longest expected lock duration (for example, higher than a transaction timeout). It's also recommended to set this value higher then packet-delivery/timeout-milliseconds value. Legal values are from positive long numbers or zero. Default value is 0. |
InvocationService services elements support the following parameters listed in Table I-4. These settings may also be specified as part of the invocation-scheme element in the Cache Configuration Elements descriptor coherence-cache-config.xml.
Table I-4 InvocationService Parameters
| Parameter Name | Value, Description |
|---|---|
|
|
Specifies the default timeout value in milliseconds for requests that can time-out (for example, implement the
Legal values are positive integers or zero (indicating no default timeout). |
|
|
Specifies the amount of time in milliseconds that a task can execute before it is considered "hung". Note: a posted task that has not yet started is never considered as hung. This attribute is applied only if the Thread pool is used (the |
|
|
Specifies the default timeout value in milliseconds for tasks that can be timed-out (for example, implement the Legal values are positive integers or zero (indicating no default timeout). |
|
|
Specifies the number of daemon threads to be used by the invocation service. If zero, all relevant tasks are performed on the service thread. Legal values are from positive integers or zero. Preconfigured value is Default value is 0. |
ProxyService services elements support the parameters described in Table I-5. These settings may also be specified as part of the proxy-scheme element in the Cache Configuration Elements descriptor coherence-cache-config.xml.
The compression filters (com.tangosol.net.CompressionFilter), supports the parameters described in Table I-6 (see java.util.zip.Deflater for details).
Table I-6 Compression Filter Parameters
| Parameter Name | Value Description |
|---|---|
|
|
Specifies compression buffer length in bytes. Legal values are positive integers or zero. Default value is 0. |
|
|
Specifies the compression level. Legal values are:
Default value is default. |
|
|
Specifies the compressions strategy. Legal values are:
Default value is gzip. |