Management API Reference for infinispan-session-management

Infinispan-based session management provider

Children (1)

affinity
- local
- none
- primary-owner
- ranked

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.clustering.web.session-management-provider	true	/subsystem=distributable-web/hotrod-session-management=*

Attributes (4)

cache - The name of the cache associated with this provider

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 associated with this provider", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration", "capability-reference-pattern-elements" : [ "cache-container", "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 associated with this provider

Type	STRING
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 associated with this provider", "expressions-allowed" : false, "required" : true, "nillable" : false, "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" }`

granularity - Defines the strategy for persisting the attributes of a session

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	ATTRIBUTE SESSION
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Defines the strategy for persisting the attributes of a session", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "SESSION", "ATTRIBUTE" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

marshaller - Indicates the marshalling implementation used for serializing attributes of a session

Type	STRING
Default Value	JBOSS
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	JBOSS PROTOSTREAM
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Indicates the marshalling implementation used for serializing attributes of a session", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "JBOSS", "allowed" : [ "JBOSS", "PROTOSTREAM" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

Operations (2)

add - Adds a distributable session management provider

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
cache	STRING	false	false		The name of the cache associated with this provider
cache-container	STRING	true	false		The name of the cache container associated with this provider
granularity	STRING	true	true		Defines the strategy for persisting the attributes of a session
marshaller	STRING	false	true	JBOSS	Indicates the marshalling implementation used for serializing attributes of a session

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds a distributable session management provider",
    "request-properties" : {
        "cache" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the cache associated with this provider",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.clustering.infinispan.cache-configuration",
            "capability-reference-pattern-elements" : [
                "cache-container",
                "cache"
            ],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "cache-container" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the cache container associated with this provider",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.clustering.infinispan.default-cache-configuration",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "granularity" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Defines the strategy for persisting the attributes of a session",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "SESSION",
                "ATTRIBUTE"
            ],
            "stability" : "default"
        },
        "marshaller" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Indicates the marshalling implementation used for serializing attributes of a session",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "JBOSS",
            "allowed" : [
                "JBOSS",
                "PROTOSTREAM"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Removes a distributable session management provider

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a distributable session management provider",
    "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.distributable-web.infinispan-session-management

        
<feature spec="subsystem.distributable-web.infinispan-session-management">
  <param name="infinispan-session-management" value="{resource name}"/>
  <param name="cache" value="{value}"/>
  <param name="cache-container" value="{value}"/>
  <param name="granularity" value="{value}"/>
  <param name="marshaller" value="{value}"/>
<feature/>