Management API Reference for subsystem=undertow

Information about the web container handling of this deployment

Stability Level: default

Children (2)

Attributes (11)

active-sessions - Number of active sessions

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

context-root - The context root of the web application

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The context root of the web application", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

expired-sessions - Number of sessions that have expired

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Number of sessions that have expired", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

highest-session-count - The maximum number of sessions that have been active simultaneously

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

max-active-sessions - The maximum allowed number of concurrent sessions that this session manager supports

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The maximum allowed number of concurrent sessions that this session manager supports", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

rejected-sessions - Number of rejected sessions

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Number of rejected sessions", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

server - The name of server this application belongs to

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of server this application belongs to", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

session-avg-alive-time - Average time that expired sessions had been alive

Type	INT
Unit	SECONDS
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Average time that expired sessions had been alive", "expressions-allowed" : false, "required" : true, "nillable" : false, "unit" : "SECONDS", "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

session-max-alive-time - The longest time that an expired session had been alive

Type	INT
Unit	SECONDS
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The longest time that an expired session had been alive", "expressions-allowed" : false, "required" : true, "nillable" : false, "unit" : "SECONDS", "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

sessions-created - Total sessions created

Type	INT
Where is the attribute stored?	runtime
Access Type	metric
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "Total sessions created", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "metric", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

virtual-host - The name of the virtual host on which the web application is served

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the virtual host on which the web application is served", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (9)

get-session-attribute - Returns a specific attribute from a session

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id to list the attributes for
attribute	STRING	true	false		The attribute to get

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "get-session-attribute",
    "description" : "Returns a specific attribute from a session",
    "request-properties" : {
        "session-id" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The session id to list the attributes for",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The attribute to get",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

get-session-creation-time - Gets the session creation time in ISO-8601 format

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "get-session-creation-time",
    "description" : "Gets the session creation time in ISO-8601 format",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

get-session-creation-time-millis - Gets the session creation time in milliseconds since unix epoch

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id

Reply properties

Type: LONG

Raw DMR model


{
    "operation-name" : "get-session-creation-time-millis",
    "description" : "Gets the session creation time in milliseconds since unix epoch",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "LONG"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

get-session-last-accessed-time - Gets the session last accessed time in ISO-8601 format

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id

Reply properties

Type: STRING

Raw DMR model


{
    "operation-name" : "get-session-last-accessed-time",
    "description" : "Gets the session last accessed time in ISO-8601 format",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "STRING"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

get-session-last-accessed-time-millis - Gets the session last accessed time in milliseconds since unix epoch

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id

Reply properties

Type: LONG

Raw DMR model


{
    "operation-name" : "get-session-last-accessed-time-millis",
    "description" : "Gets the session last accessed time in milliseconds since unix epoch",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "LONG"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

invalidate-session - Invalidates a given session

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id to invalidate

Reply properties

Type: BOOLEAN

Raw DMR model


{
    "operation-name" : "invalidate-session",
    "description" : "Invalidates a given session",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id to invalidate",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {"type" : {
        "TYPE_MODEL_VALUE" : "BOOLEAN"
    }},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

list-session-attribute-names - Lists the session attribute names

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id to list the attributes for

Reply properties

Type

LIST

Value Type


STRING

Raw DMR model


{
    "operation-name" : "list-session-attribute-names",
    "description" : "Lists the session attribute names",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id to list the attributes for",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        }
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

list-session-attributes - Lists all attributes in a session

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
session-id	STRING	true	false		The session id to list the attributes for

Reply properties

Type

LIST

Value Type


PROPERTY

Raw DMR model


{
    "operation-name" : "list-session-attributes",
    "description" : "Lists all attributes in a session",
    "request-properties" : {"session-id" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The session id to list the attributes for",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "PROPERTY"
        }
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

list-sessions - Lists all active sessions

Reply properties

Type

LIST

Value Type


STRING

Raw DMR model


{
    "operation-name" : "list-sessions",
    "description" : "Lists all active sessions",
    "request-properties" : {},
    "reply-properties" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "LIST"
        },
        "value-type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        }
    },
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}