herence.ce.coherence.14.1.1-0-11.source-code.coherence-operational-config.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of coherence Show documentation
Show all versions of coherence Show documentation
Oracle Coherence Community Edition
Copyright (c) 2000, 2021, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.
This is the XML schema for the Coherence configuration file.
The coherence element is the root element of the tangosol-coherence
descriptor.
The cluster-config element contains the cluster configuration info.
Used in: coherence
The logging-config element contains the configuration info
for the logging facility.
Used in: coherence
The tracing-config element contains the configuration info
for the tracing facility.
Used in: coherence
The cache-factory-builder-config element contains the configuration
info for constructing an instance of
com.tangosol.net.CacheFactoryBuilder. CacheFactoryBuilder provides a
pluggable interface for building and managing multiple cache factory
configurations cross multiple class loaders.
Used in: coherence
The scope-resolver element contains the
configuration info for a class that implements the
com.tangosol.net.ScopeResolver interface.
Used in: cache-factory-builder-config
The management-config element contains the configuration information
for the Coherence Management Framework.
Used in: coherence
The security-config element contains the configuration info
for the Coherence Security Framework.
For details please refer to the Coherence Security Framework guide at
http://www.tangosol.com/downloads/SecurityFramework.pdf
Used in: coherence
The license-config element contains the location of the license
repository and the details of the license that this member
will utilize.
Used in: coherence
The federation-config element contains the federation configuration info.
It contains the details for the federation participants and the topology
definitions.
Used in: coherence
The member-identity element contains detailed identity information that
is useful for defining the location and role of the cluster member.
Used in: cluster-config
The cluster-name element contains the name of the cluster. In order to
join the cluster all members must specify the same cluster name.
It is strongly suggested that cluster-name be specified for production
systems, thus preventing accidental clustering among unrelated
applications running on the same network.
Used in: member-identity
The priority element specifies a priority of the corresponding member
or thread.
In the member-identity element, the priority is used as the basis for
determining tie-breakers between members. If a condition occurs in
which one of two members will be ejected from the cluster, and in the
rare case that it is not possible to objectively determine which of
the two is at fault and should be ejected, then the member with the
lower priority will be ejected.
For all other elements, the priority is a Java Thread priority.
Valid values are from 1 to 10.
Used in: unicast-listener, multicast-listener, packet-speaker,
packet-publisher, tcp-ring-listener, incoming-message-handler,
member-identity
The unicast-listener element contains the unicast listener
configuration info.
Used in: cluster-config
The well-known-addresses element contains a list of "well known"
addresses (WKA) that are used by the cluster discovery protocol in
place of multicast broadcast or an address provider (factory) that
would generate those addresses. If the well-known-addresses element
is specified, for a member to join the cluster it will either have
to be a WKA or there will have to be at least one WKA member running.
Additionally, all cluster communication will be performed using
unicast.
Note: The specification of "well known" ports for WKA is unnecessary
and thus deprecated as of 12.2.1. This includes the use of the socket-address
element within well-known-addresses, which is replaced by the address element.
Similarly the use of ports within WKA address providers is deprecated and the
specified port may be ignored in future releases.
Used in: unicast-listener
The machine-id is an identifier that should uniquely identify each
server machine. If not specified, a default value is generated from
the machine-name, or lacking that, from the address of the default
network interface.
The machine id for each machine in the cluster can be used by cluster
services to plan for failover by making sure that each member is
backed up by a member running on a different machine.
As of Coherence 3.2, the machine-id setting is deprecated. It will
eventually become a read-only property, and will be automatically
configured as part of the discovery process. Instead of setting
machine-id, it is suggested that machine-name
(and rack-name and site-name) be specified.
Used in: unicast-listener
The multicast-listener element contains the multicast related
configuration info.
Used in: cluster-config
The tcp-ring-listener element contains the tcp ring related
configuration info.
Used in: cluster-config
The ip-timeout element specifies the timeout to use for determining
that a machine hosting cluster members has become unreachable, and
that those cluster members should be removed. The value should be
high enough to insulate against allowable temporary network outages.
Note: This feature relies upon the java.net.InetAddress.isReachable
mechanism, see
http://java.sun.com/j2se/1.5.0/docs/api/java/net/InetAddress.html#isReachable(int)
for a description of how it will identify reachability.
Legal values are strings representing time intervals. A timeout of 0 will
disable machine level monitoring and is not recommended.
Default value is "5s".
Used in: tcp-ring-listener
The ip-attempts element specifies the number of connection attempts to
make before determining that a machine hosting cluster members has become
unreachable, and that those cluster members should be removed.
The values of the ip-timeout and ip-attempts elements should be high
enough to insulate against allowable temporary network outages.
Legal values are positive integers.
Default value is "3".
Used in: tcp-ring-listener
The value of the listen-backlog element is used to configure the size
of the TCP/IP server socket backlog queue.
Valid values are positive integers.
Default value is O/S dependent.
Used in: tcp-ring-listener
The shutdown-listener element contains the JVM shutdown hook
configuration info.
Valid values of the "enabled" element are "none" (same as "false"),
"force"
(same as "true") and "graceful".
The "force" option causes the shutdown hook to perform a "hard-stop" of
cluster services by calling Cluster.stop(). The "graceful" option will
initiate a normal shutdown procedure by calling Cluster.shutdown().
Used in: cluster-config
The service-guardian element contains service guardian related
configuration info.
Used in: cluster-config
The service-failure-policy element contains the configuration info for
how to respond an abnormally behaving service.
Legal values are: "exit-cluster", "exit-process", "logging", or
configuration info for a class that implements the
com.tangosol.net.ServiceFailurePolicy interface.
The pre-defined policies are:
"exit-cluster"
This option will attempt to recover threads that appear be unresponsive,
and failing that, attempt to stop the associated service. If the
associated service cannot be stopped, this policy will cause the local
node to stop the cluster services
"exit-process"
This option will attempt to recover threads that appear be unresponsive,
and failing that, attempt to stop the associated service. If the
associated service cannot be stopped, this policy will cause the local
node to exit the JVM to terminate abruptly
"logging"
This option will cause any detected problems to be logged, but no
corrective action will be taken
Default value is "exit-cluster".
Used in: service-guardian
The packet-speaker element contains the packet speaker related
configuration info.
Used in: cluster-config
The packet-publisher element contains the packet publisher related
configuration info.
Used in: cluster-config
The packet-size element contains the packet size related
configuration info.
Used in: packet-publisher
The packet-delivery element contains the packet delivery related
configuration info.
Used in: packet-publisher
The notification-queueing element contains the notification queue
related configuration info.
Used in: packet-publisher
The packet-buffer element contains information on how many packets the
OS will be requested to buffer for incoming (listeners) and outgoing
(publisher).
The value may be expressed either in terms of packets or bytes.
Used in: unicast-listener, multicast-listener, packet-publisher
The traffic-jam element contains the configuration for how to deal with
client threads during a publisher-clogged condition.
Used in: packet-publisher
The volume-threshold element specifies the minimum outgoing packet
volume which must exist for the speaker daemon to be activated. When
the volume is relatively low it may be more efficient for the
speaker's operations to be performed on the publisher's thread.
Used in: packet-speaker
The incoming-message-handler element contains the incoming message
handler (also known as a receiver) related configuration info.
Used in: cluster-config
The outgoing-message-handler element contains the outgoing message
handler related configuration info.
Used in: cluster-config
The authorized-hosts element contains the collection of IP addresses of
the unicast listeners for the cluster nodes that are allowed to join the
cluster. If this collection is empty no constraints are imposed.
Used in: cluster-config
The services element contains the declarative data for each service.
Used in: cluster-config
The service element contains the declarative data of a particular
service.
Used in: services
The use-filters element contains the list of filter names to be used
by this service.
Used in: service, outgoing-message-handler
The cluster-quorum-policy configuration element contains the
configuration info for the quorum-based action policy for the
cluster service.
Used in: cluster-config
The timeout-site-quorum configuration element specifies the
minimum number of sites with cluster members in a given role that must remain
in order to terminate one or more cluster members due to a detected network
timeout, irrespective of the root cause. Role-specific quorum values
can be specified using the "role" attribute, for example:
2
Valid values are non-negative integers.
Used in: cluster-quorum-policy
The timeout-machine-quorum configuration element specifies the
minimum number of machines with cluster members in a given role that must remain
in order to terminate one or more cluster members due to a detected network
timeout, irrespective of the root cause. Role-specific quorum values
can be specified using the "role" attribute, for example:
4
Valid values are non-negative integers.
Used in: cluster-quorum-policy
The timeout-survivor-quorum configuration element specifies the
minimum number of cluster members in a given role that must remain
in order to terminate one or more cluster members due to a detected network
timeout, irrespective of the root cause. Role-specific quorum values
can be specified using the "role" attribute, for example:
50
Valid values are non-negative integers.
Used in: cluster-quorum-policy
The serializers element contains the declarative data for each
serializer.
Used in: cluster-config
The serializer element contains the declarative data of a particular
serializer.
Used in: serializers
The persistence-environments element contains the declarative
data for each persistence environment.
Used in: cluster-config
The persistence-mode element determines whether the enclosing
environment is used to continually persist cached data (active)
or only when requested (on-demand).
Legal values are: active, active-async and on-demand
Default value is "active".
Used in: persistence-environment
The active-directory element contains the path to a directory
under which cached data is actively persisted by a persistent
environment.
Default value is ${user.home}/coherence/active
Used in: persistence-environment
The snapshot-directory element contains the path to a directory
under which copies of cached data are persisted by a persistent
environment.
Default value is ${user.home}/coherence/snapshots
Used in: persistence-environment
The trash-directory element contains the path to a directory
under which potentially corrupted persisted data is stored by
a persistent environment.
Default value is ${user.home}/coherence/trash
Used in: persistence-environment
The archive-directory element contains the path to a directory
under which persistent snapshots can be archived to.
Used in: directory-archiver
The persistent-environment element contains configuration information
for a PersistenceEnvironment implementation.
Used in: persistence-environments
The snapshot-archivers element contains the declarative data
for each persistent snapshot archiver.
Used in: cluster-config
The custom-archiver element contains configuration information
for a custom SnapshotArchiver implementation.
Used in: snapshot-archivers
The directory-archiver element contains configuration information
for a directory based SnapshotArchiver implementation.
Used in: snapshot-archivers
The address-providers element contains the declarative data for each
address-provider.
Used in: cluster-config
The server-factory element contains the configuration info for the
MBeanServer factory that implements the
com.tangosol.net.management.MBeanServerFinder interface.
Used in: management-config
The reporter element contains the configuration parameters for the
reporter.
Used in:management-config
The extended-mbean-name element specifies whether or not global
MBean names that are identified with a "nodeId" attribute are
additionally extended to also identify the corresponding member
name (if specified). For example:
Coherence:type=Service,name=DistributedCache,member=Client1,nodeId=7
Used in: management-config
The configuration element contains the location for the Reporter Batch
XML.
Used in: reporter
The distributed element specifies whether or not the reporter runs on
multiple management nodes.
Default value is false.
Used in: reporter
The timezone element specifies the time zone that should be
used for date display.
Default value is null (which indicates local time zone).
Used in: reporter
The timeformat element indicates the format used for date display.
This should be a string that can be parsed by java.text.SimpleDateFormat.
Default value is "EEE MMM dd HH:mm:ss zzz yyyy".
Used in: reporter
The mbeans element contains a list of MBeans to be registered when a
node joins the cluster.
Used in: management-config
The mbean element contains the information required to register an
MBean.
Used in: mbeans
The mbean-filter element contains the declarative data for a class used
to reduce the number of MBeans registered with the Coherence JMX framework.
The specified class needs to implement the com.tangosol.util.Filter
interface and is passed MBean names (note that the names may not include
the domain name). Evaluation of "false" will prevent the corresponding MBean
registration.
Used in: management-config
The mbean-class element contains the name of a class to instantiate and
register with the Coherence Management Framework.
Used in: mbean
The mbean-factory element contains the name of a class factory used to
obtain MBeans to register with the Coherence Management Framework.
Used in: mbean
The mbean-query element contains an MBean query string used to obtain
MBeans from a local MBean server to register with the Coherence Management
Framework.
Used in: mbean
The mbean-server-domain element contains the name of a default domain
for the source MBeanServer. This is used to locate the MBeanServer where the
mbean-query should be executed.
Used in: mbean
The local-only element controls the MBean visibility across the
cluster. If set to true, the MBean is registered only with a
local MBeanServer and is not accessible by other cluster nodes;
otherwise the "nodeId=..." key attribute is added to its name and
the MBean will be visible from any of the "managing" nodes (the ones
that have the "managed-nodes" element set to values of "all" or
"remote-only").
Default value is false.
Used in: mbean
The mbean-accessor element contains the method name on the factory
class used to obtain an MBean.
Used in: mbean
The mbean-name element contains the name of the MBean as it will be
registered with the Coherence Management Framework.
Used in: mbean
The extend-lifecycle element contains a flag controlling the MBean life
cycle. If set to true, the MBean life cycle extends to the life cycle of
the JVM; Otherwise, it coincides with the the cluster node life cycle.
Default value is false.
Used in: mbean
The access-controller element contains the configuration info for the
class that implements the com.tangosol.net.security.AccessController
interface, which will be used by the Coherence Security Framework to
check access right and encrypt/decrypt node-to-node communications.
Used in: security-config
The callback-handler element contains the configuration info
for the class that implements the CallbackHandler interface
which will be called if an attempt is made to access a
protected clustered resource when there is no identity
associated with the caller.
Used in: security-config
The edition-name element specifies the product edition that the member
will utilize. This allows multiple product editions to be used within
the same cluster, with each member specifying the edition that it will
be using.
Valid values are:
- "GE" or "grid" - Grid Edition
- "EE" or "enterprise" - Enterprise Edition
- "CE" or "community" - Community Edition
- "SE" or "standard" - Standard Edition
- "RTC" or "realtime" - Real-Time Client
- "DC" or "client" - Data Client
It is optional to provide a value for this element.
Used in: license-config
The license-mode element specifies whether the product is being used in
a development or production mode. Note that this property may be
specified either in the base operational configuration file, or via
system-properties, but may not be configured via an override file,
as it is used is selecting the override file.
Valid values are "prod" (Production), and "dev" (Development).
It is optional to provide a value for this element.
Used in: license-config
The login-module-name element specifies the name of the JAAS
LoginModule that should be used to authenticate the caller. This
name should match a module in a configuration file will be used
by the JAAS (for example specified via the
"-Djava.security.auth.login.config" Java command line attribute).
For details please refer to the LoginModule Developer's Guide at
http://java.sun.com/j2se/1.4.2/docs/guide/security/jaas/JAASLMDevGuide.html
Used in: security-config
The participants element is a container for the definition of
many participant elements.
Used in: federation-config
The participant element specifies the remote coherence cluster that is
participating in the federation. The name of the participant should be
identical to the cluster-name of the participating cluster.
The use of "name-service-addresses" in "participant" has been deprecated.
"remote-addresses" can be used to specify both NameService addresses by
specifying the cluster port of the remote participant, and direct connect addresses
for environments which cannot use the NameService for address lookups.
Specifying the cluster port of the remote participant in remote-addresses is
recommended.
Used in: participants
The initial-action element specifies the startup action for the remote participant. The action is taken
by the local participant when it starts up.
Used in: participant
The connect-timeout element specifies the timeout of
a connection to a destination participant.
Legal values are strings representing time intervals.
Default value is "1m".
Used in: participant
The connect-retry-timeout element specifies the total
amount of time in retrying to connect to a destination
participant before giving up.
Legal values are strings representing time intervals.
e.g. "5m" for 5 minutes, "5h" for 5 hours,
and "5s" or "5" for 5 seconds, the default unit.
Default value is "0", no timeout.
Used in: participant
The send-timeout element specifies the ack timeout
for a federated replication message.
Legal values are strings representing time intervals.
Default value is "5m".
Used in: participant
The max-bandwidth element specifies the maximum network bandwidth
that can be utilized for sending out the replication messages.
The legal values are decimal values with optional factor and unit descriptors.
Legal factor descriptor includes "K" or "k" (kilo, 2^10), "M" or "m" (kilo, 2^20),
"G" or "g" (kilo, 2^30) and "T" or "t" (kilo, 2^40) which indicates with which the
decimal value should be multiplied. If no factor is specified, a factor of one is
assumed.
Legal unit descriptor includes "bps" which indicates bits per second and "Bps"
which indicates bytes per second. The letters "ps" could be either in uppercase or
lowercase. If no unit is specified, a unit of bits per second is assumed.
Default value is unlimited.
Used in: participant
The send-old-value flag indicates if the federation service should include the old
values when replicating updated cache entries to the remote participants.
The legal value is true or false.
Default value is true.
Used in: participant
The batch-size element specifies the maximum number of journal
entries that can be selected for replication. Its primary use
is to keep the heap memory usage within limits when replicating.
Legal values are integers representing the number of entries.
Default value is 50.
Used in: participant
The geo-ip element specifies the GeoIP metadata
for the participant. Its a free-form field with
no implicit structure. The users are free to define
their own delimiters for latitude/longitude/country-code etc.
Used in: participant
The participant-destinations element is a container for the
definition of one or more participant-destination elements.
Used in: participant
The participant-destination element contains destination specific
information (e.g. for a specific federation service) for a given
participant.
Used in: participant-destinations
The participant-type element specifies the type of the participant. If not specified,
(remote) cluster is the default type.
Used in: participant
The topology-definitions element specifies the topology configuration
info.
Used in: federation-config
The active-active topology is a topology where there are one or more
active participants that send data to other active participants.
Used in: topology-definitions
The active-passive topology is a topology where there are one or more
active participants that send data to other active and passive participants.
The active participants never re-sends the data and the passive participants
only receive data.
Used in: topology-definitions
The hub-spoke topology is a topology where the spoke participants only receive data.
The hub-participant sends data to all the spoke participants.
Used in: topology-definitions
The central-replication topology is a topology where the leaf participants
send data to the hub participant, and the hub participant re-sends (repeats)
the data to all the other leaf participants. Any change that originate at the
hub-participant are sent to all the leaf participants.
Used in: topology-definitions
The custom-topology is a free-form topology that consists of a group list.
A group consist of participants with specific roles like sender, repeater or receiver.
Only sender and repeater can send/forward changes to other participants in the group.
Used in: topology-definitions
The groups element is a container for the definition of
many group elements.
Used in: custom-topology
The group element specifies a set of participants with a well-defined role. All the
participants can receive data irrespective of their roles.
A sender participant only sends data that originated in its local cluter.
A repeater participant can send data that originated locally as well as data that it received
from other participants.
A receiver participant never sends data.
Used in: groups
The managed-nodes element specifies whether or not a cluster node's JVM
has an [in-process] MBeanServer and if so, whether or not this node allows
management of other nodes' managed objects.
Legal values are: "none", "local-only", "remote-only", "dynamic" or "all".
"none"
No MBean server is instantiated on this cluster node.
"local-only"
Manage only MBeans which are local to this cluster node (that is, within the same JVM).
"remote-only"
Manage MBeans on other remotely manageable cluster nodes.
See "allow-remote-management" subelement.
"all"
Manage both local and remotely manageable cluster nodes.
See "allow-remote-management" subelement.
"dynamic"
Allow this node to automatically host an MBean server and manage all MBeans.
Default value is "dynamic".
Used in: management-config
The http-managed-nodes element specifies whether or not a cluster node's JVM
has an [in-process] HTTP management server. When set to "inherit", if this
node is running an MBeanServer then it will also start an HTTP management
server. See the managed-nodes element for information on running an
MBeanServer.
Legal values are: all, inherit, or none.
Default value is "none".
Used in: management-config
The allow-remote-management element specifies whether or not this
cluster node exposes its managed objects to remote MBeanServer(s).
Legal values are: true or false.
Used in: management-config
The refresh-policy element specifies the method which is used to
refresh remote management information.
Legal values are: refresh-ahead, refresh-behind and refresh-expired.
Default value is "refresh-expired".
Used in: management-config
The refresh-expiry element specifies the time interval (in
milliseconds) after which a remote MBean information will
be invalidated on the management node.
Legal values are strings representing time intervals.
Default value is "1s".
Used in: management-config
The refresh-timeout element specifies the duration which the management
node will wait 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.
Default value is "250ms".
Used in: management-config
The read-only element specifies whether or not the managed objects
exposed by this cluster node allow operations that modify run-time
attributes.
Legal values are true or false.
Used in: management-config
The default-domain-name element specifies the default domain name for
the MBeanServer used to register MBeans exposed by the Coherence
management framework.
This value is only used by the cluster nodes that have in-process
MBeanServer and allow management of local or other node's managed
objects.
If this value is not specified, the first existing MBeanServer will be
used.
Used in: management-config
The domain-name-suffix element enables configuring an application meaningful
domain name suffix to append to domain name. When this element's value is a
non-empty string, the domain name is "Coherence@" appended with the value.
This value is only used by the cluster nodes that have in-process
MBeanServer and allow management of local or other node's managed
objects.
Defaults to empty string.
Used in: management-config
The service-name element specifies the name of the Invocation service
name used for remote management. This element is used only if
allow-remote-management is set to true.
Default value is "Management".
Used in: management-config
The interface element specifies the IP or sub-net of the local network
interface (NIC) which is to be used for multicast traffic.
For configurations which use multicast only for discovery the default
value is calculated using the unicast-listener/discovery-address.
For configurations which use multicast for both discovery and data transmission
(i.e. multicast-threshold-percent is set to a value less then 100) the default
value is the interface of the unicast-listener.
WARNING: With rare exception, use of this particular option is strongly
discouraged when multicast is enabled for data transmissions, as it can
lead to a condition known as "partial failure". Partial failure occurs
when some portion of the cluster communication is working and other cluster
communication has failed. Partial failure can occur when using this option,
because the interface (and thus network) used for multicast traffic can be
different from the interface (and thus network) used for unicast (UDP/IP) and
TCP-ring (TCP/IP) traffic. If one interface (or network) fails, some communication
can continue to succeed, while other communication will fail, which may
cause failover to take longer to occur. Since clustering handles node
(and thus interface) failure, it is preferable to have all communication
fail together, and thus the use of this option is strongly discouraged.
Used in: multicast-listener
The time-to-live element specifies a time-to-live setting for the
multicast.
Valid values are from 0 to 255.
Used in: multicast-listener
The join-timeout-milliseconds element specifies the number of
milliseconds that a new member will wait without finding any
evidence of a cluster before starting its own cluster and
electing itself as the senior cluster member.
Valid values are from 1 to 1000000.
Used in: multicast-listener
The group threshold is used to determine whether a packet will be sent
via 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 (i.e. not counting self) destination nodes of
size "d" (in the range of 0 to n-1), the packet will be sent multicast
if and only if the following both hold true:
1) The packet is being sent over the network to more than one other
node: (d > 1)
2) The number of nodes is greater than the threshold:
(d > (n-1) * (threshold/100))
Setting this value to 1 will allow the implementation to use multicast for
for basically all multi-point traffic. Setting it to 100 will force
the implementation to use unicast for all multi-point traffic except for
explicit broadcast traffic (e.g. cluster heartbeat and discovery.)
Note: that a values less then 100 will also prevent this cluster from
sharing its cluster port with other clusters running on the same machine.
Valid values are from 1 to 100.
Used in: multicast-listener
The maximum-length element 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.
Used in: packet-size
The preferred-length element specifies the preferred size, in bytes,
of the DatagramPacket objects that will be sent and received on
the unicast and multicast sockets.
This value can be larger or smaller then the maximum-length value, and
need not be the same for all cluster members. The ideal value is one
which will fit within the network MTU, leaving enough space for either
the UDP or TCP packet headers, which are 32, and 52 bytes respectively.
This value should be at least 512, and default to a value based on the
local node's MTU. An MTU of 1500 is assumed if the MTU cannot be obtained.
Used in: packet-size
The resend-milliseconds element specifies the minimum amount of time,
in milliseconds, before a packet's data is resent across the network
if the packet has the ConfirmationRequired option set and the packet
has not been acknowledged by a Receipt packet.
Used in: packet-delivery
For packet-delivery: The maximum amount of time, in milliseconds, that
a packet's data will be resent across the network if the packet has the
ConfirmationRequired option set and the packet has not been
acknowledged by a Receipt Packet.
For service-guardian: The timeout value used to guard against
deadlocked or unresponsive services. It is recommended that
service-guardian/timeout-milliseconds be set equal to or greater
than the packet-delivery/timeout-milliseconds value. A timeout of
zero will disable service guardians.
Used in: packet-delivery, service-guardian
The heartbeat-milliseconds element 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.
Used in: packet-delivery
The ack-delay-milliseconds element specifies the number of milliseconds
that the packet publisher will delay before sending an Ack packet.
Used in: notification-queueing
The nack-delay-milliseconds element specifies the number of
milliseconds that the packet publisher will delay before sending
a Nack packet.
Used in: notification-queueing
The flow-control element contains configuration information related to
packet throttling and remote GC detection.
Used in: packet-delivery
The packet-bundling element contains configuration information related
to the bundling of multiple small packets into a single larger packet
in order to reduce the load on the network switching infrastructure.
Defines the maximum number of packets that will be resent to an
unresponsive cluster node before assuming that the node is paused,
for example due to a full GC. Once a node is marked as paused,
packets will be sent at a lower rate until the node resumes responding.
This is used as a form of remote GC detection to avoid flooding a node
while it is incapable of responding.
Used in: flow-control
Defines the number of unconfirmed packets that will be sent to a
cluster node before packets addressed to that node will be deferred. This
helps to prevent the sender from flooding the recipient's network
buffers. The value is specified as a range by using the maximum-packets and
minimum-packets elements, from which the runtime setting will be
dynamically adjusted based on network statistics.
Used in: flow-control
For traffic-jam: The maximum number of packets in the send plus resend
queues that the Publisher will tolerate 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. Suggested default value is 8192.
For packet-buffer: The number of packets of maximum size that the
datagram socket will be asked to size itself to buffer.
See java.net.SocketOptions#SO_RCVBUF and
java.net.SocketOptions#SO_SNDBUF. Defaults are 32 for publishing,
64 for multicast listening, and 1428 for unicast listening. Actual
buffer sizes may be smaller if the underlying socket implementation
cannot support more than a certain size.
For pause-detection: The maximum number of packets that will be resent
to an unresponsive cluster node before assuming that the node is
paused. Specifying a value of 0 will disable pause detection.
Default is 16.
For outstanding-packets: The maximum number of unconfirmed packets that
will be sent to a cluster node before packets addressed to that node will
be deferred. It is recommended that this value not be set below 256.
Default is 4096.
Used in: packet-buffer, traffic-jam, outstanding-packets
For packet-buffer: The requested size of the underlying socket buffer
in bytes.
Default is selected based upon the preferred packet size.
Used in: packet-buffer
For volume-threshold: Specifies the minimum number of packets which
must be ready to be sent for the speaker daemon to be activated.
A value of 0 will force the speaker to always be used, while a very
high value will cause it to never be used. If unspecified Coherence
will auto adjust the threshold to find the maximum sustainable volume.
For outstanding-packets: The lower bound on the range for the number of
unconfirmed packets that will be sent to a cluster node before
packets addressed to that node will be deferred. Default is 64.
Used in: volume-threshold
For traffic-jam: Number of milliseconds that the Publisher will pause a
client thread that is trying to send a message when the Publisher is
clogged. The Publisher will not allow the message to go through
until the clog is gone, and will repeatedly sleep the thread for the
duration specified by this property. Default value is 10.
Used in: traffic-jam
The maximum amount of time to defer a packet while waiting for
additional packets to bundle. A value of zero will result in the
algorithm not waiting, and only bundling the readily accessible
packets. A value greater than zero will cause 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. Default value is 1us (microsecond).
Used in: packet-bundling
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.
Default value is zero.
Used in: packet-bundling
The maximum-time-variance element 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 will be closer between multiple systems running in the cluster;
however, the process of joining the cluster will be 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
it is possible that a larger value would be necessary.
Used in: incoming-message-handler
The use-nack-packets element specifies whether the packet receiver will
use negative acknowledgements (packet requests) to pro-actively respond
to known missing packets.
Valid values are "true" or "false".
Used in: incoming-message-handler
The service-type element contains the canonical name of the
service. This name is unique within the cluster.
Used in: service
The service-component element contains either the fully qualified class
name of the service or the relocatable component name relative to the base
Service component.
Used in: service
The logger-name element allows to specify a logger name within chosen
logging system that should be used to log Coherence related messages.
This value is only used by the "jdk, "log4j", and "slf4j" logging systems.
Default value is "Coherence".
Used in: logging-config
The subject-scope element defines whether the remote cache or service
reference is shared by subject. The setting of "true" means that
remote references are not globally shared; each subject will get a
different reference.
Valid values are "true" or "false".
Default value is "false".
Used in: security-config
The socket-providers element contains the declarative data for each
socket-provider.
Used in: cluster-config
Provides configuration for the Journaling Subsystem
Used in: cluster-config
Provides an abstract type with common elements in both
ramjournal-manager and flashjournal-manager
Used in: ramjournal-manager, flashjournal-manager
Provides configuration for Ram Journaling
Used in: journaling-config
Provides configuration for Flash Journaling
Used in: journaling-config
The factor of live data below which a Journal file is eligible
for compaction (garbage collection).
Used in: ramjournal-manager, flashjournal-manager
The maximum size for any serialized value in either journal.
Used in: ramjournal-manager, flashjournal-manager
The maximum file size for any file.
Used in: ramjournal-manager, flashjournal-manager
The collector-timeout element specifies the amount of time the
Journal's Collector can remain unresponsive prior to considering
it timed out. The minimum timeout is 30s.
Legal values are strings representing time intervals.
Default value is "10m".
Used in: ramjournal-manager, flashjournal-manager
The maximum capacity for the Journal as a memory size. Only when
configuring ramjournal-manager can this value be a percentage of
the max heap.
Note: Either this element or maximum-file-size should be used
Note: When used with flashjournal-manager a value of 0 disables
flash storage
Used in: ramjournal-manager, flashjournal-manager
Boolean indicating whether to use in VM byte buffer or of-heap NIO buffers.
Used in: ramjournal-manager
The desired block size for writes to the device.
Used in: flashjournal-manager
The size of buffers being recycle (i.e. never released back).
Used in: flashjournal-manager
The delay after last usage which a temporary file used by the Journaling subsystem
is eligible for removal.
Used in: flashjournal-manager
The high journal size is a soft limit on the journal size either
expressed as a memory size or a percentage of the maximum-size.
This allows the GC thread to tune itself to try to avoid growing
the journal beyond the high journal size.
This is not a hard-limit and the journal could still grow beyond that
up to the max file count (511).
Used in: flashjournal-manager
The writer-timeout element specifies the amount of time the
Flash Journal's Writer can remain unresponsive prior to considering
it timed out. The minimum timeout is 30s.
Legal values are strings representing time intervals.
Default value is "8h".
Used in: flashjournal-manager
The storage-authorizers element contains the declarative data
for each storage authorizer.
Used in: cluster-config
The storage-authorizer element contains the declarative data for
a storage access authorizer, which must be an instance of the
com.tangosol.net.security.StorageAccessAuthorizer interface.
Used in: storage-authorizers
The password-providers element contains the definition of
many password-provider elements.
Used in: cluster-config