This appendix provides a detailed reference of the operational deployment descriptor elements and briefly describes the deployment descriptor files in which these elements can appear.
This appendix includes the following sections:
The tangosol-coherence.xml operational deployment descriptor specifies the operational and run-time settings that control clustering, communication, and data management services. The operational deployment descriptor is located in the root of the coherence.jar library. A custom tangosol-coherence.xml file can be created; however, the preferred approach to changing the operational settings is to use a tangosol-coherence-override.xml operational override file as described in "Operational Override File" below.
The operational deployment descriptor schema is defined in the coherence-operational-config.xsd file, which imports the coherence-operational-config-base.xsd file, which, in turn, implicitly imports the coherence-config-base.xsd file. The operational deployment descriptor schema file is located in the root of the coherence.jar library and at the following Web URL:
http://xmlns.oracle.com/coherence/coherence-operational-config/1.2/coherence-operational-config.xsd
The <cohrence> element is the root element of the operational descriptor and includes an XSD and Coherence namespace reference and the location of the coherence-operational-config.xsd file. For example:
<?xml version='1.0'?> <coherence xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.oracle.com/coherence/coherence-operational-config" xsi:schemaLocation="http://xmlns.oracle.com/coherence/ coherence-operational-config coherence-operational-config.xsd">
Notes:
The schema located in the coherence.jar library is always used at run time even if the xsi:schemaLocation attribute references the Web URL.
The xsi:schemaLocation attribute can be omitted to disable schema validation.
When deploying Coherence into environments where the default character set is EBCDIC rather than ASCII, ensure that the deployment descriptor file is in ASCII format and is deployed into its run-time environment in the binary format.
The preferred approach for configuring operational settings is to use an operational override file. The schema for the override file and the operational deployment descriptor are the same except that all elements are optional. Any missing elements are loaded from the tangosol-coherence.xml operational deployment descriptor. The default name for the override file is tangosol-coherence-override.xml. At run time, this file must be found in the classpath before the coherence.jar library.
Additional override files can be configured using the xml-override attribute within the <coherence> element. This allows for additional fine tuning between similar deployment environments such as staging and production. For an example of this feature, see the tangosol-coherence-override-eval.xml, tangosol-coherence-override-dev.xml, and tangosol-coherence-override-prod.xml files within coherence.jar. See "Attribute Reference" for details on using the xml-override attribute.
Table A-1 lists all non-terminal operational configuration elements.
Table A-1 Non-Terminal Operational Configuration Elements
| Element | Used in |
|---|---|
|
root element |
|
|
access-controller, address-provider, callback-handler, configurable-cache-factory-config, filter, service |
|
|
socket-provider, service-failure-policy |
|
Used in: security-config.
The access-controller element contains the configuration information for the class that implements the com.tangosol.net.security.AccessController interface, which is used by the Coherence Security Framework to check access right and encrypt/decrypt node-to-node communications.
Table A-2 describes the subelements of the access-controller element.
Table A-2 access-controller Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the name of a Java class that implements |
|
< |
Optional |
Contains one or more initialization parameter(s) for a class that implements the
<init-params>
<init-param id="1">
<param-type>java.io.File</param-type>
<param-value system-property="tangosol.coherence.security.keystore"></param-value>
</init-param>
<init-param id="2">
<param-type>java.io.File</param-type>
<param-value system-property="tangosol.coherence.security.permissions"></param-value>
</init-param>
</init-params>
The preconfigured system property overrides based on the default |
Used in: well-known-addresses, address-providers
The address-provider element specifies either socket address information (IP, or DNS name, and port) or an implementation of the com.tangosol.net.AddressProvider interface. The interface offers a programmatic way to define socket addresses.
Within the well-known-addresses element, use the address-provider element to specify an address factory that implements the com.tangosol.net.AddressProvider interface. The interface offers a programmatic way to define Well Known Addresses (WKA) members. For details on WKA, see "Using Well Known Addresses". The following example demonstrates using the address-provider element within the well-known-addresses element:
<unicast-listener>
<well-known-addresses>
<address-provider>
<class-name>package.MyAddressProvider</class-name>
</address-provider>
</well-known-addresses>
</unicast-listener>
Within the address-providers element, use the address-provider element to specify a socket address or an address factory that implements the com.tangosol.net.AddressProvider interface. The address provider definitions are referenced by TCP/IP acceptors and TCP/IP initiators which are used to setup Coherence*Extend. The tcp-acceptor, remote-addresses, and name-service-addresses elements in the cache configuration file reference address provider definitions using the specified id attribute value. For details on the tcp-acceptor element, see "tcp-acceptor". For details on the remote-addresses element, see "remote-addresses". For details on the name-service-addresses element, see "name-service-addresses". The following example demonstrates defining address provider definitions within the <address-providers> element.
<address-providers>
<address-provider id="ap1">
<class-name>package.MyAddressProvider</class-name>
</address-provider>
<address-provider id="ap2">
<socket-address>
<address>192.168.1.3</address>
<port>9999</port>
</socket-address>
</address-provider>
<address-provider id="ap3">
<socket-address>
<address>192.168.1.4</address>
<port>9999</port>
</socket-address>
</address-provider>
</address-providers>
Table A-3 describes the subelements of the address-provider element.
Table A-3 address-provider Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the fully qualified name of a class that implements the This element cannot be used with the |
|
|
Optional |
Specifies the fully qualified name of a factory class for creating implementation class instances. This element cannot be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Specifies initialization parameters which are accessible by implementations that include a public constructor with a matching signature. Initialization parameters can be specified when using both the |
|
|
Optional |
Specifies the address (IP, or DNS name, and port) to which a socket is bound. This element should only be used when defining socket addresses for a TCP/IP acceptor. This element cannot be used if an address provider implementation is defined using the |
Used in: cluster-config
The address-providers element contains the declarative data for each address provider.
Table A-4 describes the subelements of the address-providers element.
Table A-4 address-providers Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies either socket address information or an implementation of the |
Used in: cluster-config.
If specified, restricts cluster membership to the cluster nodes specified in the collection of unicast addresses, or address range. The unicast address is the address value from the authorized cluster nodes' unicast-listener element. Any number of host-address and host-range elements may be specified.
Table A-5 describes the subelements of the authorized-hosts element.
Table A-5 authorized-hosts Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
Specifies an IP address or host name. If any are specified, only hosts with specified host-addresses or within the specified host-ranges is allowed to join the cluster. The content override attributes |
|
Optional |
Specifies a range of IP addresses. If any are specified, only hosts with specified host-addresses or within the specified host-ranges is allowed to join the cluster. The content override attributes |
|
|
|
Optional |
Specifies class configuration information for a |
Used in: coherence
The cache-factory-builder-config element contains the configuration information for constructing an instance of the com.tangosol.net.CacheFactoryBuilder interface. The default implementation is the com.tangosol.net.DefaultCacheFactoryBuilder class, which can be extended in advanced use-cases to provide further domain-specific logic for creating and managing ConfigurableCacheFactory instances.
A custom CacheFactoryBuilder implementation is used to build and manage multiple cache factory configurations across multiple class loaders. This is an advanced use case that allows applications that are scoped by different class loaders to use separate cache configuration files (as is the case with JavaEE and OSGI). For example, the following code uses a custom ConfigurableCacheFactory implementation from two classloaders.
CacheFactoryBuilder cfb = CacheFactory.getCacheFactoryBuilder();
//load the first configuration
cfb.getConfigurableCacheFactory("example-config.xml", loader0);
CacheFactory.ensureCluster();
NamedCache cache = CacheFactory.getCache("dist-example");
//load the second configuration
cfb.getConfigurableCacheFactory("example-config1.xml", loader1);
CacheFactory.ensureCluster();
NamedCache cache1 = CacheFactory.getCache("dist-example1");
Table A-6 describes the subelements of the cache-factory-builder-config element.
Table A-6 cache-factory-builder-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the name of a Java class that implements the |
|
Optional |
Contains initialization parameters for the cache factory builder implementation. |
|
|
|
Optional |
Specifies the configuration information for a class that implements the See the |
Used in: security-config.
Table A-7 describes the subelements of the callback-handler element.
Table A-7 callback-handler Subelement
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the name of a Java class that provides the implementation for the |
|
Optional |
Contains one or more initialization parameter(s) for a |
Used in: <coherence>
Contains the cluster configuration information, including communication and service parameters.
Table A-8 describes the subelements of the cluster-config element.
Table A-8 cluster-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies detailed identity information that is useful for defining the location and role of the cluster member. |
|
|
Required |
Specifies the configuration information for the unicast listener, used for receiving point-to-point network communications. |
|
|
Required |
Specifies the configuration information for the multicast listener, used for receiving point-to-multipoint network communications. |
|
|
Required |
Specifies configuration information for the TCP ring listener, used to death detection. |
|
|
Required |
Specifies the action to take upon receiving an external shutdown request. |
|
|
Required |
Specifies the configuration information for the service guardians, used for detecting and resolving service deadlock. |
|
|
Required |
Specifies configuration information for the packet speaker, used for network data transmission. |
|
|
Required |
Specifies configuration information for the packet publisher, used for managing network data transmission. |
|
|
Required |
Specifies configuration information for the incoming message handler, used for dispatching incoming cluster communications. |
|
|
Required |
Specifies configuration information for the outgoing message handler, used for dispatching outgoing cluster communications. |
|
|
Optional |
Specifies the hosts which are allowed to join the cluster. |
|
|
|
Required |
Specifies the declarative data for all available Coherence services. |
|
|
Optional |
Specifies data transformation filters, which can perform custom transformations on data being transferred between cluster nodes. |
|
Optional |
Specifies any number of serializer class configurations that implement |
|
|
Optional |
Specifies any number of address provider definitions that can be referenced by a proxy service's TCP/IP acceptor. |
|
|
Required |
Contains socket provider definitions. |
|
|
Optional |
Contains the configuration information for the quorum-based action policy for the Cluster service. |
|
|
Optional |
Specifies configuration for the journaling subsystem. |
Used in: <cluster-config>
The cluster-quorum-policy element contains quorum policy settings for the Cluster service.
Table A-9 describes the subelements of the cluster-quorum-policy element.
Table A-9 cluster-quorum-policy-scheme Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the minimum number of cluster members that must remain to terminate one or more cluster members due to a detected network timeout, irrespective of the root cause. The value must be a nonnegative integer. Use the <timeout-survivor-quorum role="Server">50 </timeout-survivor-quorum> |
|
|
Optional |
Specifies a class that provides custom quorum policies. This element cannot be used with the The class must implement the |
|
|
Optional |
Specifies a factory class for creating custom action policy instances. This element cannot be used with the This element is used with the |
root element
The coherence element is the root element of the operational deployment descriptor tangosol-coherence.xml.
Table A-10 describes the subelements of the coherence element.
Table A-10 coherence Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Required |
Contains the cluster configuration information. This element is where most communication and service parameters are defined. |
|
|
Required |
Contains the configuration information for the logging facility. |
|
|
Required |
Contains configuration information for the configurable cache factory, which controls from where and how the cache configuration settings are loaded. |
|
|
Required |
Contains the configuration information for a cache factory builder, which allows building and managing multiple cache factory configurations across multiple class loaders. |
|
|
Required |
Contains the configuration information for the coherence Management Framework. See Managing Oracle Coherence for more information. |
|
|
Optional |
Contains the configuration information for the Coherence Security Framework. |
|
|
Optional |
Contains the edition and operational mode configuration. |
Used in: coherence
The configurable-cache-factory-config element contains the configuration information for constructing an instance of the com.tangosol.net.ConfigurableCacheFactory interface. The default implementation is the com.tangosol.net.ExtensibleConfigurableCacheFactory class.
Using a custom ConfigurableCacheFactory implementation is an advanced use case and is typically used to allow applications that are scoped by different class loaders to use separate cache configuration files (as is the case with JavaEE and OSGI).
The following example loads two configuration files which contain different cache definitions and use different ClassLoaders.
//load the first configuration and use a cache
ConfigurableCacheFactory eccf= new
ExtensibleConfigurableCacheFactory("example-config.xml", loader0);
NamedCache cache = eccf.ensureCache("dist-example", loader0);
cache.put(key, value);
//load the second cache configuration and use a cache
ConfigurableCacheFactory eccf1= new
ExtensibleConfigurableCacheFactory("example-config1.xml", loader1);
NamedCache cache1 = eccf1.ensureCache("dist-example1", loader1);
cache1.put(key, value);
Note:
This example requires each cache definition to use a different service name; otherwise, an exception is thrown indicating that the service was started by a factory with a different configuration descriptor.
Table A-11 describes the subelements of the configurable-cache-factory-config element.
Table A-11 configurable-cache-factory-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the name of a Java class that implements the The preconfigured system property override is |
|
Optional |
Contains initialization parameters for the cache configuration factory implementation. For the default cache configuration factory class, a single parameter is used as follows: <init-param> <param-type>java.lang.String</param-type> <param-value>coherence-cache-config.xml</param-value> </init-param> Unless an absolute or relative path is specified, such as with . The preconfigured system property override is |
Used in: filters.
Data transformation filters can be used by a service to apply a custom transformation on data being transferred between cluster nodes. This can be used for instance to compress network traffic. See the <filter-class> element for more information.
Data transformation filters are implementations of the com.tangosol.util.WrapperStreamFactory interface.
Note:
Data transformation filters are not related to com.tangosol.util.Filter, which is part of the Coherence API for querying caches.
Table A-12 describes the subelements of each filter element.
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the canonical name of the filter. This name is unique within the cluster. For example: |
|
< |
Required |
Specifies the class name of the filter implementation. This class must have a zero-parameter public constructor and must implement the |
|
Optional |
Specifies initialization parameters for configuring filters. For example when using a <init-param> <param-name>strategy</param-name> <param-value>gzip</param-value> </init-param> <init-param> <param-name>level</param-name> <param-value>default</param-value> </init-param> For more information on the parameter values for the standard filters, refer to "Using Network Filters". |
Used in cluster-config.
The filters element contains the declarative data for each filter.
Table A-13 describes the subelements of the filters element.
Table A-13 filters Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
The filter element contains the declarative data of a particular filter. |
Used in: journaling-config
The <flashjournal-manager> element contains the configuration for a flash journal resources manager, which manages I/O for temporary journal-based files to a solid state device.
Table A-14 describes the subelements of the flashjournal-manager element.
Table A-14 flashjournal-manager Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the factor of live data below which a journal file is eligible for compaction (garbage collection). |
|
|
Optional |
Specifies the maximum size, in bytes, of binary values that are to be stored in the flash journal. The value cannot exceed 64MB. The default value is |
|
|
Optional |
Specifies the maximum file size of the underlying journal files. The value must be a power of two and a multiple of the block size. The value must be between 1MB and 4GB and must be large enough so that a file is capable of storing at least 2 values. The default value is |
|
|
Optional |
Specifies the amount of time that the journal collector can remain unresponsive prior to considering it timed out. The minimum timeout is 30s. Legal values are strings representing time intervals. The Default value is |
|
|
Optional |
Specifies the size of the write buffers in which writes to an underlying disk file occur. The size should match or be a multiple of the physical device's optimal block size and must be a power of two. The value must be between 4KB and 1MB. The default value is |
|
|
Optional |
Specifies the size, in bytes, for the buffer pool. The size does not limit the number of buffers that can be allocated or that can exist at any point in time. The size only determines the amount of buffers that are recycled. The pools size cannot exceed 1GB. The default value is |
|
|
Optional |
Specifies the directory where the journal files should be placed. The directory must exist and is not created at run time. If the directory does not exist or is not specified, the JVM/operating system default temporary directory is used. The suggested location is a local flash (SSD) drive. Specifying a directory that is located on a drive which is shared by other applications or system operations increases the potential for unplanned space usage. Use a directory location on a non-shared disk partition to ensure a more predictable environment. |
|
|
Optional |
Specifies the maximum size, in bytes, of the backlog. The backlog is the amount of data that has yet to be persisted. Client threads are blocked if the configured limit is exceeded and remain blocked until the backlog recedes below the limit. This helps prevent out-of-memory conditions. Note: The maximum amount of memory used by the backlog is at least twice the configured amount, since the data is in binary form and rendered to the write-behind buffers. The value must be between 4KB and 1GB. The default value is |
|
|
Optional |
Specifies the amount of time to wait before a temporary file that is used by the Journaling subsystem is eligible for removal. The delay begins after the file is last used. The default value is |
|
|
Optional |
Specifies the soft limit, in bytes, on the journal size or a percentage of the flash journal capacity. The soft limit allows the compaction (garbage collection) thread to tune itself to remove stale values and keep the journal within the soft limit. This is not a hard limit and the journal can still grow up to the maximum file count ( The preconfigured system property override is |
|
|
Optional |
Specifies the amount of time that the flash journal writer can remain unresponsive prior to considering it timed out. The minimum timeout is 30s. Legal values are strings representing time intervals. The Default value is If a write fails (after the |
Used in: packet-delivery.
The flow-control element contains configuration information related to packet throttling and remote GC detection.
Table A-15 describes the subelements of the flow-control element.
Table A-15 flow-control Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
Specifies if flow control is enabled. Valid values are |
|
Optional |
Defines the number of packets that are resent to an unresponsive cluster node after which the node is assumed to be paused. |
|
|
Optional |
Defines the number of unconfirmed packets that are sent to a cluster node before packets addressed to that node are deferred. |
Used in: authorized-hosts.
Specifies a range of unicast addresses of nodes which are allowed to join the cluster.
Table A-16 describes the subelements of each host-range element.
Table A-16 host-range Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the starting IP address for a range of host addresses. For example: 198.168.1.1. |
|
< |
Required |
Specifies to-address element specifies the ending IP address (inclusive) for a range of hosts. For example: 198.168.2.255. |
Used in: security-config
The <identity-asserter> element contains the configuration information for a class that implements the com.tangosol.net.security.IdentityAsserter interface. The class is called to validate an identity token to establish a user's identity and is used on a Coherence*Extend proxy server. The identity asserter is used with an identity transformer (used on a Coherence*Extend client) to ensure that only valid clients are allowed to connect to an extend proxy.
Table A-17 describes the subelements of the <identity-asserter> element.
Table A-17 identity-asserter Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies a class that implements |
|
|
Optional |
Specifies a factory class for creating asserter instances. The instances must implement This element can be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Contains class initialization parameters for the asserter implementation. |
Used in: ssl.
The <identity-manager> element contains the configuration information for initializing a javax.net.ssl.KeyManager instance.
The identity manager is responsible for managing the key material which is used to authenticate the local connection to its peer. If no key material is available, the connection cannot present authentication credentials.
Table A-18 describes the subelements of the identity-manager element.
Table A-18 identity-manager Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the algorithm used by the identity manager. The default value is |
|
|
Optional |
Specifies the configuration for a security provider instance. |
|
Optional |
Specifies the configuration for a key store implementation. |
|
|
|
Required |
Specifies the private key password. |
Used in: security-config
The <identity-transformer> element contains the configuration information for a class that implements the com.tangosol.net.security.IdentityTransformer interface. The class is called to transform a Subject (Principal in .NET) to a token that asserts identity and is used on a Coherence*Extend client. The identity transformer is used with an identity asserter (used on a Coherence*Extend proxy server) to ensure that only valid clients are allowed to connect to an extend proxy.
Table A-19 describes the subelements of the <identity-transformer> element.
Table A-19 identity-transformer Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies a class that implements |
|
|
Optional |
Specifies a factory class for creating asserter instances. The instances must implement This element can be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Contains class initialization parameters for the transformer implementation. |
Used in: cluster-config.
The incoming-message-handler assembles UDP packets into logical messages and dispatches them to the appropriate Coherence service for processing.
Table A-20 describes the subelements of the incoming-message-handler element.
Table A-20 incoming-message-handler Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the maximum time variance between sending and receiving broadcast Messages when trying to determine the difference between a new cluster Member's system time and the cluster time. The smaller the variance, the more certain one can be that the cluster time is closer between multiple systems running in the cluster; however, the process of joining the cluster is extended until an exchange of Messages can occur within the specified variance. Normally, a value as small as 20 milliseconds is sufficient, but with heavily loaded clusters and multiple network hops a larger value may be necessary. The default value is |
|
< |
Required |
Specifies whether the packet receiver uses negative acknowledgments (packet requests) to pro-actively respond to known missing packets. See "notification-queueing" for additional details and configuration. Legal values are |
|
< |
Required |
Specifies a priority of the incoming message handler execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
Used in: init-params.
Defines an initialization parameter. Any number of init-param elements may be specified.
Table A-21 describes the subelements of the init-param element.
Table A-21 init-param Subelement
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
Specifies the name of the initialization parameter. For example: <init-param> <param-name>sTableName</param-name> <param-value>EmployeeTable</param-value> </init-param> The |
|
< |
Optional |
Specifies the Java type of the initialization parameter.The following standard types are supported:
For example: <init-param> <param-type>java.lang.String</param-type> <param-value>EmployeeTable</param-value> </init-param> The |
|
< |
Required |
Specifies the value of the initialization parameter. The value is in the format specific to the Java type of the parameter. |
|
|
Optional |
Specifies a description for the initialization parameter. |
Used in: address-provider, filter, service, configurable-cache-factory-config, access-controller, and callback-handler.
Defines a series of initialization parameters.
Table A-22 describes the subelements of the init-params element.
Table A-22 init-params Subelement
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Defines an individual initialization parameter. |
Used in: service-failure-policy, scope-resolver, and partition-assignment-strategy
The <instance> element contains the configuration of an implementation class or class factory that is used to plug in custom functionality.
Table A-23 describes the subelements of the instance element.
Table A-23 instance Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the fully qualified name of an implementation class. This element cannot be used with the |
|
|
Optional |
Specifies the fully qualified name of a factory class for creating implementation class instances. This element cannot be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Specifies initialization parameters which are accessible by implementations that include a public constructor with a matching signature. Initialization parameters can be specified when using both the |
Used in: cluster-config
The <journaling-config> element contains the configuration for the resource managers that are responsible for storing data in a binary format to flash and RAM memory.
Table A-23 describes the subelements of the journaling-config element.
Table A-24 journaling-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Required |
Specifies the RAM Journal Resource Manager's configuration. |
|
|
Required |
Specifies the Flash Journal Resource Manager's configuration. |
Used in: identity-manager, trust-manager.
The key-store element specifies the configuration for a key store implementation to use when implementing SSL. The key store implementation is an instance of the java.security.KeyStore class.
Table A-25 describes the subelements of the key-store element.
Table A-25 key-store Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
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 |
Used in: coherence.
Table A-26 describes the subelements of the license-config element.
Table A-26 license-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
Specifies the product edition that the member uses. Valid values are: Note: The edition switches no longer enforce license restrictions. Do not change the default setting ( |
|
< |
Optional |
Specifies whether the product is being used in a development or production mode. Valid values are |
Used in: coherence.
The following table describes the subelements of the logging-config element.
Table A-27 logging-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the output device used by the logging system. Legal values are:
If The preconfigured system property override is |
|
< |
Optional |
Specifies a logger name within chosen logging system that logs Coherence related messages. This value is only used by the JDK and log4j logging systems. The default value is The preconfigured system property override is |
|
< |
Required |
Specifies which logged messages are emitted to the log destination. The legal values are The preconfigured system property override is |
|
< |
Required |
Specifies how messages that have a logging level specified are formatted before passing them to the log destination. The format can include static text and any of the following replaceable parameters:
{date}/{uptime} {product} {version} <{level}> (thread={thread}, member={member}): {text}
|
|
< |
Required |
Specifies the maximum number of characters that the logger daemon processes from the message queue before discarding all remaining messages in the queue. All messages that are discarded are summarized by the logging system with a single log entry that details the number of messages that were discarded and their total size. Legal values are positive integers or The preconfigured system property override is |
Used in: coherence.
Table A-28 describes the subelements of the management-config element.
Table A-28 management-config Subelements
| Element | Optional/ Required |
Description |
|---|---|---|
|
< |
Required |
Specifies whether a cluster node's JVM has an
The preconfigured system property override is |
|
< |
Required |
Specifies whether this cluster node exposes its managed objects to remote MBean server(s). Legal values are: The preconfigured system property override is |
|
|
Optional |
Specifies the method which is used to refresh remote management information. Legal values are: The preconfigured system property override is |
|
|
Optional |
Specifies the time interval (in milliseconds) after which a remote MBean information is invalidated on the management node. Legal values are strings representing time intervals. The default value is The preconfigured system property override is |
|
|
Optional |
Specifies the duration which the management node waits for a response from a remote node when refreshing MBean information. This value must be less than the refresh-expiry interval. Legal values are strings representing time intervals. The default value is The preconfigured system property override is |
|
< |
Optional |
Specifies whether the managed objects exposed by this cluster node allow operations that modify run-time attributes. Legal values are: true or false. The default value is The preconfigured system property override is |
|
< |
Optional |
Specifies the domain name of an existing MBean server that is used to register MBeans exposed by the Coherence management framework. This element is used only if a cluster member has management enabled and the MBean server is located in the same process as the cluster member. If a value is not specified, the first existing MBean server is used. The element should only be used to identify an existing MBean server. This element is also used when implementing the |
|
< |
Optional |
Specifies the name of the Invocation Service used for remote management. This element is used only if |
|
|
Optional |
Contains the configuration information for an |
|
|
Optional |
Contains a list of MBeans to be registered when a node joins the cluster. |
|
Optional |
Contains the configuration information of a filter class that is used to filter MBeans before they are registered. |
|
|
|
Optional |
Contains the Reporter's configuration. |
|
|
Optional |
Specifies whether global MBean names that are identified with a The preconfigured system property override is |
Used in: mbeans
The mbean element contains a list of elements to be instantiated and registered with the Coherence management framework.
Table A-29 describes the subelements of the mbean element.
Table A-29 Subelements of mbean
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the full class name of the standard MBean to instantiate and register with the Coherence management framework. The MBean class must be in the classpath to correctly instantiate. This element cannot be used with the |
|
|
Optional |
Specifies the name of a class factory used to obtain MBeans to register with the Coherence management framework. The factory class must be in the classpath to correctly instantiate. This element is used with the This element cannot be used with the |
|
|
Optional |
Specifies a JMX <mbean-query>java.lang:*</mbean-query> This element cannot be used with the |
|
|
Optional |
Specifies the name of a default domain for the source MBean server. This is used to locate the MBean server where the mbean-query should be executed. |
|
|
Optional |
Specifies the method name on the factory class (specified by the |
|
|
Required |
Specifies the JMX |
|
|
Optional |
Specifies whether the MBean is visible across the cluster. Valid values are |
|
|
Optional |
Specifies whether the MBean should be instantiated and registered on this instance. Valid values are |
|
|
Optional |
Specifies whether the MBean should extend beyond the node connection life cycle. Valid values are |
Used in: management-config
The mbeans element is the root element for defining custom mbeans and is the root element of a custom mbean configuration file. It contains a list of mbean elements to be instantiated and registered with the Coherence management framework.
Table A-30 describes the subelements of the mbeans element.
Table A-30 Subelement of mbeans
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the MBean type, implementation, and |
Used in management-config.
The mbean-filter element is used to specify a filter that evaluates MBean names before they are registered in the MBean server. The com.tangosol.net.management.ObjectNameExcludeFilter class is the default filter and is used to exclude MBeans from being registered based on their JMX object name using standard regex patterns. The list is entered as a list of names separated by any white space characters. The following MBeans are excluded by the out-of-box configuration:
<management-config>
<mbean-filter>
<class-name>com.tangosol.net.management.ObjectNameExcludeFilter</class-name>
<init-params>
<init-param>
<param-type>string</param-type>
<param-value system-property="tangosol.coherence.management.exclude">
.*type=Service,name=Management,.*
.*type=Platform,Domain=java.lang,subType=ClassLoading,.*
.*type=Platform,Domain=java.lang,subType=Compilation,.*
.*type=Platform,Domain=java.lang,subType=MemoryManager,.*
.*type=Platform,Domain=java.lang,subType=Threading,.*
</param-value>
</init-param>
</init-params>
</mbean-filter>
</management-config>
Table A-44 describes the subelements of the mbean-filter element.
Table A-31 mbean-filter Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the name of a filter class for filtering mbeans. This element cannot be used with the |
|
|
Optional |
Specifies a factory class for creating filter instances. This element cannot be used with the This element can be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Contains class initialization parameters for the filter implementation. |
Used in: cluster-config.
The member-identity element contains detailed identity information that is useful for defining the location and role of the cluster member.
Table A-32 describes the subelements of the member-identity element.
Table A-32 member-identity Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
|
< |
Optional |
The The preconfigured system property override is |
Used in: cluster-config.
Specifies the configuration information for the Multicast listener. This element is used to specify the address and port that a cluster uses for cluster wide and point-to-multipoint communications. All nodes in a cluster must use the same multicast address and port, whereas distinct clusters on the same network should use different multicast addresses. If you are having difficulties establishing a cluster when using multicast, see Administering Oracle Coherence for instructions on performing a multicast connectivity test.
By default, Coherence uses a multicast protocol to discover other nodes when forming a cluster. If multicast networking is undesirable, or unavailable in your environment, the well-known-addresses feature may be used to eliminate the need for multicast traffic.
Table A-33 describes the subelements of the multicast-listener element.
Table A-33 multicast-listener Subelements
| Element | Required /Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the IP address that a multicast socket is bound to. By default, the interface (NIC) of the unicast-listener IP address is used for the multicast socket; this option allows a different interface to be specified for multicast. Setting this address to |
|
< |
Required |
Specifies the multicast IP address that a Socket listens or publishes on. Legal values are from 224.0.0.0 to 239.255.255.255. The default value depends on the release and build level and typically follows the convention of The preconfigured system property override is |
|
< |
Required |
Specifies the port that the Socket listens or publishes on. Legal values are from 1 to 65535. The default value depends on the release and build level and typically follows the convention of The preconfigured system property override is |
|
< |
Required |
Specifies the time-to-live setting for the multicast. This determines the maximum number of "hops" a packet may traverse, where a hop is measured as a traversal from one network segment to another by using a router. Legal values are from 0 to 255. The default value is The preconfigured system property override is |
|
Required |
Specifies how many incoming packets the operating system is requested to buffer. The value may be expressed either in terms of packets or bytes. |
|
|
< |
Required |
Specifies a priority of the multicast listener execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is 8. |
|
< |
Required |
Specifies the number of milliseconds that a new member waits without finding any evidence of a cluster before starting its own cluster and electing itself as the senior cluster member. Legal values are from 1000 to 1000000. The default value is Note: For production use, the recommended value is |
|
< |
Required |
Specifies the threshold percentage value used to determine whether a packet is sent by using unicast or multicast. It is a percentage value and is in the range of 1% to 100%. In a cluster of "n" nodes, a particular node sending a packet to a set of other (that is, not counting self) destination nodes of size "d" (in the range of 0 to n-1), the packet is sent multicast if and only if the following both hold true:
Legal values are from 1 to 100. The default value is Note: This element is only used if the |
Used in: packet-publisher.
The notification-queueing element is used to specify the timing of notifications packets sent to other cluster nodes. Notification packets are used to acknowledge the receipt of packets which require confirmation.
The following table describes the subelements of the notification-queuing element.
Table A-34 notification-queuing Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the maximum number of milliseconds that the packet publisher delays before sending an ACK packet. The ACK packet may be transmitted earlier if number of batched acknowledgments fills the ACK packet. This value should be substantially lower then the remote node's |
|
< |
Required |
Specifies the number of milliseconds that the packet publisher delays before sending a NACK packet. The default value is |
Used in: cluster-config
The outgoing-message-handler element contains the outgoing message handler (also known as a dispatcher) related configuration information.
Table A-35 describes the subelements of the outgoing-message-handler element.
Table A-35 outgoing-message-handler Subelement
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
Specifies a list of |
Used in: flow-control.
Defines the number of unconfirmed packets that are sent to a cluster node before packets addressed to that node are deferred. This helps to prevent the sender from flooding the recipient's network buffers.
Table A-36 describes the subelements of the outstanding-packets element.
Table A-36 outstanding-packets Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
The maximum number of unconfirmed packets that are sent to a cluster node before packets addressed to that node are deferred. It is recommended that this value not be set below 256. The default value is |
|
< |
Optional |
The lower bound on the range for the number of unconfirmed packets that are sent to a cluster node before packets addressed to that node are deferred. It is recommended that this value not be set below 16. The default value is |
Used in: unicast-listener, multicast-listener, packet-publisher.
Specifies the size (in packets or bytes) of the operating system buffer for datagram sockets.
Table A-37 describes the subelements of the packet-buffer element.
Table A-37 packet-buffer Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
For unicast-listener, multicast-listener and packet-publisher: Specifies the number of packets of packet-size that the datagram socket are asked to size itself to buffer. See The |
|
|
Optional |
Specifies the requested size of the underlying socket buffer in bytes rather than the number of packets. The |
Used in: packet-delivery.
The packet-bundling element contains configuration information related to the bundling of multiple small packets into a single larger packet to reduce the load on the network switching infrastructure.
Table A-38 describes the subelements of the packet-bundling element.
Table A-38 packet-bundling Subelements
| Element | Required/Optional | Description |
|---|---|---|
|
< |
Optional |
The maximum amount of time to defer a packet while waiting for additional packets to bundle. A value of zero results in the algorithm not waiting, and only bundling the readily accessible packets. A value greater than zero causes some transmission deferral while waiting for additional packets to become available. This value is typically set below 250 microseconds to avoid a detrimental throughput impact. If the units are not specified, nanoseconds are assumed. The default value is |
|
< |
Optional |
Specifies the aggressiveness of the packet deferral algorithm. Where as the maximum-deferral-time element defines the upper limit on the deferral time, the aggression-factor influences the average deferral time. The higher the aggression value, the longer the Publisher may wait for additional packets. The factor may be expressed as a real number, and often times values between 0.0 and 1.0 allows for high packet utilization while keeping latency to a minimum. The default value is |
Used in: packet-publisher.
Specifies timing and transmission rate parameters related to packet delivery.
Table A-39 describes the subelements of the packet-delivery element.
Table A-39 packet-delivery Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
For packets which require confirmation, specifies the minimum amount of time in milliseconds to wait for a corresponding ACK packet, before resending a packet. The default value is |
|
< |
Required |
For packets which require confirmation, specifies the maximum amount of time, in milliseconds, that a packet is resent. After this timeout expires Coherence makes a determination if the recipient is to be considered terminated. This determination takes additional data into account, such as if other nodes are still able to communicate with the recipient. The default value is |
|
< |
Required |
Specifies the interval between heartbeats. Each member issues a unicast heartbeat, and the most senior member issues the cluster heartbeat, which is a broadcast message. The heartbeat is used by the |
|
Optional |
Configures per-node packet throttling and remote GC detection. |
|
|
Optional |
Configures how aggressively Coherence attempts to maximize packet utilization. |
Used in: cluster-config.
Specifies configuration information for the Packet publisher, which manages network data transmission.
The Packet publisher is responsible for ensuring that transmitted packets reach the destination cluster node. The publisher maintains a set of packets which are waiting to be acknowledged, and if the ACK does not arrive by the packet-delivery resend timeout, the packet is retransmitted (see <packet-delivery> subelement). The recipient node delays the ACK, to batch a series of ACKs into a single response (see <notification-queuing> subelement).
Table A-40 describes the subelements of the packet-publisher element.
Table A-40 packet-publisher Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies the UDP packet sizes to use. |
|
|
Required |
Specifies timing parameters related to reliable packet delivery. |
|
|
Required |
Contains the notification queue related configuration info. |
|
|
Required |
Specifies the maximum number of packets which can be enqueued on the publisher before client threads block. |
|
|
Required |
Specifies how many outgoing packets the operating system is requested to buffer. The value may be expressed either in terms of packets of bytes. |
|
|
< |
Required |
Specifies a priority of the packet publisher execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Optional |
Specifies if TCMP clustering is enabled. When using both Coherence*Extend and Coherence TCMP based clustering, this feature allows TCMP to be disabled to ensure that a node only connects by using the Extend protocol. Valid values are The preconfigured system property override is |
Used in: packet-publisher.
The packet-size element specifies the maximum and preferred UDP packet sizes. All cluster nodes must use identical maximum packet sizes.
Table A-41 describes the subelements of the packet-size element.
Table A-41 packet-size Subelement
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the packet size, in bytes, which all cluster members can safely support. This value must be the same for all members in the cluster. A low value can artificially limit the maximum size of the cluster. This value should be at least 512, and defaults to 64KB. |
|
< |
Required |
Specifies the preferred size, in bytes, of the This value can be larger or smaller than the |
Used in: cluster-config.
Specifies configuration information for the packet speaker which is used for network data transmission when packet publisher loads are high.
Table A-42 describes the subelements of the packet-speaker element.
Table A-42 packet-speaker Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies whether or not the packet-speaker thread is enabled. Valid values are The preconfigured system property override is |
|
Optional |
Specifies the packet load which must be present for the speaker to be activated. |
|
|
< |
Required |
Specifies a priority of the packet speaker execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
Used in: flow-control.
Remote Pause detection allows Coherence to detect and react to a cluster node becoming unresponsive (likely due to a long GC). When a node is marked as paused, packets addressed to it are sent at a lower rate until the node resumes responding. This remote GC detection is used to avoid flooding a node while it is incapable of responding.
Table A-43 describes the subelements of the pause-detection element.
Table A-43 pause-detection Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Optional |
The maximum number of packets that are resent to an unresponsive cluster node after which the node is assumed to be paused. Specifying a value of 0 disables pause detection. The default value is |
Used in: ssl, identity-manager, trust-manager.
The provider element contains the configuration information for a security provider that extends the java.security.Provider class.
Table A-44 describes the subelements of the provider element.
Table A-44 provider Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the name of a security provider that extends the The class name can be entered using either this element or by using the |
|
|
Optional |
Specifies the name of a security provider that extends the This element cannot be used with the |
|
|
Optional |
Specifies a factory class for creating This element cannot be used with the This element can be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Contains class initialization parameters for the provider implementation. This element cannot be used with the |
Used in: journaling-config
The <ramjournal-manager> element contains the configuration for a RAM journal resources manager, which manages memory buffers for journal-based storage in-memory. A RAM journal resource manager always uses a flash journal resource manager to store large objects and is also used as an overflow when the amount of total memory allocated to the RAM journal is reached. A RAM journal also uses a flash journal when the journal garbage collection is temporarily not able to keep up with demand. See "flashjournal-manager" for details on configuring a flash journal resource manager.
Table A-45 describes the subelements of the ramjournal-manager element.
Table A-45 ramjournal-manager Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the factor of live data below which a journal file is eligible for compaction (garbage collection). |
|
|
Optional |
Specifies the maximum size, in bytes, of binary values that are to be stored in the RAM journal. The value cannot exceed 4MB. The default value is Binary values that exceed the maximum value size are automatically delegated to a flash journal. |
|
|
Optional |
Specifies the maximum file size of the underlying journal files. The value must be a power of two and a multiple of the block size. The value must be between 2MB and 2GB. The default value is |
|
|
Optional |
Specifies the amount of time that the journal collector can remain unresponsive prior to considering it timed out. The minimum timeout is 30s. Legal values are strings representing time intervals. The Default value is |
|
|
Optional |
Specifies the maximum amount of RAM that is used by the journal. The value can either be specified as a percentage of the maximum available heap or as a specific amount of memory. If the value contains a percentage sign (%), it is interpreted as a percentage of the maximum JVM heap (the JVM max heap is typically specified by the |
|
|
Optional |
Specifies whether to use in the virtual machine's byte buffer or of-heap NIO buffers. |
Used in: management-config.
The Reporter provides JMX reporting capabilities. The Reporter provides out-of-the-box reports and also supports the creation of custom reports. The reports help administrators and developers manage capacity and trouble shoot problems.
Table A-46 describes the subelements of the reporter element.
Table A-46 reporter Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Required |
Specifies the location for the report group deployment descriptor. The default file is |
|
|
Required |
Specifies whether the Reporter automatically starts when the node starts. Valid values are |
|
|
Required |
Specifies whether the reporter runs on multiple management nodes. Valid values are |
|
|
Optional |
Specifies the time zone to be used for timestamps that are displayed within a report. See |
|
|
Optional |
Specifies the time and date format to be used for timestamps that are displayed within a report. The value must be a pattern supported by the |
Used in: coherence.
Table A-47 describes the subelements of the security-config element.
Table A-47 security-config Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies whether the access controller security feature is enabled. Legal values are The preconfigured system property override is |
|
< |
Required |
Specifies the name of the JAAS LoginModule that is used to authenticate the caller. This name should match a module in a configuration file is used by the JAAS (for example specified by using the |
|
Required |
Contains the configuration information for the class that implements |
|
|
Optional |
Contains the configuration information for the class that implements |
|
|
Optional |
Contains the configuration information for a class that implements the |
|
|
Optional |
Contains the configuration information for the class that implements |
|
|
|
Optional |
Specifies whether the remote cache or service reference is shared by subject. Valid values are |
|
|
Optional |
Contains the configuration information for a class that implements the |
Used in: serializers
The serializer element contains a serializer class configuration. Serializer classes must implement com.tangosol.io.Serializer. A Java serializer and POF serializer are predefined:
<cluster-config>
<serializers>
<serializer id="java">
<class-name>com.tangosol.io.DefaultSerializer</class-name>
</serializer>
<serializer id="pof">
<class-name>com.tangosol.io.pof.ConfigurablePofContext</class-name>
<init-params>
<init-param>
<param-type>String</param-type>
<param-value>pof-config.xml</param-value>
</init-param>
</init-params>
</serializer>
</serializers>
</cluster-config>
Serializer definitions are referenced by individual cache scheme definitions (see "serializer") and can be referenced by the default serializer for services that do not explicitly define a serializer (see "defaults").
Additional serializers can be defined in an operational override file as required.
Table A-48 describes the subelements of the serializer element.
Table A-48 serializer Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies a class that implements |
|
|
Optional |
Specifies a factory class for creating custom serializer instances. The instances must implement This element cannot be used with the |
|
< |
Optional |
Specifies the name of a static factory method on the factory class which performs object instantiation. |
|
Optional |
Contains class initialization parameters for the serializer implementation. |
Used in: cluster-config
The serializers element contains the declarative data for each serializer.
Table A-49 describes the subelements of the serializers element.
Table A-49 serializers Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies the declarative data of a particular serializer. |
Used in: services.
Specifies the configuration for Coherence services.
The types of services which can be configured includes:
PartitionedService.PartitionedCache—A cache service which evenly partitions cache entries across the cluster nodes which run the service. This service is often referred to as the distributed cache service
ReplicatedCache—A cache service which maintains copies of all cache entries on all cluster nodes which run the service.
ReplicatedCache.Optimistic—A version of the ReplicatedCache which uses optimistic locking.
SimpleCache —A version of the ReplicatedCache which lacks concurrency control.
LocalCache—A cache service for caches where all cache entries reside in a single cluster node.
InvocationService—A service used for performing custom operations on remote cluster nodes.
ProxyService—A service that accepts connections from Coherence*Extend clients.
RemoteCache—A service that routes cache operations from Coherence*Extend clients to a cache on the cluster.
RemoteInvocation— A service that routes cache invocation tasks from Coherence*Extend clients to a cache on the cluster.
NameService—A service that is a specialized TCP acceptor that allows Coherence*Extend clients to connect to a proxy by specifying a proxy service name instead of a proxy service address.
Table A-50 describes the subelements of the services element.
Table A-50 service Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the canonical name for a service, allowing the service to be referenced from the |
|
< |
Required |
Specifies either the fully qualified class name of the service or the relocatable component name relative to the base Service component. Legal values are:
|
|
< |
Optional |
Contains the list of <use-filters> <filter-name>gzip</filter-name> </use-filters> The example activates |
|
Optional |
Specifies the initialization parameters that are specific to each service. Each parameter is described below. |
The <init-param> element in the Coherence operational configuration deployment descriptor defines initialization parameters for a service. The parameters that appear under init-param are different, depending on the service.
The following sections describe the parameters that can be configured for each of the services:
The tables in each section describes the specific <param-name>/<param-value> pairs that can be configured for each service. The Parameter Name column refers to the value of the <param-name> element and Parameter Value Description column refers to the possible values for the corresponding <param-value> element.
A DistributedCache service supports the parameters listed in Table A-51. These settings may also be specified for each service instance as part of the <distributed-scheme> element in the coherence-cache-config.xml descriptor.
Table A-51 DistributedCache Service Parameters
| Parameter Name | Parameter Value Description |
|---|---|
|
|
Specifies the lease ownership granularity. Legal values are:
A value of |
|
|
Specifies the number of distributed cache partitions. Each storage-enabled cluster member that is running the distributed cache service manages a balanced number of partitions. Valid values are positive integers between 1 and 32767 and should be a prime number. The default value is 257 partitions. See "Changing the Number of Partitions" for additional details. |
|
|
Specifies whether this member of the Normally this value should be left unspecified within the configuration file, and instead set on a per-process basis using the The preconfigured system property override is |
|
|
Specifies the threshold for the primary buckets distribution in kilobytes. When a new node joins the distributed cache service or when a member of the service leaves, the remaining nodes perform a task of bucket ownership re-distribution. During this process, the existing data gets rebalanced along with the ownership information. This parameter indicates a preferred message size for data transfer communications. Setting this value lower makes the distribution process take longer, but reduces network bandwidth utilization during this activity. Legal values are integers greater then zero. The default value is 0.5MB. The preconfigured system property override is |
|
|
Specifies the number of members of the partitioned cache service that hold the backup data for each unit of storage in the cache. The default value is 1. The preconfigured system property override is |
|
Specifies the number of daemon threads used by the partitioned cache service. Legal values are positive integers, Set the value to The preconfigured system property override is |
|
|
|
Specifies the name of a class that implements the |
|
|
Specifies the name of a class that implements the |
|
|
Specifies the name of a class that implements the |
|
|
Specifies the amount of time in milliseconds that a task can execute before it is considered hung. Legal values are positive integers or zero (indicating no default timeout). Note: a posted task that has not yet started is never considered hung. This attribute is applied only if the Thread pool is used (the The preconfigured system property override is |
|
|
Specifies the timeout value in milliseconds for requests executing on the service worker threads. This attribute applies only if the thread pool is used (the The preconfigured system property override is |
|
|
Specifies the maximum amount of time a client waits 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 value of this element must be in the following format:
If the value does not contain a unit, a unit of milliseconds is assumed. Legal values are positive integers or zero (indicating no default timeout). The default value is The preconfigured system property override is |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies the number of members of the partitioned cache service that holds 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 is backed up on the number of members specified by the 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 is discarded. However, until write-behind occurs, the data is backed up in accordance with the Recommended value is 0. |
|
|
Specifies the guardian timeout value to use for guarding the service and any dependent threads. If the parameter is not specified, the default guardian timeout (as specified by the 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:
If the value does not contain a unit, a unit of milliseconds is assumed. The preconfigured system property override is |
|
|
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. See the service-guardian element to globally configure the service guardian for all services. Legal values are:
|
|
|
Specifies the configuration information for a class that implements the The |
|
|
Specifies quorum policy settings for the partitioned cache service. See "partitioned-quorum-policy-scheme". |
|
|
Specifies the strategy that is used by a partitioned service to manage partition distribution.
The preconfigured system property override is |
|
|
Specifies whether or not backup updates should be compressed in delta form or sent whole. A delta update represents the parts of a backup entry that must be changed in order to synchronize it with the primary version of the entry. Valid values are:
The preconfigured system property override is |
|
|
Specifies the priority for the service thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the event dispatcher thread for each service. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the worker threads. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the name of the transport used by this service for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
|
|
Specifies whether the partitioned (distributed) cache service should backup changes asynchronously while concurrently responding to the client. Legal values are The preconfigured system property override is |
A ReplicatedCache service supports the parameters listed in Table A-52. These settings may also be specified for each service instance as part of the replicated-scheme element in the coherence-cache-config.xml descriptor.
Table A-52 ReplicatedCache Service Parameters
| Parameter Name | Value Description |
|---|---|
|
|
Specifies the duration of the standard lease in milliseconds. When a lease has aged past this number of milliseconds, the lock is automatically released. Set this value to zero to specify a lease that never expires. The purpose of this setting is to avoid deadlocks or blocks caused by stuck threads; the value should be set higher than the longest expected lock duration (for example, higher than a transaction timeout). It's also recommended to set this value higher then packet-delivery/timeout-milliseconds value. Legal values are from positive long numbers or zero. The default value is |
|
|
Specifies the lease ownership granularity. Available since release 2.3.Legal values are:
A value of |
|
|
Specifies whether lease issues should be transferred to the most recent lock holders. Legal values are |
|
|
Specifies the maximum amount of time a client waits 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 value of this element must be in the following format:
If the value does not contain a unit, a unit of milliseconds is assumed. Legal values are positive integers or zero (indicating no default timeout). The default value is The preconfigured system property override is |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies the guardian timeout value to use for guarding the service and any dependent threads. If the paramter is not specified, the default guardian timeout (as specified by the 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:
If the value does not contain a unit, a unit of milliseconds is assumed. The preconfigured system property override is |
|
|
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. See the service-guardian element to globally configure the service guardian for all services. Legal values are:
|
|
|
Specifies the configuration information for a class that implements the The |
|
|
Specifies the priority for the service thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the event dispatcher thread for each service. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the name of the transport used by this service for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
An OptimisiticCache service supports the parameters listed in Table A-53. These settings may also be specified for each service instance as part of the optimistic-scheme element in the coherence-cache-config.xml descriptor.
Table A-53 OptimisiticCache Service Parameters
| Parameter Name | Value, Description |
|---|---|
|
|
Specifies the maximum amount of time a client waits 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 value of this element must be in the following format:
If the value does not contain a unit, a unit of milliseconds is assumed. Legal values are positive integers or zero (indicating no default timeout). The default value is an infinite timeout The preconfigured system property override is |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies the guardian timeout value to use for guarding the service and any dependent threads. If the paramter is not specified, the default guardian timeout (as specified by the 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:
If the value does not contain a unit, a unit of milliseconds is assumed. The preconfigured system property override is |
|
|
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. See the service-guardian element to globally configure the service guardian for all services. Legal values are:
|
|
|
Specifies the configuration information for a class that implements the The |
|
|
Specifies the priority for the service thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the event dispatcher thread for each service. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the name of the transport used by this service for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
An Invocation service supports the parameters listed in Table A-54. These settings may also be specified for each service instance as part of the invocation-scheme element in the coherence-cache-config.xml descriptor.
Table A-54 Invocation Service Parameters
| Parameter Name | Value, Description |
|---|---|
|
|
Specifies the number of daemon threads used by the partitioned cache service. Legal values are positive integers, Set the value to The preconfigured system property override is |
|
|
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 The preconfigured system property override is |
|
|
Specifies the default timeout value in milliseconds for tasks that can be timed-out (for example, implement the The preconfigured system property override is |
|
|
Specifies the default timeout value in milliseconds for requests that can time out (for example, implement the
The value of this element must be in the following format:
If the value does not contain a unit, a unit of milliseconds is assumed. Legal values are positive integers or zero (indicating no default timeout). The default value is an infinite timeout The preconfigured system property override is |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies the guardian timeout value to use for guarding the service and any dependent threads. If the paramter is not specified, the default guardian timeout (as specified by the 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:
If the value does not contain a unit, a unit of milliseconds is assumed. The preconfigured system property override is |
|
|
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. See the service-guardian element to globally configure the service guardian for all services. Legal values are:
|
|
|
Specifies the configuration information for a class that implements the The |
|
|
Specifies the priority for the service thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the event dispatcher thread for each service. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the worker threads. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the name of the transport used by this service for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
A LocalCache service supports the parameters listed in Table A-55.
Table A-55 LocalCache Service Parameters
| Parameter Name | Parameter Value Description |
|---|---|
|
|
Specifies whether locking is enforced for put, remove and clear operations. If the value is false, a client is responsible for calling lock and unlock explicitly. The default value is |
|
|
Specifies the number of milliseconds to continue trying to obtain a lock. This parameters is only used if locking enforcement is enabled. A value of The default value is |
A Proxy service supports the parameters listed in Table A-56. These settings may also be specified for each service instance as part of the proxy-scheme element in the coherence-cache-config.xml descriptor.
Table A-56 Proxy Service Parameters
| Parameter Name | Value Description |
|---|---|
|
|
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. |
|
|
Contains the configuration of the clustered service proxies managed by this service. |
|
|
Specifies the exact number of daemon threads for use by the proxy service. Legal values are positive integers or Proxy service threads perform operations on behalf of the calling application. Therefore, when explicitly setting the number of threads, set the value to as many threads as there are concurrent operations that are occurring. The preconfigured system property override is |
|
|
Specifies the amount of time in milliseconds that a task can execute before it is considered hung. Legal values are positive integers or zero (indicating no default timeout). Note: a posted task that has not yet started is never considered hung. This attribute is applied only if the Thread pool is used (the The preconfigured system property override is |
|
|
Specifies the default timeout value in milliseconds for tasks that can be timed-out (for example, implement the The preconfigured system property override is |
|
|
Specifies the maximum amount of time a proxy waits for requests that are sent to other proxies of the same name. This parameter should not be used because requests are never sent between proxies. |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies the guardian timeout value to use for guarding the service and any dependent threads. If the parameter is not specified, the default guardian timeout (as specified by the 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:
If the value does not contain a unit, a unit of milliseconds is assumed. The preconfigured system property override is |
|
|
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. See the service-guardian element to globally configure the service guardian for all services. Legal values are:
|
|
|
Specifies the configuration information for a class that implements the The |
|
|
Specifies quorum policy settings for the Proxy service. |
|
|
Specifies the default load balancing strategy that is used by a proxy service if a strategy is not explicitly configured as part of the proxy scheme. Legal values are:
|
|
|
Specifies the priority for the service thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the event dispatcher thread for each service. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the priority for the worker threads. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
|
|
Specifies the name of the transport used by this service for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
|
|
Specifies the maximum number of daemon threads that are allowed in the thread pool. This parameter is only valid if a The preconfigured system property override is |
|
|
Specifies the minimum number of daemon threads that are allowed (and initially created) in the thread pool. This parameter is only valid if a The preconfigured system property override is |
A RemoteCache service supports the parameters listed in Table A-57. These settings may also be specified for each service instance as part of the remote-cache-scheme element in the coherence-cache-config.xml descriptor.
Table A-57 RemoteCache Service Parameters
| Parameter Name | Parameter Value Description |
|---|---|
|
|
Contains the configuration of the connection initiator used by the service to establish a connection with the cluster. |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
|
|
Specifies whether key association processing is done by the extend client or deferred to the cluster side. Valid values are |
A RemoteInvocation service supports the parameters listed in Table A-58. These settings may also be specified for each service instance as part of the remote-invocation-scheme element in the coherence-cache-config.xml descriptor.
Table A-58 RemoteInvocation Service Parameters
| Parameter Name | Parameter Value Description |
|---|---|
|
|
Contains the configuration of the connection initiator used by the service to establish a connection with the cluster. |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
A NameService service supports the parameters listed in Table A-59.
Table A-59 NameService Parameters
| Parameter Name | Parameter Value Description |
|---|---|
|
|
Contains the configuration of a connection acceptor that is used discover proxy services that are available in the cluster for use by Coherence*Extend clients. |
|
|
Specifies a serializer class for object serialization. Serializer classes must implement the |
Used in: cluster-config
Specifies the configuration of the service guardian, which detects and attempts to resolve service deadlocks.
Table A-60 describes the subelements of the service-guardian element.
Table A-60 service-guardian Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the action to take when an abnormally behaving service thread cannot be terminated gracefully by the service guardian. Legal values are:
|
|
|
Optional |
The timeout value used to guard against deadlocked or unresponsive services. It is recommended that The preconfigured system property override is |
The content override attribute xml-override can be optionally used to fully or partially override the contents of this element with XML document that is external to the base document. See "Attribute Reference" for more information.
Used in: cluster-config
The services element contains the declarative data for each service.
Table A-50 describes the subelements of the services element.
Table A-61 services Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the declarative data of a particular service. |
Used in: cluster-config.
Specifies the action a cluster node should take upon receiving an external shutdown request. External shutdown includes the "kill" command on UNIX and Ctrl-C on Windows and UNIX.
Table A-62 describes the subelements of the shutdown-listener element.
Table A-62 shutdown-listener Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the type of action to take upon an external JVM shutdown. Legal values:
Note: For production use, the suggested value is none unless testing has verified that the behavior on external shutdown is exactly what is desired. The preconfigured system property override is |
Used in: well-known-addresses, address-provider
The socket-address element specifies the address (IP, or DNS name, and port) to which a socket is bound.
Table A-63 describes the subelements of the socket-address element.
Table A-63 socket-address Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the IP address that a Socket listens or publish on. Enter either an IP address or DNS name. Note: The localhost setting may not work on systems that define localhost as the loopback address; in that case, specify the computer name or the specific IP address. |
|
< |
Required |
Specifies the port that the Socket listens or publish on. Legal values are from 1 to 65535. Note: When setting up a WKA member, the port value must match the port value that is specified for the unicast listener port. See the |
Used in: socket-providers, unicast-listener, ssl.
The <socket-provider> element contains the configuration information for a socket and channel factory. The following socket providers are supported and referenced using their defined id attribute name.
<socket-providers> <socket-provider id="system"> <system/> </socket-provider> <socket-provider id="tcp"> <tcp/> </socket-provider> <socket-provider id="ssl"> <ssl> <identity-manager> <key-store> <url system-property="tangosol.coherence.security.keystore"> file:keystore.jks</url> <password system-property="tangosol.coherence.security.password"/> </key-store> <password system-property="tangosol.coherence.security.password"/> </identity-manager> <trust-manager> <algorithm>PeerX509</algorithm> <key-store> <url system-property="tangosol.coherence.security.keystore"> file:keystore.jks</url> <password system-property="tangosol.coherence.security.password"/> </key-store> </trust-manager> <socket-provider>tcp</socket-provider> </ssl> </socket-provider> <socket-provider id="sdp"> <sdp/> </socket-provider> </socket-providers>
Alternate SSL definitions can be created to support more elaborate SSL configurations.
Table A-64 describes the subelements of the socket-provider element.
Table A-64 socket-provider Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies a socket provider that produces instances of the JVM's default socket and channel implementations. This is the default socket provider. |
|
|
Optional |
Specifies a socket provider that produces socket and channel implementations which use SSL. |
|
|
Optional |
Specifies a socket provider that produces TCP-based sockets and channel implementations. |
|
|
Optional |
Specifies a socket provider that produce SDP-based sockets and channel implementations provided that the JVM and underlying network stack supports SDP. |
Used in cluster-config
The socket-providers element contains the declarative data for each socket provider implementation. Coherence supports the following socket providers: system, tcp, ssl, and sdp.
Table A-65 describes the subelements of the socket-providers element.
Table A-65 socket-providers Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies the configuration information for a socket and channel factory. |
Used in: socket-provider.
The <ssl> element contains the configuration information for a socket provider that produces socket and channel implementations which use SSL. If SSL is configured for the unicast listener, the listener must be configured to use well known addresses.
Table A-66 describes the subelements of the ssl element.
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the name of the protocol used by the socket and channel implementations produced by the SSL socket provider. The default value is |
|
|
Optional |
Specifies the configuration for a security provider instance. |
|
|
Optional |
Specifies the configuration information for an implementation of the A |
|
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 A |
|
Optional |
Specifies the configuration information for a delegate provider for SSL. Valid values are |
Used in: cluster-config.
The TCP-ring provides a means for fast death detection of another node within the cluster. When enabled, the cluster nodes use a single "ring" of TCP connections spanning the entire cluster. A cluster node can use the TCP connection to detect the death of another node within a heartbeat interval (the default value s one second; see the <heartbeat-milliseconds> subelement of packet-delivery). If disabled, the cluster node must rely on detecting that another node has stopped responding to UDP packets for a considerately longer interval (see the <timeout-milliseconds> subelement of packet-delivery). When the death has been detected it is communicated to all other cluster nodes.
Table A-67 describes the subelements of the tcp-ring-listener element.
Table A-67 tcp-ring-listener Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies whether the tcp ring listener should be enabled to defect node failures faster. Valid values are |
|
< |
Optional |
Specifies the timeout to use for determining that a computer that is hosting cluster members has become unreachable. A number of connection attempts may be made before determining that the unreachable members should be removed. Legal values are strings representing time intervals. A timeout of The values of the This feature relies upon the |
|
|
Optional |
specifies the number of connection attempts to make before determining that a computer that is hosting cluster members has become unreachable, and that those cluster members should be removed. The values of the |
|
|
Optional |
Specifies the size of the TCP/IP server socket backlog queue. Valid values are positive integers. The default value is operating system dependent. |
|
< |
Required |
Specifies a priority of the tcp ring listener execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is 6. |
Used in: packet-publisher.
The traffic-jam element is used to control the rate at which client threads enqueue packets for the packet publisher to transmit on the network. When the limit is exceeded any client thread is forced to pause until the number of outstanding packets drops below the specified limit. To limit the rate at which the Publisher transmits packets see the flow-control element.
Table A-68 describes the subelements of the traffic-jam element.
Table A-68 traffic-jam Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the maximum number of pending packets that the Publisher tolerates before determining that it is clogged and must slow down client requests (requests from local non-system threads). Zero means no limit. This property prevents most unexpected out-of-memory conditions by limiting the size of the resend queue. The default value is |
|
< |
Required |
Number of milliseconds that the Publisher pauses a client thread that is trying to send a message when the Publisher is clogged. The Publisher does not allow the message to go through until the clog is gone, and repeatedly sleeps the thread for the duration specified by this property. The default value is |
Used in: ssl.
The <trust-manager> element contains the configuration information for initializing a javax.net.ssl.TrustManager instance.
A trust manager is responsible for managing the trust material that is used when making trust decisions and for deciding whether credentials presented by a peer should be accepted.
A valid trust-manager configuration contains at least one child element.
Table A-69 describes the elements of the trust-manager element.
Table A-69 trust-manager Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
Specifies the algorithm used by the trust manager. The default value is |
|
|
Optional |
Specifies the configuration for a security provider instance. |
|
Optional |
Specifies the configuration for a key store implementation. |
Used in: cluster-config.
Specifies the configuration information for the Unicast listener. This element is used to specify the address and port that a cluster node binds to, to listen for point-to-point cluster communications.
By default Coherence uses a multicast protocol to discover other nodes when forming a cluster. If multicast networking is undesirable, or unavailable in your environment, the well-known-addresses feature may be used to eliminate the need for multicast traffic.
Table A-70 describes the subelements of the unicast-listener element.
Table A-70 unicast-listener Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies either: the configuration for a socket provider, or it references a socket provider configuration that is defined within the <socket-provider>ssl</socket-provider> The preconfigured system property override is |
|
|
|
Optional |
Specifies the name of the transport used by TCMP for reliable point-to-point communication. Valid values are: The preconfigured system property override is |
|
Optional |
Contains a list of "well known" addresses (WKA) that are used by the cluster discovery protocol instead of using multicast broadcast to discover cluster members. |
|
|
< |
Required |
Specifies the IP address that a Socket listens or publishes on. The address may also be entered using CIDR notation as a subnet and mask (for example, Note: The localhost setting may not work on systems that define localhost as the loopback address; in that case, specify the computer name or the specific IP address. Also, the multicast listener, by default, binds to the same interface as defined by this address. The default value is The preconfigured system property override is |
|
< |
Required |
Specifies the ports that the Socket listens or publishes on. A second port is automatically opened and defaults to the next available port. Legal values are from 1 to 65535. The default value is The preconfigured system property override is |
|
< |
Required |
Specifies whether the unicast port is automatically incremented if the specified port cannot be bound to because it is in use. Legal values are The preconfigured system property override is |
|
Required |
Specifies how many incoming packets the operating system is requested to buffer. The value may be expressed either in terms of packets of bytes. |
|
|
< |
Required |
Specifies a priority of the unicast listener execution thread. Legal values are from 1 to 10 where 10 is the highest priority. The default value is |
Used in: packet-speaker
Specifies the minimum outgoing packet volume which must exist for the speaker daemon to be activated.
Table A-71 describes the subelements of the packet-speaker element.
Table A-71 packet-speaker Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
< |
Required |
Specifies the minimum number of packets which must be ready to be sent for the speaker daemon to be activated. A value of 0 forces the speaker to always be used, while a very high value causes it to never be used. If unspecified (the default), it matches the |
Used in: unicast-listener.
Note:
This is not a security-related feature, and does not limit the addresses which are allowed to join the cluster. See the authorized-hosts element for details on limiting cluster membership.
If you are having difficulties establishing a cluster when using multicast, see Administering Oracle Coherence for instructions on performing a multicast connectivity test.
By default, Coherence uses a multicast protocol to discover other nodes when forming a cluster. If multicast networking is undesirable, or unavailable in your environment, the Well Known Addresses feature may be used to eliminate the need for multicast traffic. When in use the cluster is configured with a relatively small list of nodes which are allowed to start the cluster, and which are likely to remain available over the cluster lifetime. There is no requirement for all WKA nodes to be simultaneously active at any point in time. This list is used by all other nodes to find their way into the cluster without the use of multicast, thus at least one node that is configured as a well-known node must be running for other nodes to be able to join.
The following example configures two well-known-addresses with the default port.
<cluster-config>
<unicast-listener>
<well-known-addresses>
<socket-address id="1">
<address>192.168.0.100</address>
<port>8088</port>
</socket-address>
<socket-address id="2">
<address>192.168.0.101</address>
<port>8088</port>
</socket-address>
</well-known-addresses>
</unicast-listener>
</cluster-config>
Table A-72 describes the subelements of the well-known-addresses element.
Table A-72 well-known-addresses Subelements
| Element | Required/ Optional |
Description |
|---|---|---|
|
Optional |
Specifies a list of WKA that are used by the cluster discovery protocol instead of using multicast broadcast. If one or more WKA is specified, for a member to join the cluster it either has to be a WKA or there has to be at least one WKA member running. Additionally, all cluster communication is performed using unicast. If empty or unspecified, multicast communications is used. The preconfigured system property overrides are |
|
|
Optional |
Contains the configuration for a |
Table A-73 describes the attributes available in the operational deployment descriptor.
Table A-73 Operational Deployment Descriptor Attributes
| Attribute | Required/ Optional |
Description |
|---|---|---|
|
|
Optional |
The The override XML document referred by this attribute does not have to exist. However, if it does exist then its root element must have the same name as the element it overrides. In cases where there are multiple elements with the same name (for example, < The following elements can be overridden by its own XML override file:
|
|
|
Optional |
The |
|
|
Optional |
This attribute is used to specify a system property name for any element. The system property is used to override the element value from the Java command line. This feature enables the same operational descriptor (and override file) to be used across all cluster nodes and customize each node using the system properties. See Appendix C, "System Property Overrides," for more information on this feature. |