herence.ce.coherence.23.03.source-code.coherence-config-base.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, 2022, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.
Oracle Coherence Base Schema definitions that is included by
the different schema files.
Time string type. Values of elements of this type must be
in the following format:
(\d)+(\.\d+)?(MS|ms|S|s|M|m|H|h|D|d)?
where the first non-digits (from left to right) indicate the
unit of time duration:
-MS or ms (milliseconds)
-S or s (seconds)
-M or m
(minutes)
-H or h (hours)
-D or d (days)
If the value does not contain a unit, a unit of
seconds is assumed.
Memory size string type. Values of elements of this type must
be in the
following format:
(\d)+(\.\d+)?(K|k|M|m|G|g|T|t)?(B|b)?
where the first non-digit (from left to right) indicates the
factor with which the preceding decimal value should be multiplied:
-K or k
(kilo, 2^10)
-M or m (mega, 2^20)
-G or g (giga, 2^30)
-T or t (tera,
2^40)
If the value does not contain a factor, a factor of one is assumed.
Memory size string type. Values of elements of this type must
be in the
following format:
(\d)+(K|k|M|m|G|g|T|t)?(B|b)?
where the first non-digit (from left to right) indicates the
factor with which the preceding decimal value should be multiplied:
-K or k
(kilo, 2^10)
-M or m (mega, 2^20)
-G or g (giga, 2^30)
-T or t (tera,
2^40)
If the value does not contain a factor, a factor of one is assumed.
percentage type.
The port element specifies a port used by a socket.
Valid values are from 0 to 65535.
Used in: local-address, socket-address,
unicast-listener, multicast-listener, socket-address
The description element is used to provide text describing
the parent element.
Used in: param
Valid values are true and false.
Used in: security-config, packet-speaker, packet-publisher, mbean, flow-control,
cache-service-proxy, invocation-service-proxy
The address element specifies an IP address or DNS name.
In the case of a bind address, the address may be also be
represented in CIDR format as a subnet and mask (i.e. 192.168.1.0/24),
allowing runtime resolution against available local IPs.
Additionally the bind address may be an external NAT address which routes
to any local address and so long as the ports are equal.
Used in: local-address, socket-address, well-known-addresses, address-provider
The local discovery address element specifies an IP address or DNS name.
Used in conjunction with well-known addresses, will bind to a specific IP.
With multicast, network traffic will be constrained to the
network interface corresponding to the resolved IP address.
The address may be also be represented in CIDR format as a subnet and mask (i.e. 192.168.1.0/24),
allowing runtime resolution against available local IPs.
Used in: unicast-listener, default is the wildcard address
The to-address element specifies the ending IP address (inclusive)
for a range of hosts.
Used in: host-range
The from-address element specifies the starting IP address for a range
of
hosts.
Used in: host-range
The autostart element is intended to be used by cache servers
(i.e. com.tangosol.net.DefaultCacheServer). It specifies
whether or not the cache services associated with the
cache scheme should be automatically started at a cluster node.
Valid values are "true" or "false". Default value is false.
Used in: replicated-scheme, distributed-scheme,
transactional-scheme, optimistic-scheme, invocation-scheme,
near-scheme, read-write-backing-map-scheme, view-scheme, reporter
The instance entity defines the selection of an implementation class
or class-factory name and init-params.
Used in: class-scheme, partitioned-quorum-policy-scheme
The instance element defines the selection of an implementation class
or class-factory name and init-params.
The class-name element specifies a fully specified name of a Java
class.
Note: in all schemes except the class-scheme, the specified class must:
a) extend the corresponding scheme implementation class
b) use
identical set of parameters for its constructors
Used in: class-scheme, local-scheme, near-scheme,
overflow-scheme, read-write-backing-map-scheme, external-scheme,
paged-external-scheme, async-store-manager, custom-store-manager,
bdb-store-manager, nio-file-manager, serializer,
configurable-cache-factory-config, access-controller,
callback-handler, instance, host-filter
The class-factory-name element specifies a fully specified name of a
Java
class that will be used by the factory approach for the class-scheme.
Used in: class-scheme
The method-name element specifies a fully specified name of a static
factory
method that will be used by the factory approach for the class-scheme.
Used in: method-scheme
The init-params element contains class initialization parameter
configuration info.
Used in: class-scheme, local-scheme, near-scheme,
overflow-scheme,
read-write-backing-map-scheme,
versioned-backing-map-scheme,
external-scheme,
paged-external-scheme, async-store-manager,
custom-store-manager,
bdb-store-manager,
nio-file-manager,
nio-memory-manager, serializer, address-provider
The init-param element contains the single class initialization
parameter configuration info.
Used in: init-params
The param-name element specifies the name of the initialization
parameter.
When param-name is specified, if the class being constructed and
configured implements the XmlConfigurable interface, then a
series of init-param elements can be transposed in order to
build a configuration XML with which
to configure the constructed object. For example, consider the
following init-params element:
shape
circle
color
blue
If transposed, the result would be:
circle
blue
Used in: init-param
The param-type element specifies the Java type of initialization
parameter.
Supported types are:
- string - indicates that the value is a java.lang.String
- boolean - indicates that the value is a java.lang.Boolean
- int -
indicates that the value is a java.lang.Integer
- long - indicates
that the value is a java.lang.Long
- double - indicates that the
value is a java.lang.Double
- decimal - indicates that the value is a
java.math.BigDecimal
- file - indicates that the value is a
java.io.File
- date - indicates that the value is a java.sql.Date
-
time - indicates that the value is a java.sql.Time
- datetime -
indicates that the value is a java.sql.Timestamp
- xml - indicates
that the value is the param-value XmlElement
- java.lang.ClassLoader - the param-value must be "{class-loader}"
-
com.tangosol.net.BackingMapManagerContext - the param-value must be
"{manager-context}"
- {scheme-ref} - the param-value must be a name
of an existing
"scheme-name" element
- {cache-ref} - the param-value
should be a valid cache name
The value is converted to the specified type, and the target
constructor or method must have a parameter of that type in
order for the instantiation to succeed.
Used in: init-param
The param-value element specifies a value of the initialization
parameter.
The value is in a format specific to the type of the parameter.
There are following pre-defined values (macros):
- {class-loader} -
represents the context ClassLoader
- {manager-context} - represents
the the backing map manager context
- {cache-name} - represents the
cache name
The value element can also contain a user-defined macro in the
following format:
{user-defined-parameter default-value}
The values for user-defined parameters could be specified by the
corresponding init-param elements in the
caching-scheme-mapping/cache-mapping section. For example, the
following cache-mapping elements assigns a value of 10000 to
the custom parameter called "back-size-limit":
dist-*
example-distributed
back-size-limit
10000
That parameter could be used by any elements in the corresponding
scheme. In our case, the following scheme would resolve the value
of the "high-units" to 10000:
example-backing-map
{back-size-limit 0}
Used in: init-param
The port-auto-adjust element specifies whether or not a local port
will be automatically be incremented if the specified port cannot be
bound to because it is already in use. Alternatively port conflicts can
be avoided by using an system assigned ephemeral port by specifying
a corresponding port value of 0.
Valid values are "true", "false", or the upper bound on ports to use, i.e. 65535.
Used in: unicast-listener, local-address
The socket-provider element contains the configuration info for
a socket and channel factory.
In addition to defining a socket-provider, it is also acceptable
and in fact preferred to provide the name of a provider from the
socket-providers configuration within the operational configuration.
Used in: tcp-initiator, tcp-acceptor, defaults, unicast-listener, ssl
The system element specifies a SocketProvider implementation that
produces instances of the JVM's default socket and channel
implementations.
Used in: socket-provider
The tcp element specifies a SocketProvider implementation that produces
TCP based sockets and channel implementations.
Used in: socket-provider
The sdp element specifies a SocketProvider implementation that produces
SDP based sockets and channel implementations.
Used in: socket-provider
The ssl element contains the configuration info for a socket provider
that produces socket and channel implementations which utilize SSL.
Used in: socket-provider
The grpc-insecure element configures
gRPC to use insecure credentials.
Used in: socket-provider
The protocol element specifies the name of the protocol used by the
socket and channel implementations produced by the SSL SocketProvider.
Default value is "TLS".
Used in: ssl
The provider element contains the configuration info for a security
provider that extends the java.security.Provider class.
Used in: ssl, identity-manager, trust-manager
The executor element contains the configuration info for a
java.util.concurrent.Executor instance.
Used in: ssl
The identity-manager element contains the configuration info for
initializing a javax.net.ssl.KeyManager instance.
The manager provides the key material used to authenticate the local
connection to its peer. If no key material is available, the
connection will be unable to present authentication credentials.
Used in: ssl
The algorithm element specifies the name of a key or trust management
algorithm.
Default value is "SunX509".
Used in: identity-manager, trust-manager
The key-store element contains the configuration info for a
java.security.KeyStore instance.
Used in: identity-manager, trust-manager
The key-store-loader element defines an implementation class
or class-factory name and init-params for an implementation
of a com.tangosol.net.ssl.KeyStoreLoader.
The KeyStore type.
The key-store-group defines keystore url or custom loader
and optional keystore password.
Used in: key-store
The key-and-cert-group defines a TLS key and cert.
Used in: key-store within identity-manager
The ca-cert-group defines a CA certificate.
Used in: key-store within identity-manager
The url element contains a Uniform Resource Locator (URL) string.
Used in: key-store
The key element contains the name of a TLS key.
Used in: key-store
The key-loader element defines an implementation class
or class-factory name and init-params for an implementation
of a com.tangosol.net.ssl.PrivateKeyLoader.
The cert element contains the name of a TLS certificate.
Used in: key-store
The cert-loader element defines an implementation class
or class-factory name and init-params for an implementation
of a com.tangosol.net.ssl.CertificateLoader.
The password element specifies the name of a private key or key store
password.
Used in: identity-manager, key-store
The password-url element specifies a URL to use to load the
password of a private key or key store.
Used in: identity-manager, key-store
The trust-manager element contains the configuration info for
initializing a javax.net.ssl.TrustManager instance.
A TrustManager 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 will contain at least one child
element.
Used in: ssl
Allow all connections, even where the URL's host
name and the server's identification
host name do not match.
Use the default hostname verifier.
Host name verification passes if the host name in the certificate matches
the local machine’s host name, and if the URL specifies localhost, 127.0.0.1,
or the default IP address of the local machine.
The action that the default hostname verifier should
take if during the SSL handshake, if the URL's host name
and the server's identification host name do not match.
Used in: hostname-verifier
The hostname-verifier element contains the configuration info for a
javax.net.ssl.HostnameVerifier instance.
During SSL handshaking, if the URL's hostname and the server's
identification hostname mismatch, the verification mechanism
will call back to this instance to determine if the connection
should be allowed.
The default action is to allow connections.
Used in: ssl
The cipher-suites element lists the names of the ciphers that are allowed or disallowed
depending on usage attribute.
If usage is "black-list", the specified ciphers will be removed from the default enabled cipher list.
If usage is "white-list", the specified ciphers will be the enabled ciphers.
The default behavior is a white-list.
Used in: ssl
The protocol-versions element lists the names of the protocol versions that are allowed or disallowed
depending on usage attribute.
If usage is "black-list", the specified protocol versions will be removed from the default enabled protocol list.
If usage is "white-list", the specified protocol versions will be the enabled protocols.
The default behavior is a white-list.
Used in: ssl
The refresh-period element specifies the period to use
to attempt to refresh keys and certs. This is used in
cases where keys or certs have a short lifetime and
need to be refreshed at runtime.
If this element is omitted or is set to a value less than
or equal to zero, then keys and certs will not be refreshed.
The value of this element must be in the following
format:
(\d)+((.)(\d)+)?(MS|ms|S|s|M|m|H|h|D|d)?
where the first
non-digits (from left to right) indicate the unit of time
duration:
-MS or ms (milliseconds)
-S or s (seconds)
-M or m (minutes)
-H or h
(hours)
-D or d (days)
If the value does not contain a unit, a unit of
seconds is assumed.
Used in: ssl
The `refresh-policy` element contains the configuration info for a refresh
policy that extends the `com.tangosol.net.ssl.RefreshPolicy` class
Used in: ssl
The directory element specifies the pathname for the [root] directory
that a disk persistence manager or flashjournal-manager will use to
store files in. If not specified or specifies a non-existent directory,
a temporary file in the default location will be used.
Applicable with the "LH" file-manager in the external-scheme,
the bdb-store-manager, the nio-file-manager, and
the "file-mapped" type for backup-storage.
Used in: external-scheme, backup-storage,
bdb-store-manager, nio-file-manager, flashjournal-manager
The async-limit element specifies the maximum number of bytes that
will be queued to be written asynchronously.
Setting the value to zero does not disable asynchronous writes;
instead, the value of zero indicates that the implementation default
for the maximum number of bytes should be used.
The value of this element must be in the following format:
[\d]+[[.][\d]+]?[K|k|M|m]?[B|b]?
where the first non-digit (from left to right) indicates the factor with
which the preceding decimal value should be multiplied:
-K (kilo, 2^10)
-M (mega, 2^20)
If the value does not contain a factor, a factor of one is assumed.
Valid values are any positive memory sizes and zero.
Default value is 4M.
Used in: external-scheme, async-store-manager, async-limit
The reliable-transport element contains the name of the transport used
by the TCMP for reliable point-to-point communications.
Valid names include: datagram, tmb, sdmb
Specifying a value at the *-scheme level will result in a service specific transport instance rather
then using the shared transport instance defined at the unicast-listener level. In general a shared
transport instance will reduce overall resource consumption.
Default value is tmb.
Used in: unicast-listener, replicated-scheme, optimistic-scheme, distributed-scheme,
transactional-scheme, invocation-scheme, proxy-scheme
The address-provider element contains the
configuration info for an address factory that
implements the com.tangosol.net.AddressProvider interface.
Used in: name-service-addresses, remote-addresses, well-known-addresses,
tcp-acceptor
The local-address element specifies the local address
(IP or DNS name) and port that a TCP/IP socket will be bound
to.
Used in: tcp-initiator, tcp-acceptor, acceptor-address, address-provider
The socket-address element specifies the address
(IP or DNS name) and port of a TCP/IP connection
acceptor.
Used in: address-provider, remote-addresses, well-known-addresses (deprecated as of 12.2.1)
The host-address element specifies a host IP address.
Used in: authorized-hosts
The host-range element describes a range of IP addresses.
Used in: authorized-hosts
The host-filter element contains the class configuration info
for a com.tangosol.util.Filter implementation that is used by
a TCP/IP acceptor to determine whether to accept a particular
TCP/IP initiator. The evaluate() method will be passed the
java.net.InetAddress of the client. Implementations should
return "true" to allow the client to connect.
Used in: authorized-hosts
The remote-addresses element allows a client to specify
the specific address or addresses where the desired proxy
can be located.
Note: For extend clients it is generally preferable to use the
NameService to locate the desired proxy, see the
name-service-addresses element for details.
The remote-addresses element contains the address
(IP or DNS name) and port of one or more TCP/IP
connection acceptors. The TCP/IP
connection initiator uses this information to
establish a TCP/IP connection with a remote cluster.
The TCP/IP connection initiator will attempt to
connect to the addresses in a random order,
until either the list is exhausted or a TCP/IP
connection is established.
Used in: tcp-initiator, participant, participant-destination
The NameService allows an extend client to discover the desired proxy
service without the need to have explicit awareness of where that proxy runs.
The client is configured with a list of some of the machines in the cluster,
and the NameService will redirect the client to its desired proxy, as specified
in the proxy-service-name element. It is also used by federated cache to
discover the members of a remote participant.
The name-service-addresses element contains the address (IP or DNS name) and
cluster port of one or more machines in the cluster. Note the cluster port is
constant across all machines in a given cluster. If the cluster is configured
for multicast discovery and the client resides on the same network the cluster's
multicast address can be used in the name service address list.
Note: unlike remote-addresses name service address resolutions are made against a
specific cluster. If the cluster-name element isn't specified then the client
member's cluster name is used and must match the target cluster.
The ordering of the addresses is largely irrelevant as the NameService will load
balance the clients over all suitable proxy members or members of a remote
participant for federated cache.
Used in: tcp-initiator, participant
The interceptors element is a container for the definition of
many interceptor elements.
Used in: cache-mapping, distributed-scheme
The interceptor element defines all configurable elements
associated with event interceptors.
Event interceptors are notified of events that occur in
Coherence. Each event is of a certain type hence an
interceptor may be interested in a sub set of the events.
Restricting the events to be notified is carried out through
the use of generics and the @Interceptor annotation.
If this interceptor is present within the
caching-scheme-mapping, then it will only be
notified of events pertaining to the specified cache name.
If this interceptor is located within a distributed-scheme,
then the service name is used for restriction.
The instance element should represent the interceptor class
to instantiate and is a mandatory element. The class must
implement the EventInterceptor interface.
The name element should provide a unique identifier for this
interceptor unless specified within the @Interceptor annotation
or to override the value in the annotation. If no name is
assigned for an interceptor, then a unique name is
automatically generated and assigned.
The order element specifies whether this interceptor
is placed at the front of a chain of interceptors unless
specified within the Interceptor annotation or to override the
value in the annotation. The legal values are LOW and HIGH. A
value of HIGH indicates that the interceptor is placed at the
front in the chain of interceptors. A value of LOW indicates no
order preference. The default value is LOW.
Used in: interceptors
The order element specifies iff a value of HIGH is
provided this interceptor will request to be the first in the
chain of interceptors.
Used in: interceptor
The password-provider element defines all configurable elements
associated with a password provider.
Multiple “password-provider” elements can be configured and
referenced using the appropriate “id” attribute.
Used in: password-providers
The named-password-provider element is a reference to another password-provider.
Used in: password-provider
The resources element contains the definition of
one or more resource elements. The resources configured
by the resource elements will be added to the
ResourceRegistry for the Cluster or Service where they
are configured.
The resource element defines a named resource instance.
Multiple “resource” elements can be configured and
referenced using the appropriate “id” attribute.
Used in: resources
The named-resource element is a reference to another resource.
Used in: resource
Configures whether the health check is part of the member's global health check.
Valid values are true and false.
Used in: health
Configures a gRPC ManagedChannelBuilder.
Configures the gRPC load balancer policy.
The default is round_robin.
Used in: grpc-channel
Configures the gRPC load balancer address resolution timeout.
If this value is configured to be less than 1 second, the
default value will be used instead.
The default is 10 seconds.
Used in: grpc-channel
Configures the maximum page size used by the gRPC debug Channelz
service.
See: https://grpc.io/blog/a-short-introduction-to-channelz/
The default is 100.
Used in: grpc-acceptor
Configures a gRPC ManagedChannelBuilder.
The socket-provider element contains the configuration info for
a socket and channel factory.
In addition to defining a socket-provider, it is also acceptable
and in fact preferred to provide the name of a provider from the
socket-providers configuration within the operational configuration.
Used in: grpc-channel