B Cache Configuration Elements

Optional

The maximum number of simultaneous connections allowed by this connection acceptor. Valid values are positive integers and zero. A value of zero implies no limit. Default value is zero.

Optional

Specifies the configuration information used by the connection acceptor to detect dropped client-to-cluster connections.

Optional

Specifies the class configuration information for a com.tangosol.io.Serializer implementation used by the connection acceptor to serialize and deserialize user types. For example, the following configures a ConfigurablePofContext that uses the my-pof-types.xml POF type configuration file to deserialize user types to and from a POF stream:

<serializer>
  <class-name>com.tangosol.io.pof.ConfigurablePofContext</class-name>
  <init-params>
    <init-param>
      <param-type>string</param-type>
      <param-value>my-pof-types.xml</param-value>
    </init-param>
  </init-params>
</serializer>

Optional

Specifies the configuration information for a connection acceptor that enables Coherence*Extend clients to connect to the cluster over TCP/IP.

Optional

Contains the list of filter names to be used by this connection acceptor. For example, specifying <use-filter> as follows will activate gzip compression for all network messages, which can help substantially with WAN and low-bandwidth networks.

<use-filters>
    <filter-name>gzip</filter-name>
</use-filters>

Optional

Specifies the fully qualified name of a class that implements the com.tangosol.net.AddressProvider interface.

This element cannot be used together with the <class-factory-name> element.

Optional

Specifies the fully qualified name of a factory class for creating address provider instances. The instances must implement the com.tangosol.net.AddressProvider interface.

This element cannot be used together with the <class-name> element and is used together with the <method-name> element.

Optional

Specifies the name of a static factory method on the factory class which will perform object instantiation.

Optional

Specifies initialization parameters which are accessible by implementations which support the com.tangosol.run.xml.XmlConfigurable interface, or which include a public constructor with a matching signature. Initialization parameters can be specified for both the <class-name> element and the <class-factory-name> element.

Optional

Specifies the maximum number of bytes that will be queued to be written asynchronously. Setting the value to zero does not disable the asynchronous writes; instead, it indicates that the implementation default for the maximum number of bytes are necessaries value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K (kilo, 210)

• M (mega, 220)

If the value does not contain a factor, a factor of one is assumed. Valid values are any positive memory sizes and zero. Default value is 4MB.

Optional

Configures the external cache to use Berkeley Database JE on disk databases for cache storage.

Optional

Specifies a custom implementation of the async-store-manager. Any custom implementation must extend the com.tangosol.io.AsyncBinaryStoreManager class and declare the exact same set of public constructors.

Optional

Configures the external cache to use a custom storage manager implementation.

Optional

Specifies initialization parameters, for use in custom async-store-manager implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Configures the external cache to use a Coherence LH on disk database for cache storage.

Optional

Configures the external cache to use a memory-mapped file for cache storage.

Optional

Configures the external cache to use an off JVM heap, memory region for cache storage.

Optional

Specifies an IP address or hostname. If any are specified, only hosts with specified host-addresses or within the specified host-ranges will be allowed to join the cluster. The content override attributes id can be optionally used to fully or partially override the contents of this element with XML document that is external to the base document.

Optional

Specifies a range of IP addresses. If any are specified, only hosts with specified host-addresses or within the specified host-ranges will be allowed to join the cluster.

Optional

Specifies class configuration information for a com.tangosol.util.Filter implementation that is used by a TCP/IP acceptor to determine whether to accept a particular TCP/IP initiator. The evaluate() method will be passed to the java.net.InetAddress of the client. Implementations should return true to allow the client to connect. Classes are specified using the <class-name> subelement. Any initialization parameters can be defined within an <init-params> subelement.

Optional

Specifies whether the backing map itself is partitioned. It is respected only within a distributed-scheme. See Chapter 12, "Implementing Storage and Backing Maps."

Optional

Class schemes provide a mechanism for instantiating an arbitrary Java object for use by other schemes. The scheme which contains this element will dictate what class or interface(s) must be extended.

Optional

External schemes define caches which are not JVM heap based, allowing for greater storage capacity.

Optional

Local cache schemes define in-memory "local" caches. Local caches are generally nested within other cache schemes, for instance as the front-tier of a near scheme.

Optional

As with external-scheme, paged-external-schemes define caches which are not JVM heap based, allowing for greater storage capacity.

Optional

The overflow-scheme defines a two-tier cache consisting of a fast, size limited front-tier, and slower but much higher capacity back-tier cache.

Optional

The read-write-backing-map-scheme defines a backing map which provides a size limited cache of a persistent store.

Optional

The versioned-backing-map-scheme is an extension of a read-write-backing-map-scheme, defining a size limited cache of a persistent store. It uses object versioning to determine what updates need to be written to the persistent store.

Required

Specifies the type of the storage used to hold the backup data. Legal values are:

• on-heap—The corresponding implementations class is java.util.HashMap.

• off-heap—The corresponding implementations class is com.tangosol.io.nio.BinaryMap using the com.tangosol.io.nio.DirectBufferManager.

• file-mapped—The corresponding implementations class is com.tangosol.io.nio.BinaryMap using the com.tangosol.io.nio.MappedBufferManager.

• custom—The corresponding implementations class is the class specified by the class-name element.

• scheme—The corresponding implementations class is specified as a caching-scheme by the scheme-name element.

Default value is the value specified in the tangosol-coherence.xml descriptor. For more information, see the <backup-storage/type> parameter in "DistributedCache Service Parameters".

Optional

Only applicable with the custom type. Specifies a class name for the custom storage implementation. If the class implements com.tangosol.run.xml.XmlConfigurable interface then upon construction, the setConfig method is called passing the entire backup-storage element. Default value is the backup-storage/class-name value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

Only applicable with the file-mapped type. Specifies the path name for the directory that the disk persistence manager (com.tangosol.util.nio.MappedBufferManager) will use as "root" to store files in. If not specified or specifies a non-existent directory, a temporary file in the default location is used. Default value is the backup-storage/directory value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

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:

[\d]+[[.][\d]]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is the backup-storage/initial-size value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

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:

[\d]+[[.][\d]]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is the backup-storage/maximum-size value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

Only applicable with the scheme type. Specifies a scheme name for the ConfigurableCacheFactory. Default value is the backup-storage/scheme-name value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

Specifies a custom implementation of the Berkeley Database BinaryStoreManager. Any custom implementation must extend the com.tangosol.io.bdb.BerkeleyDBBinaryStoreManager class and declare the exact same set of public constructors.

Optional

Specifies the path name to the root directory where the Berkeley Database JE store manager will store files. If not specified or specified with a non-existent directory, a temporary directory in the default location will be used.

Optional

Specifies additional Berkeley DB configuration settings. See the Berkeley DB Configuration instructions:

http://www.oracle.com/technology/documentation/berkeley-db/je/GettingStartedGuide/administration.html#propertyfile

Also used to specify initialization parameters, for use in custom implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies the name for a database table that the Berkeley Database JE store manager will use to store data in. Specifying this parameter will cause the bdb-store-manager to use non-temporary (persistent) database instances. This is intended only for local caches that are backed by a cache loader from a non-temporary store, so that the local cache can be pre-populated from the disk on startup. This setting should not be enabled with replicated or distributed caches. Normally, the <store-name> element should be left unspecified, indicating that temporary storage is to be used.

When specifying this property, it is recommended to use the {cache-name} macro. See "Using Parameter Macros" for more information on the {cache-name} macro.

Optional

Specifies whether the auto adjustment of the preferred-size value (based on the run-time statistics) is allowed.

Valid values are true or false. Default value is false.

Optional

Specifies the maximum amount of time in milliseconds that individual execution requests are allowed to be deferred for a purpose of "bundling" them together and passing into a corresponding bulk operation. If the preferred-size threshold is reached before the specified delay, the bundle is processed immediately.

Valid values are positive numbers. Default value is 1.

Required

Specifies the operation name for which calls performed concurrently on multiple threads will be "bundled" into a functionally analogous "bulk" operation that takes a collection of arguments instead of a single one.

