Management API Reference for cluster-passivation-store

A clustered passivation store

Deprecated Since 2.0.0

cluster-passivation-store has been superseded by passivation-store and will be removed in a future release

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.ejb.cluster-passivation-store	false	none

Attributes (7)

bean-cache - The name of the cache used to store bean instances.

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

cache-container - The name of the cache container used for the bean and client-mappings caches

Type	STRING
Default Value	ejb
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache container used for the bean and client-mappings caches", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "ejb", "capability-reference" : "org.wildfly.clustering.infinispan.default-cache-configuration", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

client-mappings-cache - The name of the cache used to store client-mappings of the Jakarta Enterprise Beans remoting connector's socket-bindings

Deprecated Since 2.0.0

This is no longer configurable and will be ignored

Type	STRING
Default Value	remote-connector-client-mappings
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the cache used to store client-mappings of the Jakarta Enterprise Beans remoting connector's socket-bindings", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "remote-connector-client-mappings", "capability-reference" : "org.wildfly.clustering.infinispan.cache-container", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "2.0.0", "reason" : "This is no longer configurable and will be ignored" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }

idle-timeout - The timeout in units specified by idle-timeout-unit, after which a bean will passivate

Type	LONG
Default Value	300
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The timeout in units specified by idle-timeout-unit, after which a bean will passivate", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 300, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

idle-timeout-unit - The unit of idle-timeout

Deprecated Since 2.0.0

SFSBs are no longer passivated eagerly, but only lazily as required by max-size

Type	STRING
Default Value	SECONDS
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	MILLISECONDS MICROSECONDS HOURS SECONDS NANOSECONDS DAYS MINUTES
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The unit of idle-timeout", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "SECONDS", "allowed" : [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "stability" : "default", "deprecated" : { "since" : "2.0.0", "reason" : "SFSBs are no longer passivated eagerly, but only lazily as required by max-size" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

max-size - The maximum number of beans this cache should store before forcing old beans to passivate

Type	INT
Default Value	10000
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Min	1
Max	2147483647
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum number of beans this cache should store before forcing old beans to passivate", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "min" : 1, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

passivate-events-on-replicate - Indicates whether replication should trigger passivation events on the bean

Deprecated Since 2.0.0

This is no longer configurable and will be ignored

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?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates whether replication should trigger passivation events on the bean", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "deprecated" : { "since" : "2.0.0", "reason" : "This is no longer configurable and will be ignored" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

Operations (2)

add - Adds a clustered passivation store

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
bean-cache	STRING	false	false		The name of the cache used to store bean instances.
cache-container	STRING	false	false	ejb	The name of the cache container used for the bean and client-mappings caches
client-mappings-cache	STRING	false	false	remote-connector-client-mappings	The name of the cache used to store client-mappings of the Jakarta Enterprise Beans remoting connector's socket-bindings
idle-timeout	LONG	false	true	300	The timeout in units specified by idle-timeout-unit, after which a bean will passivate
idle-timeout-unit	STRING	false	true	SECONDS	The unit of idle-timeout
max-size	INT	false	true	10000	The maximum number of beans this cache should store before forcing old beans to passivate
passivate-events-on-replicate	BOOLEAN	false	true	true	Indicates whether replication should trigger passivation events on the bean

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a clustered passivation store",
    "request-properties" : {
        "bean-cache" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the cache used to store bean instances.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration",
            "capability-reference-pattern-elements" : [
                "cache-container",
                "bean-cache"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "cache-container" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the cache container used for the bean and client-mappings caches",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "ejb",
            "capability-reference" : "org.wildfly.clustering.infinispan.default-cache-configuration",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "client-mappings-cache" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the cache used to store client-mappings of the Jakarta Enterprise Beans remoting connector's socket-bindings",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "remote-connector-client-mappings",
            "capability-reference" : "org.wildfly.clustering.infinispan.cache-container",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "2.0.0",
                "reason" : "This is no longer configurable and will be ignored"
            }
        },
        "idle-timeout" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LONG"
            },
            "description" : "The timeout in units specified by idle-timeout-unit, after which a bean will passivate",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 300,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "idle-timeout-unit" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The unit of idle-timeout",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "SECONDS",
            "allowed" : [
                "NANOSECONDS",
                "MICROSECONDS",
                "MILLISECONDS",
                "SECONDS",
                "MINUTES",
                "HOURS",
                "DAYS"
            ],
            "stability" : "default",
            "deprecated" : {
                "since" : "2.0.0",
                "reason" : "SFSBs are no longer passivated eagerly, but only lazily as required by max-size"
            }
        },
        "max-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The maximum number of beans this cache should store before forcing old beans to passivate",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "min" : 1,
            "max" : 2147483647,
            "stability" : "default"
        },
        "passivate-events-on-replicate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether replication should trigger passivation events on the bean",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default",
            "deprecated" : {
                "since" : "2.0.0",
                "reason" : "This is no longer configurable and will be ignored"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a clustered passivation store

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a clustered passivation store",
    "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.ejb3.cluster-passivation-store

        
<feature spec="subsystem.ejb3.cluster-passivation-store">
  <param name="cluster-passivation-store" value="{resource name}"/>
  <param name="bean-cache" value="{value}"/>
  <param name="idle-timeout" value="{value}"/>
  <param name="idle-timeout-unit" value="{value}"/>
  <param name="max-size" value="{value}"/>
  <param name="passivate-events-on-replicate" value="{value}"/>
<feature/>