Management API Reference for setting=session-cookie

Session cookie configuration

Attributes (6)

comment - Cookie comment

Deprecated Since 13.0.0

Ignored. Cookie comments were deprecated for removal as of version 6.0 of the Jakarta Servlet specification, per RFC 6265.

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Cookie comment", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Ignored. Cookie comments were deprecated for removal as of version 6.0 of the Jakarta Servlet specification, per RFC 6265." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

domain - Cookie domain

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Cookie domain", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

http-only - Is cookie http-only

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Is cookie http-only", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

max-age - Max age of cookie

Type	INT
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Max age of cookie", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

name - Name of the cookie

Type	STRING
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the cookie", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

secure - Is cookie secure?

Type	BOOLEAN
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Is cookie secure?", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add session cookie configuration

Request Parameter	Type	Required	Expressions Allowed	Description
comment	STRING	false	true	Cookie comment
domain	STRING	false	true	Cookie domain
http-only	BOOLEAN	false	true	Is cookie http-only
max-age	INT	false	true	Max age of cookie
name	STRING	false	true	Name of the cookie
secure	BOOLEAN	false	true	Is cookie secure?

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add session cookie configuration",
    "request-properties" : {
        "comment" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Cookie comment",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "13.0.0",
                "reason" : "Ignored. Cookie comments were deprecated for removal as of version 6.0 of the Jakarta Servlet specification, per RFC 6265."
            }
        },
        "domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Cookie domain",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "http-only" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Is cookie http-only",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "max-age" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "Max age of cookie",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        },
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the cookie",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "secure" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Is cookie secure?",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove session cookie configuration

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove session cookie configuration",
    "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.undertow.servlet-container.setting.session-cookie

        
<feature spec="subsystem.undertow.servlet-container.setting.session-cookie">
  <param name="servlet-container" value="{resource name}"/>
  <param name="comment" value="{value}"/>
  <param name="domain" value="{value}"/>
  <param name="http-only" value="{value}"/>
  <param name="max-age" value="{value}"/>
  <param name="name" value="{value}"/>
  <param name="secure" value="{value}"/>
<feature/>