Valid values depend on the bundle configuration context. For the <cachestore-scheme> the valid operations are:

• load"

• store

• erase

For the <distributed-scheme> and <remote-cache-scheme> the valid operations are:

• get

• put

• remove

In all cases there is a pseudo operation named all, referring to all valid operations. Default value is all.

Optional

Specifies the bundle size threshold. When a bundle size reaches this value, the corresponding "bulk" operation will be invoked immediately. This value is measured in context-specific units.

Valid values are zero (disabled bundling) or positive values. Default value is zero.

Optional

Specifies the minimum number of threads that must be concurrently executing individual (non-bundled) requests for the bundler to switch from a pass-through to a bundling mode.

Valid values are positive numbers. Default value is 4.

Required

Specifies the caching-scheme that will be used for caches, based on the cache's name.

Required

Defines the available caching-schemes for use in the cluster.

Optional

Defines factory wide default settings.

Required

Specifies a cache name or name pattern. The name is unique within a cache factory.The following cache name patterns are supported:

• exact match, for example, MyCache

• prefix match, for example, My* that matches to any cache name starting with My

• any match "*", that matches to any cache name

The patterns get matched in the order of specificity (more specific definition is selected whenever possible). For example, if both MyCache and My* mappings are specified, the scheme from the MyCache mapping will be used to configure a cache named MyCache.

Required

Contains the caching scheme name. The name is unique within a configuration file. Caching schemes are configured in the caching-schemes element.

Optional

Allows specifying replaceable cache scheme parameters. During cache scheme parsing, any occurrence of any replaceable parameter in format param-name is replaced with the corresponding parameter value. Consider the following cache mapping example:

<cache-mapping>
  <cache-name>My*</cache-name>
  <scheme-name>my-scheme</scheme-name>
  <init-params>
    <init-param>
      <param-name>cache-loader</param-name>
      <param-value>com.acme.MyCacheLoader</param-value>
    </init-param>
    <init-param>
      <param-name>size-limit</param-name>
      <param-value>1000</param-value>
    </init-param>
  </init-params>
</cache-mapping>

For any cache name match My*, any occurrence of the literal cache-loader in any part of the corresponding cache-scheme element will be replaced with the string com.acme.MyCacheLoader and any occurrence of the literal size-limit will be replaced with the value of 1000.

Optional

Specifies whether the cache service proxy is enabled. If disabled, clients will not be able to access any proxied caches. Legal values are true or false. Default value is true.

Optional

Specifies whether lock requests from remote clients are permitted on a proxied cache. Legal values are true or false. Default value is false.

Optional

Specifies whether requests from remote clients that update a cache are prohibited on a proxied cache. Legal values are true or false. Default value is false.

Optional

Specifies the fully qualified name of a class that implements the com.tangosol.net.CacheService interface. The class acts as an interceptor between a client and a proxied cache service in order to implement custom processing as required. For example, the class could be used to perform authorization checks before allowing the use of the proxied cache service.

Optional

Contains initialization parameters for the CacheService implementation.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance".

Optional

Specifies the implementation of the cache store. The specified class must implement one of the following two interfaces.

• com.tangosol.net.cache.CacheStore—for read-write support

• com.tangosol.net.cache.CacheLoader—for read-only support

Optional

Configures the cachestore-scheme to use Coherence*Extend as its cache store implementation.

Optional

Specifies the configuration information for a bundling strategy.

Required

Contains a single binding between a cache name and the caching scheme this cache will use.

Optional

Defines a cache scheme which provides on-heap cache storage.

Optional

Defines a cache scheme which provides off-heap cache storage, for instance on disk.

Optional

Defines a cache scheme which provides off-heap cache storage, that is size-limited by using time based paging.

Optional

Defines a cache scheme where storage of cache entries is partitioned across the cluster nodes.

Optional

Defines a cache scheme where storage of cache entries is partitioned across the cluster nodes with transactional guarantees.

Optional

Defines a cache scheme where each cache entry is stored on all cluster nodes.

Optional

Defines a replicated cache scheme which uses optimistic rather then pessimistic locking.

Optional

Defines a two tier cache scheme which consists of a fast local front-tier cache of a much larger back-tier cache.

Optional

Defines a near-scheme which uses object versioning to ensure coherence between the front and back tiers.

Optional

Defines a two tier cache scheme where entries evicted from a size-limited front-tier overflow and are stored in a much larger back-tier cache.

Optional

Defines an invocation service which can be used for performing custom operations in parallel across cluster nodes.

Optional

Defines a backing map scheme which provides a cache of a persistent store.

Optional

Defines a backing map scheme which uses object versioning to determine what updates need to be written to the persistent store.

Optional

Defines a cache scheme that enables caches to be accessed from outside a Coherence cluster by using Coherence*Extend.

Optional

Defines a cache scheme using a custom cache implementation. Any custom implementation must implement the java.util.Map interface, and include a zero-parameter public constructor. Additionally if the contents of the Map can be modified by anything other than the CacheService itself (for example, if the Map automatically expires its entries periodically or size-limits its contents), then the returned object must implement the com.tangosol.util.ObservableMap interface.

Optional

Note: As of Coherence 3.0, the disk-scheme configuration element has been deprecated and replaced by the external-scheme and paged-external-scheme configuration elements.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Contains a fully specified Java class name to instantiate. This class must extend an appropriate implementation class as dictated by the containing scheme and must declare the exact same set of public constructors as the superclass.

Optional

Specifies a fully specified name of a Java class that will be used as a factory for object instantiation.

Optional

Specifies the name of a static factory method on the factory class which will perform object instantiation.

Optional

Specifies initialization parameters which are accessible by implementations which support the com.tangosol.run.xml.XmlConfigurable interface, or which include a public constructor with a matching signature.

Required

Specifies the implementation of the store manager. The specified class must implement the com.tangosol.io.BinaryStoreManager interface.

Optional

Specifies initialization parameters, for use in custom store manager implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Specifies either: the configuration information for a socket provider, or it references a pre-defined socket provider within the <socket-providers> element of the operational deployment descriptor. Pre-defined socket providers are referred to using their id attribute name: system or ssl. For example:

<socket-provider>ssl</socket-provider>

This setting only specifies the default socket provider for Coherence*Extend services. The TCMP socket provider is specified within the <unicast-listener> element in the operational configuration.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage caches created from this scheme. Services are configured in the <services> element in the tangosol-coherence.xml descriptor. See Appendix A, "Operational Configuration Elements" for more information.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies an implementation of a com.tangosol.MapListener which will be notified of events occurring on the cache.

Optional

Specifies what type of cache will be used within the cache server to store the entries.

Legal schemes are:

• local-scheme

• external-scheme

• paged-external-scheme

• class-scheme

• overflow-scheme

• read-write-backing-map-scheme

• versioned-backing-map-scheme

Note that when using an off-heap backing map it is important that the corresponding <backup-storage> be configured for off-heap (potentially using the same scheme as the backing-map). Here off-heap refers to any storage where some or all entries are stored outside of the JVMs garbage collected heap space. Examples include: <overflow-scheme> and <external-scheme>. See "Partitioned Cache with Overflow" for an example configuration.

Optional

Specifies the number of partitions that a partitioned (distributed) cache will be "chopped up" into. Each member running the partitioned cache service that has the local-storage (<local-storage> subelement) option set to true will manage a "fair" (balanced) number of partitions.

The number of partitions should be a prime number and sufficiently large such that a given partition is expected to be no larger than 50MB in size.

The following are good defaults based on service storage sizes:

service storage     partition-count
_______________     ______________
   100M                  257
     1G                  509
    10G                 2039
    50G                 4093
   100G                 8191

A list of first 1,000 primes can be found at

http://primes.utm.edu/lists/

Valid values are positive integers. The default value is 257 as specified in the tangosol-coherence.xml descriptor. See the partition-count parameter in "DistributedCache Service Parameters".

Optional

Specifies a class that will be responsible for providing associations between keys and allowing associated keys to reside on the same partition. This implementation must have a zero-parameter public constructor.

Optional

