Management API Reference for remote-cache-container

The configuration of a remote Infinispan cache container.

Children (4)

component
- connection-pool
- security
remote-cache
remote-cluster
thread-pool
- async

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.remote-cache-container-configuration	true	none
org.wildfly.clustering.infinispan.remote-cache-container	true	none

Attributes (17)

active-connections - The number of active connections to the Infinispan server.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of active connections to the Infinispan server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

connection-timeout - Defines the maximum socket connect timeout before giving up connecting to the server.

Type	LONG
Default Value	60000
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Min	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Defines the maximum socket connect timeout before giving up connecting to the server.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

connections - The total number of connections to the Infinispan server.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The total number of connections to the Infinispan server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

default-remote-cluster - Required default remote server cluster.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Required default remote server cluster.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.clustering.infinispan.remote-cache-container-configuration.remote-cluster", "capability-reference-pattern-elements" : [ "remote-cache-container", "default-remote-cluster" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

idle-connections - The number of idle connections to the Infinispan server.

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The number of idle connections to the Infinispan server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

key-size-estimate - This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing.

Deprecated Since 15.0.0

Deprecated. This attribute will be ignored.

Type	INT
Default Value	64
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 64, "stability" : "default", "deprecated" : { "since" : "15.0.0", "reason" : "Deprecated. This attribute will be ignored." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

marshaller - Defines the marshalling implementation used to marshal cache entries.

Type	STRING
Default Value	LEGACY
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	LEGACY JBOSS PROTOSTREAM
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the marshalling implementation used to marshal cache entries.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "LEGACY", "allowed" : [ "LEGACY", "JBOSS", "PROTOSTREAM" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

max-retries - Sets the maximum number of retries for each request. A valid value should be greater or equals than 0. Zero means no retry will made in case of a network failure.

Type	INT
Default Value	10
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Sets the maximum number of retries for each request. A valid value should be greater or equals than 0. Zero means no retry will made in case of a network failure.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

modules - The set of modules associated with this remote cache container's configuration.

Type	LIST
Default Value	["org.wildfly.clustering.infinispan.client.api"]
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The set of modules associated with this remote cache container's configuration.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : ["org.wildfly.clustering.infinispan.client.api"], "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

properties - A list of remote cache container properties.

Type	OBJECT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A list of remote cache container properties.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

protocol-version - This property defines the protocol version that this client should use.

Type	STRING
Default Value	PROTOCOL_VERSION_41
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	3.0 3.1 4.0 4.1
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This property defines the protocol version that this client should use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PROTOCOL_VERSION_41", "allowed" : [ "3.0", "3.1", "4.0", "4.1" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

socket-timeout - Enable or disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of 0 is interpreted as an infinite timeout.

Type	LONG
Default Value	60000
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Min	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "Enable or disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of 0 is interpreted as an infinite timeout.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

statistics-enabled - Enables statistics gathering for this remote cache.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enables statistics gathering for this remote cache.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

tcp-keep-alive - Configures TCP Keepalive on the TCP stack.

Type	BOOLEAN
Default Value	false
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Configures TCP Keepalive on the TCP stack.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

tcp-no-delay - Enable or disable TCP_NODELAY on socket connections to remote Hot Rod servers.

Type	BOOLEAN
Default Value	true
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Enable or disable TCP_NODELAY on socket connections to remote Hot Rod servers.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

transaction-timeout - The duration (in ms) after which idle transactions are rolled back.

Type	LONG
Default Value	60000
Unit	MILLISECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Min	0
Max	9223372036854775807
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The duration (in ms) after which idle transactions are rolled back.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 60000, "unit" : "MILLISECONDS", "min" : 0, "max" : 9223372036854775807, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

value-size-estimate - This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.

Deprecated Since 15.0.0

Deprecated. This attribute will be ignored.

Type	INT
Default Value	512
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 512, "stability" : "default", "deprecated" : { "since" : "15.0.0", "reason" : "Deprecated. This attribute will be ignored." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Add a remote cache container to the infinispan subsystem.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
connection-timeout	LONG	false	true	60000	Defines the maximum socket connect timeout before giving up connecting to the server.
default-remote-cluster	STRING	false	false		Required default remote server cluster.
key-size-estimate	INT	false	true	64	This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing.
marshaller	STRING	false	true	LEGACY	Defines the marshalling implementation used to marshal cache entries.
max-retries	INT	false	true	10	Sets the maximum number of retries for each request. A valid value should be greater or equals than 0. Zero means no retry will made in case of a network failure.
modules	LIST	false	true	["org.wildfly.clustering.infinispan.client.api"]	The set of modules associated with this remote cache container's configuration.
properties	OBJECT	false	true		A list of remote cache container properties.
protocol-version	STRING	false	true	PROTOCOL_VERSION_41	This property defines the protocol version that this client should use.
socket-timeout	LONG	false	true	60000	Enable or disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of 0 is interpreted as an infinite timeout.
statistics-enabled	BOOLEAN	false	true	false	Enables statistics gathering for this remote cache.
tcp-keep-alive	BOOLEAN	false	true	false	Configures TCP Keepalive on the TCP stack.
tcp-no-delay	BOOLEAN	false	true	true	Enable or disable TCP_NODELAY on socket connections to remote Hot Rod servers.
transaction-timeout	LONG	false	true	60000	The duration (in ms) after which idle transactions are rolled back.
value-size-estimate	INT	false	true	512	This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a remote cache container to the infinispan subsystem.",
    "request-properties" : {
        "connection-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Defines the maximum socket connect timeout before giving up connecting to the server.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "default-remote-cluster" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Required default remote server cluster.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.clustering.infinispan.remote-cache-container-configuration.remote-cluster",
            "capability-reference-pattern-elements" : [
                "remote-cache-container",
                "default-remote-cluster"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-size-estimate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "This hint allows sizing of byte buffers when serializing and deserializing keys, to minimize array resizing.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 64,
            "stability" : "default",
            "deprecated" : {
                "since" : "15.0.0",
                "reason" : "Deprecated. This attribute will be ignored."
            }
        },
        "marshaller" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the marshalling implementation used to marshal cache entries.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "LEGACY",
            "allowed" : [
                "LEGACY",
                "JBOSS",
                "PROTOSTREAM"
            ],
            "stability" : "default"
        },
        "max-retries" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Sets the maximum number of retries for each request. A valid value should be greater or equals than 0. Zero means no retry will made in case of a network failure.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10,
            "stability" : "default"
        },
        "modules" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The set of modules associated with this remote cache container's configuration.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : ["org.wildfly.clustering.infinispan.client.api"],
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A list of remote cache container properties.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "protocol-version" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "This property defines the protocol version that this client should use.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PROTOCOL_VERSION_41",
            "allowed" : [
                "3.0",
                "3.1",
                "4.0",
                "4.1"
            ],
            "stability" : "default"
        },
        "socket-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "Enable or disable SO_TIMEOUT on socket connections to remote Hot Rod servers with the specified timeout, in milliseconds. A timeout of 0 is interpreted as an infinite timeout.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "statistics-enabled" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enables statistics gathering for this remote cache.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "tcp-keep-alive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Configures TCP Keepalive on the TCP stack.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "tcp-no-delay" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable or disable TCP_NODELAY on socket connections to remote Hot Rod servers.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "transaction-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The duration (in ms) after which idle transactions are rolled back.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 60000,
            "unit" : "MILLISECONDS",
            "min" : 0,
            "max" : 9223372036854775807,
            "stability" : "default"
        },
        "value-size-estimate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "This hint allows sizing of byte buffers when serializing and deserializing values, to minimize array resizing.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 512,
            "stability" : "default",
            "deprecated" : {
                "since" : "15.0.0",
                "reason" : "Deprecated. This attribute will be ignored."
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove a cache container from the infinispan subsystem.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove a cache container from the infinispan subsystem.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.infinispan.remote-cache-container

        
<feature spec="subsystem.infinispan.remote-cache-container">
  <param name="remote-cache-container" value="{resource name}"/>
  <param name="connection-timeout" value="{value}"/>
  <param name="default-remote-cluster" value="{value}"/>
  <param name="key-size-estimate" value="{value}"/>
  <param name="marshaller" value="{value}"/>
  <param name="max-retries" value="{value}"/>
  <param name="modules" value="{value}"/>
  <param name="properties" value="{value}"/>
  <param name="protocol-version" value="{value}"/>
  <param name="socket-timeout" value="{value}"/>
  <param name="statistics-enabled" value="{value}"/>
  <param name="tcp-keep-alive" value="{value}"/>
  <param name="tcp-no-delay" value="{value}"/>
  <param name="transaction-timeout" value="{value}"/>
  <param name="value-size-estimate" value="{value}"/>
<feature/>