Management API Reference for passivation-store

A passivation store

Deprecated Since 10.0.0

Deprecated. Use distributable-cache instead

Provided Capabilities (1)

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

Attributes (3)

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?	resource-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" : "resource-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?	resource-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" : "resource-services" }`

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?	resource-services
Min	0
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" : 0, "max" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Adds a 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
max-size	INT	false	true	10000	The maximum number of beans this cache should store before forcing old beans to passivate

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a 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"
        },
        "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" : 0,
            "max" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a passivation store

Raw DMR model


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

        
<feature spec="subsystem.ejb3.passivation-store">
  <param name="passivation-store" value="{resource name}"/>
  <param name="bean-cache" value="{value}"/>
  <param name="max-size" value="{value}"/>
<feature/>