Specifies a class that implements the com.tangosol.net.partition.KeyPartitioningStrategy interface, which will be responsible for assigning keys to partitions. This implementation must have a zero-parameter public constructor. If unspecified, the default key partitioning algorithm will be used, which ensures that keys are evenly segmented across partitions.

Optional

Specifies a class that implements the com.tangosol.net.partition.PartitionListener interface.

Optional

Specifies the number of members of the partitioned cache 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 partitioned 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 or 1. Default value is the backup-count value specified in the tangosol-coherence.xml descriptor. See the backup-count parameter in value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

Specifies the number of members of the partitioned cache service that will hold the backup data for each unit of storage in the cache that does not require write-behind, that is, data that is not vulnerable to being lost even if the entire cluster were shut down. Specifically, if a unit of storage is marked as requiring write-behind, then it will be backed up on the number of members specified by the <backup-count> subelement, and if the unit of storage is not marked as requiring write-behind, then it will be backed up by the number of members specified by the <backup-count-after-writebehind> element.

This value should be set to 0 or this setting should not be specified at all. The rationale is that since this data is being backed up to another data store, no in-memory backup is required, other than the data temporarily queued on the write-behind queue to be written. The value of 0 means that when write-behind has occurred, the backup copies of that data will be discarded. However, until write-behind occurs, the data will be backed up in accordance with the <backup-count> setting.

Recommended value is 0 or this element should be omitted altogether.

Optional

Specifies the type and configuration for the partitioned cache backup storage.

Optional

Specifies the number of daemon threads used by the partitioned cache service. If zero, all relevant tasks are performed on the service thread. Legal values are positive integers or zero. Default value is the thread-count value specified in the tangosol-coherence.xml descriptor. See the thread-count parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the lease ownership granularity. Available since release 2.3.Legal values are:

• thread

• member

A value of thread means that locks are held by a thread that obtained them and can only be released by that thread. A value of member means that locks are held by a cluster node and any thread running on the cluster node that obtained the lock can release it. Default value is the lease-granularity value specified in the tangosol-coherence.xml descriptor. See the lease-granularity parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the threshold for the primary buckets distribution in kilo-bytes. When a new node joins the partitioned 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 re-balanced 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 the transfer-threshold value specified in the tangosol-coherence.xml descriptor. See the transfer-threshold parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies whether a cluster node will contribute storage to the cluster, that is, maintain partitions. When disabled the node is considered a cache client.

Normally this value should be left unspecified within the configuration file, and instead set on a per-process basis using the tangosol.coherence.distributed.localstorage system property. This allows cache clients and servers to use the same configuration descriptor.

Legal values are true or false. Default value is the local-storage value specified in the tangosol-coherence.xml descriptor. See the local-storage parameter in "DistributedCache Service Parameters" for more information.

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether the cache services associated with this cache scheme should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

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 thread-count value is positive). Legal values are positive integers or zero (indicating no default timeout). Default value is the task-hung-threshold value specified in the tangosol-coherence.xml descriptor. See the task-hung-threshold parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the timeout value in milliseconds for requests executing on the service worker threads. This attribute is applied only if the thread pool is used (the thread-count value is positive). If zero is specified, the default service-guardian <timeout-milliseconds> value is used. Legal values are non-negative integers. Default value is the value specified in the tangosol-coherence.xml descriptor. See the task-timeout parameter in "DistributedCache Service Parameters".

Optional

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:

• the time it takes to deliver the request to an executing node (server)

• the interval between the time the task is received and placed into a service queue until the execution starts

• the task execution time

• the time it takes to deliver a result back to the client

Legal values are positive integers or zero (indicating no default timeout). Default value is the value specified in the tangosol-coherence.xml descriptor. See the request-timeout parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies the configuration information for a class that implements the com.tangosol.net.MemberListener interface. The implementation must have a public default constructor.

The MemberListener implementation receives cache service lifecycle events. The <member-listener> element is used as an alternative to programmatically adding a MapListener on a service.

Optional

Specifies the configuration information for a bundling strategy.

Optional

Specifies quorum policy settings for the partitioned cache service.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information

Optional

Specifies a custom implementation of the external cache. Any custom implementation must extend one of the following classes:

• com.tangosol.net.cache.SerializationCache—for size limited caches

• com.tangosol.net.cache.SerializationMap—for unlimited size caches

• com.tangosol.net.cache.SimpleSerializationMap—for unlimited size caches

and declare the exact same set of public constructors as the superclass.

Optional

Specifies initialization parameters, for use in custom external cache implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Used to limit the size of the cache. Contains the maximum number of units that can be placed in the cache before pruning occurs. An entry is the unit of measurement. When this limit is exceeded, the cache will begin the pruning process, evicting the least recently used entries until the number of units is brought below this limit. The scheme's class-name element may be used to provide custom extensions to SerializationCache, which implement alternative eviction policies. Legal values are positive integers or zero. Zero implies no limit. Default value is zero.

Optional

Specifies the type of unit calculator to use. A unit calculator is used to determine the cost (in "units") of a given object. Legal values are:

• FIXED—A unit calculator that assigns an equal weight of 1 to all cached objects.

• BINARY—A unit calculator that assigns an object a weight equal to the number of bytes of memory required to cache the object. This requires that the objects are com.tangosol.util.Binary instances, as in a Partitioned cache. See com.tangosol.net.cache.BinaryMemoryCalculator for additional details.

• <class-scheme>— A custom unit calculator, specified as a class-scheme. The class specified within this scheme must implement the com/tangosol/net/cache/ConfigurableCacheMap.UnitCalculator interface.

This element is used only if the high-units element is set to a positive number. Default value is FIXED.

Optional

The unit-factor element specifies the factor by which the units, low-units and high-units properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.

Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.

Note: This element was introduced only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values and is used only if the high-units element is set to a positive number. It is expected that this element will be dropped in a future release.

Valid values are positive integer numbers. Default value is 1.

Optional

Specifies the amount of time since the last update that entries are kept by the cache before being expired. Entries that have expired are not be accessible and are evicted the next time a client accesses the cache.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of seconds is assumed. A value of zero implies no expiry. The default value is 0.

Note: The expiry delay parameter (cExpiryMillis) is defined as an integer and is expressed in milliseconds. Therefore, the maximum amount of time can never exceed Integer.MAX_VALUE (2147483647) milliseconds or approximately 24 days.

Optional

Configures the external cache to use an asynchronous storage manager wrapper for any other storage manager. See "Pluggable Storage Manager"

Optional

Configures the external cache to use a custom storage manager implementation.

Optional

Configures the external cache to use Berkeley Database JE on disk databases for cache storage.

Optional

Configures the external cache to use a Coherence LH on disk database for cache storage.

Optional

Configures the external cache to use a memory-mapped file for cache storage.

Optional

Configures the external cache to use an off JVM heap, memory region for cache storage.

Optional

Specifies the algorithm used by the identity manager. The default value is SunX509.

Optional

Specifies the configuration for a security provider instance.

Optional

Specifies the configuration for a key store implementation.

Required

Specifies the private key password.

Optional

Specifies the configuration information used by the connection initiator to detect dropped client-to-cluster connections.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies the configuration information for a connection initiator that connects to the cluster over TCP/IP.

Optional

Contains the list of filter names to be used by this connection initiator. In the following example, specifying <use-filter> will activate gzip compression for all network messages, which can help substantially with WAN and low-bandwidth networks.

<use-filters>
    <filter-name>gzip</filter-name>
</use-filters>

Optional

Contains the name of the initialization parameter. For example:

<class-name>com.mycompany.cache.CustomCacheLoader</class-name>
<init-params>
  <init-param>
    <param-name>sTableName</param-name>
    <param-value>EmployeeTable</param-value>
  </init-param>
  <init-param>
    <param-name>iMaxSize</param-name>
    <param-value>2000</param-value>
  </init-param>
</init-params>

Optional

Contains the Java type of the initialization parameter.The following standard types are supported:

• java.lang.String (a.k.a. string)

• java.lang.Boolean (a.k.a. boolean)

• java.lang.Integer (a.k.a. int)

• java.lang.Long (a.k.a. long)

• java.lang.Double (a.k.a. double)

• java.math.BigDecimal

• java.io.File

• java.sql.Date

• java.sql.Time

• java.sql.Timestamp

For example:

<class-name>com.mycompany.cache.CustomCacheLoader</class-name>
<init-params>
  <init-param>
    <param-type>java.lang.String</param-type>
    <param-value>EmployeeTable</param-value>
  </init-param>
  <init-param>
    <param-type>int</param-type>
    <param-value>2000</param-value>
  </init-param>
</init-params>

Optional

Contains the value of the initialization parameter. The value is in the format specific to the Java type of the parameter.

Optional

Defines an individual initialization parameter.

Optional

Specifies the fully qualified name of an implementation class.

This element cannot be used together with the <class-factory-name> element.

Optional

Specifies the fully qualified name of a factory class for creating implementation class instances.

This element cannot be used together with the <class-name> element and is used together with the <method-name> element.

Optional

Specifies the name of a static factory method on the factory class which will perform object instantiation.

Optional

Contains class initialization parameters for the implementation class.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage invocations from this scheme.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies the number of daemon threads used by the invocation service. If zero, all relevant tasks are performed on the service thread. Legal values are positive integers or zero. Default value is the thread-count value specified in the tangosol-coherence.xml descriptor. See the thread-count parameter in "InvocationService Parameters".

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether this service should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

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 thread-count value is positive). Legal values are positive integers or zero (indicating no default timeout). Default value is the task-hung-threshold value specified in the tangosol-coherence.xml descriptor. See the task-hung-threshold parameter in "InvocationService Parameters".

Optional

Specifies the default timeout value in milliseconds for tasks that can be timed-out (for example, implement the com.tangosol.net.PriorityTask interface), but don't explicitly specify the task execution timeout value. The task execution time is measured on the server side and does not include the time spent waiting in a service backlog queue before being started. This attribute is applied only if the thread pool is used (the thread-count value is positive). If zero is specified, the default service-guardian <timeout-milliseconds> value is used. Legal values are non-negative integers. Default value is the task-timeout value specified in the tangosol-coherence.xml descriptor. See the task-timeout parameter in "InvocationService Parameters".

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies the configuration information for a class that implements the com.tangosol.net.MemberListener interface. The implementation must have a public default constructor.

The MemberListener implementation receives service lifecycle events. The <member-listener> element is used as an alternative to programmatically adding a MapListener on a service.

Optional

Specifies the default timeout value in milliseconds for requests that can time-out (for example, implement the com.tangosol.net.PriorityTask interface), but don't explicitly specify the request timeout value. 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:

(1) the time it takes to deliver the request to an executing node (server); (2) the interval between the time the task is received and placed into a service queue until the execution starts; (3) the task execution time; (4) the time it takes to deliver a result back to the client.

Legal values are positive integers or zero (indicating no default timeout). Default value is the request-timeout value specified in the tangosol-coherence.xml descriptor. See the request-timeout parameter in "InvocationService Parameters".

Optional

Specifies whether the invocation service proxy is enabled. If disabled, clients will not be able to execute Invocable objects on the proxy service JVM. Legal values are true or false. Default value is true.

Optional

Specifies the fully qualified name of a class that implements the com.tangosol.net.InvocationService interface. The class acts as an interceptor between a client and a proxied invocation service in order to implement custom processing as required. For example, the class could be used to perform authorization checks before allowing the use of the proxied invocation service.

Optional

Contains initialization parameters for the InvocationService implementation.

Required

Specifies the JNDI name of the JMS QueueConnectionFactory used by the connection acceptor.

Required

Specifies the JNDI name of the JMS Queue used by the connection acceptor.

Required

Specifies the JNDI name of the JMS QueueConnectionFactory used by the connection initiator.

Required

Specifies the JNDI name of the JMS Queue used by the connection initiator.

Optional

Specifies the maximum amount of time to wait while establishing a connection with a connection acceptor. The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. Default value is an infinite timeout.

Required

The name of a class that implements the com.tangosol.net.partition.KeyAssociator interface. This implementation must have a zero-parameter public constructor. Default value is the value of the key-associator/class-name parameter specified in the tangosol.coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Required

The name of a class that implements the com.tangosol.net.partition.KeyPartitioningStrategy interface. This implementation must have a zero-parameter public constructor. Default value is the value of the key-partitioning/class-name parameter specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Required

Specifies the Uniform Resource Locator (URL) to a key store.

Optional

Specifies the password for the key store.

Optional

Specifies the type of a java.security.KeyStore instance. The default value is JKS.

Optional

Specifies a custom implementation of the LH BinaryStoreManager. Any custom implementation must extend the com.tangosol.io.lh.LHBinaryStoreManager class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom LH file manager implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies the path name for the root directory that the LH file manager will use to store files in. If not specified or specifies a non-existent directory, a temporary file in the default location will be used.

Optional

Specifies the name for a non-temporary (persistent) file that the LH file manager will use to store data in. Specifying this parameter will cause the lh-file-manager to use non-temporary database instances. Use this parameter only for local caches that are backed by a cache loader from a non-temporary file: this allows the local cache to be pre-populated from the disk file on startup. When specified it is recommended that it use the {cache-name} macro described in "Using Parameter Macros". Normally this parameter should be left unspecified, indicating that temporary storage is to be used.

Required

Specifies the full class name of the listener implementation to use. The specified class must implement the com.tangosol.util.MapListener interface.

Optional

Specifies the address (IP or DNS name) on which a TCP/IP socket listens and publishes.

Optional

Specifies the port on which a TCP/IP socket listens and publishes. Legal values are from 1 to 65535.

When used in the context of a TCP/IP server (that is, for a TCP acceptor), the port child element is required.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage caches created from this scheme. Services are configured from within the <services> element in the tangosol-coherence.xml descriptor. See Appendix A, "Operational Configuration Elements" for more information.

Optional

Specifies a custom implementation of the local cache. Any custom implementation must extend the com.tangosol.net.cache.LocalCache class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom local cache implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies the type of eviction policy to use.Legal values are:

• LRU - Least Recently Used eviction policy chooses which entries to evict based on how recently they were last accessed, evicting those that were not accessed the for the longest period first.

• LFU - Least Frequently Used eviction policy chooses which entries to evict based on how often they are being accessed, evicting those that are accessed least frequently first.

• HYBRID - Hybrid eviction policy chooses which entries to evict based on the combination (weighted score) of how often and recently they were accessed, evicting those that are accessed least frequently and were not accessed for the longest period first.

• <class-scheme> - A custom eviction policy, specified as a class-scheme. The class specified within this scheme must implement the com.tangosol.net.cache.LocalCache.EvictionPolicy interface.

Default value is HYBRID.

Optional

Used to limit the size of the cache. Contains the maximum number of units that can be placed in the cache before pruning occurs. An entry is the unit of measurement, unless it is overridden by an alternate unit-calculator (see <unit-calculator> subelement). When this limit is exceeded, the cache will begin the pruning process, evicting entries according to the eviction policy. Legal values are positive integers or zero. Zero implies no limit. Default value is 0.

Optional

Contains the lowest number of units that a cache will be pruned down to when pruning takes place. A pruning will not necessarily result in a cache containing this number of units, however a pruning will never result in a cache containing less than this number of units. An entry is the unit of measurement, unless it is overridden by an alternate unit-calculator (see <unit-calculator> subelement). When pruning occurs entries will continue to be evicted according to the eviction policy until this size. Legal values are positive integers or zero. Zero implies the default. Default value is 75% of the high-units setting (that is, for a high-units setting of 1000 the default low-units will be 750).

Optional

Specifies the type of unit calculator to use. A unit calculator is used to determine the cost (in "units") of a given object. Legal values are:

• FIXED—A unit calculator that assigns an equal weight of 1 to all cached objects.

• BINARY—A unit calculator that assigns an object a weight equal to the number of bytes of memory required to cache the object. This requires that the objects are com.tangosol.util.Binary instances, as in a Partitioned cache. See com.tangosol.net.cache.BinaryMemoryCalculator for additional details.

• <class-scheme>— A custom unit calculator, specified as a class-scheme. The class specified within this scheme must implement the com/tangosol/net/cache/ConfigurableCacheMap.UnitCalculator interface.

This element is used only if the high-units element is set to a positive number. Default value is FIXED.

Optional

The unit-factor element specifies the factor by which the units, low-units and high-units properties are adjusted. Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.

Using a BINARY unit calculator, for example, the factor of 1048576 could be used to count megabytes instead of bytes.

Note: This element was introduced only to avoid changing the type of the units, low units and high units properties from 32-bit values to 64-bit values and is used only if the high-units element is set to a positive number. It is expected that this element will be dropped in a future release.

Valid values are positive integer numbers. Default value is 1.

Optional

Specifies the amount of time since the last update that entries are kept by the cache before being expired. Entries that have expired are not be accessible and are evicted the next time a client accesses the cache. Any attempt to read an expired entry will result in a reloading of the entry from the configured cache store (see <cachestore-scheme>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of seconds is assumed. A value of zero implies no expiry. The default value is 0.

Note: The expiry delay parameter (cExpiryMillis) is defined as an integer and is expressed in milliseconds. Therefore, the maximum amount of time can never exceed Integer.MAX_VALUE (2147483647) milliseconds or approximately 24 days.

Optional

Specifies the store which is being cached. If unspecified the cached data will only reside in memory, and only reflect operations performed on the cache itself.

Optional

Specifies whether or not a cache will pre-load data from its CacheLoader (or CacheStore) object. Valid values are true and false. Default value is false.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information

Optional

Specifies a custom implementation of the near cache. Any custom implementation must extend the com.tangosol.net.cache.NearCache class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters for custom near cache implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Required

Specifies the cache-scheme to use in creating the front-tier cache.Legal values are:

• local-scheme

• external-scheme

• paged-external-scheme

• class-scheme

The eviction policy of the front-scheme defines which entries will be cached locally. For example:

<front-scheme>
  <local-scheme>
    <eviction-policy>HYBRID</eviction-policy>
    <high-units>1000</high-units>
  </local-scheme>
</front-scheme>

Required

Specifies the cache-scheme to use in creating the back-tier cache. Legal values are:

• distributed-scheme

• replicated-scheme

• optimistic-scheme

• local-scheme

• external-scheme

• paged-external-scheme

• class-scheme

• remote-cache-scheme

For example:

<back-scheme>
  <distributed-scheme>
    <scheme-ref>default-distributed</scheme-ref>
  </distributed-scheme>
</back-scheme>

Optional

Specifies the strategy used keep the front-tier in-sync with the back-tier. Please see com.tangosol.net.cache.NearCache for more details. Legal values are:

• none - instructs the cache not to listen for invalidation events at all. This is the best choice for raw performance and scalability when business requirements permit the use of data which might not be absolutely current. Freshness of data can be guaranteed by use of a sufficiently brief eviction policy. The worst case performance is identical to a standard Distributed cache.

• present - instructs the near cache to listen to the back map events related only to the items currently present in the front map. This strategy works best when cluster nodes have sticky data access patterns (for example, HTTP session management with a sticky load balancer).

• all - instructs the near cache to listen to all back map events. This strategy is optimal for read-heavy access patterns where there is significant overlap between the front caches on each cluster member.

• auto - instructs the near cache to switch between present and all strategies automatically based on the cache statistics.

Default value is auto.

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether the cache services associated with this cache scheme should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

Specifies a custom implementation of the local cache. Any custom implementation must extend the com.tangosol.io.nio.MappedStoreManager class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom nio-file-manager implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies the initial buffer size in megabytes.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is 1MB.

Optional

Specifies the maximum buffer size in bytes.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is 1024MB.

Optional

Specifies the path name for the root directory that the manager will use to store files in. If not specified or specifies a non-existent directory, a temporary file in the default location will be used.

Optional

Specifies a custom implementation of the local cache. Any custom implementation must extend the com.tangosol.io.nio.DirectStoreManager class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom nio-memory-manager implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies the initial buffer size in bytes. The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is 1MB.

Optional

Specifies the maximum buffer size in bytes. The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of mega is assumed. Legal values are positive integers between 1 and Integer.MAX_VALUE - 1023 (that is, 2,147,482,624 bytes). Default value is 1024MB.

Required

Describes one or more bundle-able operations.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage caches created from this scheme. Services are configured from within the <services> parameter in tangosol-coherence.xml. See Appendix A, "Operational Configuration Elements" for more information.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Specifies what type of cache will be used within the cache server to store the entries.Legal values are:

• local-scheme

• external-scheme

• paged-external-scheme

• overflow-scheme

• class-scheme

To ensure cache coherence, the backing-map of an optimistic cache must not use a read-through pattern to load cache entries. Either use a cache-aside pattern from outside the cache service, or switch to the distributed-scheme, which supports read-through clustered caching.

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies the configuration information for a class that implements the com.tangosol.net.MemberListener interface. The implementation must have a public default constructor.

The MemberListener implementation receives cache service lifecycle events. The <member-listener> element is used as an alternative to programmatically adding a MapListener on a service.

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether the cache services associated with this cache scheme should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

Specifies the interval between ping requests. A ping request is used to ensure the integrity of a connection.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. A value of zero disables ping requests. The default value is zero.

Optional

Specifies the maximum amount of time to wait for a response to a ping request before declaring the underlying connection unusable.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. The default value is the value of the request-timeout element.

Optional

Specifies the maximum amount of time to wait for a response message before declaring the underlying connection unusable.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. The default value is an infinite timeout.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies a custom implementation of the overflow cache. Any custom implementation must extend either the com.tangosol.net.cache.OverflowMap or com.tangosol.net.cache.SimpleOverflowMap class, and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom overflow cache implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Required

Specifies the cache-scheme to use in creating the front-tier cache.Legal values are:

• local-scheme

• external-scheme

• paged-external-scheme

• class-scheme

The eviction policy of the front-scheme defines which entries which items are in the front versus back tiers. For example:

<front-scheme>
  <local-scheme>
    <eviction-policy>HYBRID</eviction-policy>
    <high-units>1000</high-units>
  </local-scheme>
</front-scheme>

Required

Specifies the cache-scheme to use in creating the back-tier cache.Legal values are:

• local-scheme

• external-scheme

• paged-external-scheme

• class-scheme

For Example:

<back-scheme>
  <external-scheme>
    <lh-file-manager/>
  </external-scheme>
</back-scheme>

Optional

Specifies a cache-scheme for maintaining information on cache misses. For caches which are not expiry-enabled (see <expiry-enabled> subelement), the miss-cache is used track keys which resulted in both a front and back tier cache miss. The knowledge that a key is not in either tier allows some operations to perform faster, as they can avoid querying the potentially slow back-tier. A size limited scheme may be used to control how many misses are tracked. If unspecified no cache-miss data will be maintained. Legal values are:

• local-scheme

Optional

Turns on support for automatically-expiring data, as provided by the com.tangosol.net.cache.CacheMap API. When enabled the overflow-scheme will be implemented using com.tangosol.net.cache.OverflowMap, rather then com.tangosol.net.cache.SimpleOverflowMap. Legal values are true or false. Default value is false.

Optional

Specifies the amount of time since the last update that entries are kept by the cache before being expired. Entries that have expired are not be accessible and are evicted the next time a client accesses the cache.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of seconds is assumed. A value of zero implies no expiry. The default value is 0.

Note: The expiry delay parameter (cExpiryMillis) is defined as an integer and is expressed in milliseconds. Therefore, the maximum amount of time can never exceed Integer.MAX_VALUE (2147483647) milliseconds or approximately 24 days.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies a custom implementation of the external paged cache. Any custom implementation must extend the com.tangosol.net.cache.SerializationPagedCache class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom external paged cache implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Required

Specifies the maximum number of active pages for the paged cache. Legal values are positive integers between 2 and 3600.

Optional

Specifies the length of time, in seconds, that a page in the paged cache is current.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of seconds is assumed. Legal values are between 5 and 604800 seconds (one week) and zero (no expiry). Default value is zero

Optional

Configures the paged external cache to use an asynchronous storage manager wrapper for any other storage manager. See "Pluggable Storage Manager" for more information.

Optional

Configures the paged external cache to use a custom storage manager implementation.

Optional

Configures the paged external cache to use Berkeley Database JE on disk databases for cache storage.

Optional

Configures the paged external cache to use a Coherence LH on disk database for cache storage.

Optional

Configures the paged external cache to use a memory-mapped file for cache storage.

Optional

Configures the paged external cache to use an off JVM heap, memory region for cache storage.

Required

The name of a class that implements the PartitionListener interface. This implementation must have a zero-parameter public constructor. Default value is the value specified in the partition-listener/class-name parameter in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the minimum number of ownership-enabled members of a partitioned service that must be present in order to perform partition distribution.

The value must be a non-negative integer.

Optional

Specifies the minimum number of ownership-enabled members of a partitioned service that must be present in order to to restore lost primary partitions from backup.

The value must be a non-negative integer.

Optional

specifies the minimum number of storage members of a cache service that must be present in order to process "read" requests. A "read" request is any request that does not mutate the state or contents of a cache.

The value must be a non-negative integer.

Optional

specifies the minimum number of storage members of a cache service that must be present in order to process "write" requests. A "write" request is any request that may mutate the state or contents of a cache.

The value must be a non-negative integer.

Optional

Specifies a class that provides custom quorum policies. This element cannot be used together with the default quorum elements or the <class-factory-name> element.

The class must implement the com.tangosol.net.ActionPolicy interface. Initialization parameters can be specified using the <init-params> element.

Optional

Specifies a factory class for creating custom action policy instances. This element cannot be used together with the default quorum elements or the <class-name> element.

This element is used together with the <method-name> element. The action policy instances must implement the com.tangosol.net.ActionPolicy interface. In addition, initialization parameters can be specified using the <init-params> element.

Optional

Specifies the name of a security provider that extends the java.security.Provider class.

The class name can be entered using either this element or by using the <class-name> element or by using the <class-factory-name> element.

Optional

Specifies the name of a security provider that extends the java.security.Provider class.

This element cannot be used together with the <name> element or the <class-factory-name> element.

Optional

Specifies a factory class for creating Provider instances. The instances must implement the java.security.Provider class.

This element cannot be used together with the <name> element or the <class-name> element.

This element can be used together with the <method-name> element.

Optional

Specifies the name of a static factory method on the factory class which will perform object instantiation.

Optional

Contains class initialization parameters for the provider implementation.

This element cannot be used together with the <name> element.

Optional

Specifies the configuration information for a cache service proxy managed by the proxy service.

Optional

Specifies the configuration information for an invocation service proxy managed by the proxy service.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service.

Optional

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 thread-count value is positive). Legal values are positive integers or zero (indicating no default timeout). Default value is the value specified in the tangosol-coherence.xml descriptor. See the task-hung-threshold parameter in "ProxyService Parameters" for more information.

Optional

Specifies the timeout value in milliseconds for requests executing on the service worker threads. This attribute is applied only if the thread pool is used (the thread-count value is positive). If zero is specified, the default service-guardian <timeout-milliseconds> value is used. Legal values are non-negative integers. Default value is the value specified in the tangosol-coherence.xml descriptor. See the task-timeout parameter in "ProxyService Parameters".

Optional

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:

• the time it takes to deliver the request to an executing node (server)

• the interval between the time the task is received and placed into a service queue until the execution starts

• the task execution time

• the time it takes to deliver a result back to the client

Legal values are positive integers or zero (indicating no default timeout). Default value is the value specified in the tangosol-coherence.xml descriptor. See the request-timeout parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the number of daemon threads used by the service. If zero, all relevant tasks are performed on the service thread. Legal values are positive integers or zero. Default value is the value specified in the thread-count parameter of the tangosol-coherence.xml descriptor. See "ProxyService Parameters" for more information.

Required

Contains the configuration of the connection acceptor used by the service to accept connections from Coherence*Extend clients and to allow them to use the services offered by the cluster without having to join the cluster.

Optional

Contains the configuration of the clustered service proxies managed by this service.

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether this service should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies the configuration information for a class that implements the com.tangosol.net.MemberListener interface. The implementation must have a public default constructor.

The MemberListener implementation receives service lifecycle events. The <member-listener> element is used as an alternative to programmatically adding a MapListener on a service.

Optional

Specifies quorum policy settings for the Proxy service.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

specifies the minimum number of members of a proxy service that must be present in order to allow client connections.

The value must be a non-negative integer.

Optional

Specifies a class that provides custom quorum policies. This element cannot be used together with the <connect-quorum> element or the <class-factory-name> element.

The class must implement the com.tangosol.net.ActionPolicy interface. Initialization parameters can be specified using the <init-params> element.

Optional

Specifies a factory class for creating custom action policy instances. This element cannot be used together with the <connect-quorum> element or the <class-name> element.

This element is used together with the <method-name> element. The action policy instances must implement the com.tangosol.net.ActionPolicy interface. In addition, initialization parameters can be specified using the <init-params> element.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies a custom implementation of the read write backing map. Any custom implementation must extend the com.tangosol.net.cache.ReadWriteBackingMap class and declare the exact same set of public constructors.

Optional

Specifies initialization parameters, for use in custom read write backing map implementations which implement the com.tangosol.run.xml.XmlConfigurable interface.

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Specifies the store to cache. If unspecified the cached data will only reside within the internal cache (see <internal-cache-scheme> subelement), and only reflect operations performed on the cache itself.

Optional

Specifies the timeout interval to use for CacheStore read and write operations. If a CacheStore operation times out, the executing thread is interrupted and may ultimately lead to the termination of the cache service. Timeouts of asynchronous CacheStore operations (for example, refresh-ahead, write-behind) will not result in service termination. The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. If 0 is specified, the default service-guardian <timeout-milliseconds> value is used. The default value if none is specified is 0.

Required

Specifies a cache-scheme which will be used to cache entries. Legal values are:

• local-scheme

• disk-scheme

• external-scheme

• paged-external-scheme

• overflow-scheme

• class-scheme

Optional

Specifies a cache-scheme for maintaining information on cache misses. The miss-cache is used track keys which were not found in the cache store. The knowledge that a key is not in the cache store allows some operations to perform faster, as they can avoid querying the potentially slow cache store. A size-limited scheme may be used to control how many misses are cached. If unspecified no cache-miss data will be maintained. Legal values are:

• local-scheme

Optional

Specifies if the cache is read only. If true the cache will load data from cachestore for read operations and will not perform any writing to the cachestore when the cache is updated. Legal values are true or false. Default value is false.

Optional

Specifies the time interval for a write-behind queue to defer asynchronous writes to the cachestore by.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of seconds is assumed. If zero, synchronous writes to the cachestore (without queuing) will take place, otherwise the writes will be asynchronous and deferred by specified time interval after the last update to the value in the cache. Default is zero.

Optional

The write-batch-factor element is used to calculate the "soft-ripe" time for write-behind queue entries. A queue entry is considered to be "ripe" for a write operation if it has been in the write-behind queue for no less than the write-delay interval. The "soft-ripe" time is the point in time before the actual ripe time after which an entry will be included in a batched asynchronous write operation to the CacheStore (along with all other ripe and soft-ripe entries). In other words, a soft-ripe entry is an entry that has been in the write-behind queue for at least the following duration:

D' = (1.0 - F)*Dwhere:D = write-delay intervalF = write-batch-factor

Conceptually, the write-behind thread uses the following logic when performing a batched update:

1. The thread waits for a queued entry to become ripe.

2. When an entry becomes ripe, the thread dequeues all ripe and soft-ripe entries in the queue.

3. The thread then writes all ripe and soft-ripe entries either by using store() (if there is only the single ripe entry) or storeAll() (if there are multiple ripe/soft-ripe entries).

4. The thread then repeats (1).

This element is only applicable if asynchronous writes are enabled (that is, the value of the write-delay element is greater than zero) and the CacheStore implements the storeAll() method. The value of the element is expressed as a percentage of the write-delay interval. Legal values are nonnegative doubles less than or equal to 1.0. Default is zero.

Optional

Specifies the size of the write-behind queue at which additional actions could be taken. This value controls the frequency of the corresponding log messages. For example, a value of 100 will produce a log message every time the size of the write queue is a multiple of 100. If zero, write-behind requeuing is disabled. Legal values are positive integers or zero. Default is zero.

Optional

The refresh-ahead-factor element is used to calculate the "soft-expiration" time for cache entries. Soft-expiration is the point in time before the actual expiration after which any access request for an entry will schedule an asynchronous load request for the entry. This attribute is only applicable if the internal cache is a local-scheme, configured with the <expiry-delay> subelement. The value is expressed as a percentage of the internal LocalCache expiration interval. If zero, refresh-ahead scheduling will be disabled. If 1.0, then any get operation will immediately trigger an asynchronous reload. Legal values are nonnegative doubles less than or equal to 1.0. Default value is zero.

Optional

Specifies whether exceptions caught during synchronous cachestore operations are rethrown to the calling thread (possibly over the network to a remote member). If the value of this element is false, an exception caught during a synchronous cachestore operation is logged locally and the internal cache is updated. If the value is true, the exception is rethrown to the calling thread and the internal cache is not changed. If the operation was called within a transactional context, this would have the effect of rolling back the current transaction. Legal values are true or false. Default value is false.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage caches created from this scheme.

Optional

Specifies the configuration information for a bundling strategy.

Required

Contains the configuration of the connection initiator used by the service to establish a connection with the cluster.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service.

Required

Contains the configuration of the connection initiator used by the service to establish a connection with the cluster.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which will manage caches created from this scheme. Services are configured from within the <services> element in the tangosol-coherence.xml file. See Appendix A, "Operational Configuration Elements" for more information.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies an implementation of a com.tangosol.util.MapListener which will be notified of events occurring on the cache.

Optional

Specifies what type of cache will be used within the cache server to store the entries.Legal values are:

• local-scheme

• external-scheme

• paged-external-scheme

• overflow-scheme

• class-scheme

To ensure cache coherence, the backing-map of an replicated cache must not use a read-through pattern to load cache entries. Either use a cache-aside pattern from outside the cache service, or switch to the distributed-scheme, which supports read-through clustered caching.

Optional

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 than packet-delivery/timeout-milliseconds value. Legal values are from positive long numbers or zero. Default value is the value specified for packet-delivery/timeout-milliseconds in the tangosol-coherence.xml descriptor. See "ReplicatedCache Service Parameters" for more information.

Optional

Specifies the lease ownership granularity. Available since release 2.3.Legal values are:

• thread

• member

A value of thread means that locks are held by a thread that obtained them and can only be released by that thread. A value of member means that locks are held by a cluster node and any thread running on the cluster node that obtained the lock can release it. Default value is the lease-granularity value specified in the tangosol-coherence.xml descriptor. See "ReplicatedCache Service Parameters" for more information.

Optional

Specifies whether the lease issues should be transferred to the most recent lock holders. Legal values are true or false. Default value is the mobile-issue value specified in the tangosol-coherence.xml descriptor. See "ReplicatedCache Service Parameters" for more information.

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies the configuration information for a class that implements the com.tangosol.net.MemberListener interface. The implementation must have a public default constructor.

The MemberListener implementation receives cache service lifecycle events. The <member-listener> element is used as an alternative to programmatically adding a MapListener on a service.

Optional

The autostart element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether the cache services associated with this cache scheme should be automatically started at a cluster node. Legal values are true or false. Default value is false.

Optional

Contains the class configuration information for a com.tangosol.io.Serializer implementation.

Required

Specifies the IP address (IP or DNS name) on which a TCP/IP acceptor socket is listening.

Required

Specifies the port on which a TCP/IP acceptor socket is listening. Legal values are from 1 to 65535.

Optional

Specifies a socket provider that produces instances of the JVM's default socket and channel implementations.

Optional

Specifies a socket provider that produces socket and channel implementations which utilize SSL.

Optional

Contains the class configuration information for a com.tangosol.net.SocketProvider implementation.

Optional

Specifies the name of the protocol used by the socket and channel implementations produced by the SSL socket provider. The default value is TLS.

Optional

Specifies the configuration for a security provider instance.

Optional

Specifies the configuration information for an implementation of the java.util.concurrent.Executor interface.

A <class-name> subelement is used to provide the name of a class that implements the Executor interface. As an alternative, a <class-factory-name> subelement can be used to specify a factory class for creating Executor instances and a <method-name> subelement that specifies the name of a static factory method on the factory class which will perform object instantiation. Either approach can specify initialization parameters using the <init-params> element.

Optional

Specifies the configuration information for initializing an identity manager instance.

Optional

Specifies the configuration information for initializing a trust manager instance.

Optional

Specifies the configuration information for an implementation of the javax.net.ssl.HostnameVerifier interface. During the SSL handshake, if the URL's hostname and the server's identification hostname mismatch, the verification mechanism will call back to this instance to determine if the connection should be allowed.

A <class-name> subelement is used to provide the name of a class that implements the HostnameVerifier interface. As an alternative, a <class-factory-name> subelement can be used to specify a factory class for creating HostnameVerifier instances and a <method-name> subelement that specifies the name of a static factory method on the factory class which will perform object instantiation. Either approach can specify initialization parameters using the <init-params> element.

Optional

Specifies the local address (IP or DNS name) and port on which the TCP/IP server socket (opened by the connection acceptor) is bound.

Optional

Contains the configuration for a com.tangosol.net.AddressProvider implementation that supplies the local address (IP or DNS name) and port on which the TCP/IP server socket (opened by the connection acceptor) listens.

A <tcp-acceptor> element can include either a <local-address> or an <address-provider> element but not both.

Optional

Specifies the configuration information for a socket and channel factory that implements the com.tangosol.net.SocketProvider interface.

Optional

Specifies whether or not a TCP/IP socket can be bound to an in-use or recently used address.

This setting is deprecated because the resulting behavior is significantly different across operating system implementations. The JVM will, in general, select a reasonable default which is safe for the target operating system.

Valid values are true and false. The default value depends on the operating system.

Optional

Indicates whether keep alive (SO_KEEPALIVE) is enabled on a TCP/IP socket. Valid values are true and false. Keep alive is enabled by default.

Optional

Indicates whether TCP delay (Nagle's algorithm) is enabled on a TCP/IP socket. Valid values are true and false. TCP delay is disabled by default.

Optional

Configures the size of the underlying TCP/IP socket network receive buffer.Increasing the receive buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed. Default value is O/S dependent.

Optional

Configures the size of the underlying TCP/IP socket network send buffer. The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed. Default value is O/S dependent.

Optional

Configures the size of the TCP/IP server socket backlog queue. Valid values are positive integers. Default value is O/S dependent.

Optional

Enables SO_LINGER on a TCP/IP socket with the specified linger time.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. Linger is disabled by default.

Optional

A collection of IP addresses of TCP/IP initiator hosts that are allowed to connect to this TCP/IP acceptor.

Optional

Specifies whether or not the suspect protocol is enabled in order to detect and close rogue Coherence*Extend client connections. The suspect protocol is enabled by default.

Valid values are true and false.

Optional

Specifies the outgoing connection backlog (in bytes) after which the corresponding client connection is marked as suspect. A suspect client connection is then monitored until it is no longer suspect or it is closed in order to protect the proxy server from running out of memory.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g|T|t]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 2^10)

• M or m (mega, 2^20)

• G or g (giga, 2^30)

• T or t (tera, 2^40)

If the value does not contain a factor, a factor of one is assumed. Default value is 10000000.

Optional

Specifies the outgoing connection backlog (in messages) after which the corresponding client connection is marked as suspect. A suspect client connection is then monitored until it is no longer suspect or it is closed in order to protect the proxy server from running out of memory.

Default value is 10000.

Optional

Specifies the outgoing connection backlog (in bytes) at which point a suspect client connection is no longer considered to be suspect.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g|T|t]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 2^10)

• M or m (mega, 2^20)

• G or g (giga, 2^30)

• T or t (tera, 2^40)

If the value does not contain a factor, a factor of one is assumed. Default value is 2000000.

Optional

Specifies the outgoing connection backlog (in messages) at which point a suspect client connection is no longer considered to be suspect.

Default value is 2000.

Optional

Specifies the outgoing connection backlog (in bytes) at which point the corresponding client connection must be closed in order to protect the proxy server from running out of memory.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g|T|t]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 2^10)

• M or m (mega, 2^20)

• G or g (giga, 2^30)

• T or t (tera, 2^40)

If the value does not contain a factor, a factor of one is assumed. Default value is 100000000.

Optional

Specifies the outgoing connection backlog (in messages) at which point the corresponding client connection must be closed in order to protect the proxy server from running out of memory.

Default value is 60000.

Optional

Specifies the local address (IP or DNS name) and port on which the TCP/IP client socket (opened by the TCP/IP initiator) is bound.

Required

Contains the address of one or more TCP/IP connection acceptors. The TCP/IP connection initiator uses this information to establish a TCP/IP connection with a remote cluster.

Optional

Specifies the configuration information for a socket and channel factory that implements the com.tangosol.net.SocketProvider interface.

Optional

Specifies whether or not a TCP/IP socket can be bound to an in-use or recently used address.

This setting is deprecated because the resulting behavior is significantly different across operating system implementations. The JVM will, in general, select a reasonable default which is safe for the target operating system.

Valid values are true and false. The default value depends on the operating system.

Optional

Indicates whether keep alive (SO_KEEPALIVE) is enabled on a TCP/IP socket. Valid values are true and false. Keep alive is enabled by default.

Optional

Indicates whether TCP delay (Nagle's algorithm) is enabled on a TCP/IP socket. Valid values are true and false. TCP delay is disabled by default.

Optional

Configures the size of the underlying TCP/IP socket network receive buffer.Increasing the receive buffer size can increase the performance of network I/O for high-volume connections, while decreasing it can help reduce the backlog of incoming data.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed. Default value is O/S dependent.

Optional

Configures the size of the underlying TCP/IP socket network send buffer.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 210)

• M or m (mega, 220)

• G or g (giga, 230)

If the value does not contain a factor, a factor of one is assumed. Default value is O/S dependent.

Optional

Specifies the maximum amount of time to wait while establishing a connection with a connection acceptor.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. Default value is an infinite timeout.

Optional

Enables SO_LINGER on a TCP/IP socket with the specified linger time.The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed. Linger is disabled by default.

Optional

Specifies the scheme's name. The name must be unique within a configuration file.

Optional

Specifies the name of another scheme to inherit from. See "Using Scheme Inheritance" for more information.

Optional

Specifies the name of the service which manages caches created from this scheme. The default service name if no service name is provided is TransactionalCache.

Optional

Specifies either: the class configuration information for a com.tangosol.io.Serializer implementation used to serialize and deserialize user types, or it references a serializer class configuration that is defined in the operational configuration file (see "serializers").

Optional

Specifies the number of daemon threads used by the partitioned cache service. If zero, all relevant tasks are performed on the service thread. Legal values are positive integers or zero. Default value is the thread-count value specified in the tangosol-coherence.xml descriptor. See the thread-count parameter in "DistributedCache Service Parameters" for more information.

Specifying the thread-count value will change the default behavior of the Transactional Framework's internal transaction caches that are used for transactional storage and recovery.

Optional

Specifies whether a cluster node will contribute storage to the cluster, that is, maintain partitions. When disabled the node is considered a cache client.

Normally this value should be left unspecified within the configuration file, and instead set on a per-process basis using the tangosol.coherence.distributed.localstorage system property. This allows cache clients and servers to use the same configuration descriptor.

Legal values are true or false. Default value is the local-storage value specified in the tangosol-coherence.xml descriptor. See the local-storage parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the number of partitions that a partitioned (distributed) cache will be "chopped up" into. Each member running the partitioned cache service that has the local-storage (<local-storage> subelement) option set to true will manage a "fair" (balanced) number of partitions.

The number of partitions should be a prime number and sufficiently large such that a given partition is expected to be no larger than 50MB in size.

The following are good defaults for sample service storage sizes:

service storage     partition-count
_______________     ______________
   100M                  257
     1G                  509
    10G                 2039
    50G                 4093
   100G                 8191

A list of first 1,000 primes can be found at

http://primes.utm.edu/lists/

Valid values are positive integers. Default value is the value specified in the tangosol-coherence.xml descriptor. See the partition-count parameter "DistributedCache Service Parameters" for more information.

Optional

Specifies the transaction storage size. Once the transactional storage size is reached, an eviction policy is used that removes 25% of eligible entries from storage.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[K|k|M|m|G|g|T|t]?[B|b]?

where the first non-digit (from left to right) indicates the factor with which the preceding decimal value should be multiplied:

• K or k (kilo, 2^10)

• M or m (mega, 2^20)

• G or g (giga, 2^30)

• T or t (tera, 2^40)

If the value does not contain a factor, a factor of one is assumed. Default value is 10MB.

Optional

Specifies the threshold for the primary buckets distribution in kilo-bytes. When a new node joins the partitioned 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 re-balanced 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 the transfer-threshold value specified in the tangosol-coherence.xml descriptor. See the transfer-threshold parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the number of members of the partitioned cache 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 partitioned 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 or 1. Default value is the backup-count value specified in the tangosol-coherence.xml descriptor. See the backup-count parameter in value specified in the tangosol-coherence.xml descriptor. See "DistributedCache Service Parameters" for more information.

Optional

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 thread-count value is positive). Legal values are positive integers or zero (indicating no default timeout). Default value is the task-hung-threshold value specified in the tangosol-coherence.xml descriptor. See the task-hung-threshold parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the timeout value in milliseconds for requests executing on the service worker threads. This attribute is applied only if the thread pool is used (the thread-count value is positive). If zero is specified, the default service-guardian <timeout-milliseconds> value is used. Legal values are non-negative integers. Default value is the value specified in the tangosol-coherence.xml descriptor. See the task-timeout parameter in "DistributedCache Service Parameters".

Optional

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:

• the time it takes to deliver the request to an executing node (server)

• the interval between the time the task is received and placed into a service queue until the execution starts

• the task execution time

• the time it takes to deliver a result back to the client

Legal values are positive integers or zero (indicating no default timeout). Default value is the value specified in the tangosol-coherence.xml descriptor. See the request-timeout parameter in "DistributedCache Service Parameters" for more information.

Optional

Specifies the guardian timeout value to use for guarding the service and any dependant threads. If the element is not specified for a given service, the default guardian timeout (as specified by the <timeout-milliseconds> operational configuration element) is used. See <service-guardian>.

The value of this element must be in the following format:

[\d]+[[.][\d]+]?[MS|ms|S|s|M|m|H|h|D|d]?

where the first non-digits (from left to right) indicate the unit of time duration:

• MS or ms (milliseconds)

• S or s (seconds)

• M or m (minutes)

• H or h (hours)

• D or d (days)

If the value does not contain a unit, a unit of milliseconds is assumed.

Optional

Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian.

Legal values are:

• exit-cluster – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy causes the local node to stop the cluster services.

• exit-process – attempts to recover threads that appear to be unresponsive. If the attempt fails, an attempt is made to stop the associated service. If the associated service cannot be stopped, this policy cause the local node to exit the JVM and terminate abruptly.

• logging – causes any detected problems to be logged, but no corrective action to be taken.

• a custom class – an <instance> subelement is used to provide the class configuration information for a com.tangosol.net.ServiceFailurePolicy implementation.

Default value is exit-cluster.

Optional

Specifies quorum policy settings for the partitioned cache service.

Optional

The element is intended to be used by cache servers (that is, com.tangosol.net.DefaultCacheServer). It specifies whether the cache services associated with this cache scheme should be automatically started at a cluster node. Legal values are true or false. Default value is false.