:read-resource-description(operations=true,recursive=true) > /tmp/undertow.txt { "outcome" => "success", "result" => { "description" => "Undertow subsystem", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.undertow", "dynamic" => false, "stability" => "default" }, { "name" => "org.wildfly.undertow.http-invoker", "dynamic" => false, "stability" => "default" } ], "attributes" => { "default-security-domain" => { "type" => STRING, "description" => "The default security domain used by web deployments", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "other", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"security-domain-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-server" => { "type" => STRING, "description" => "The default server to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default-server", "capability-reference" => "org.wildfly.undertow.server", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-servlet-container" => { "type" => STRING, "description" => "The default servlet container to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.servlet-container", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-virtual-host" => { "type" => STRING, "description" => "The default virtual host to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default-host", "capability-reference" => "org.wildfly.undertow.host", "capability-reference-pattern-elements" => [ "default-server", "default-virtual-host" ], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "instance-id" => { "type" => STRING, "description" => "The cluster instance id (defaults to {$jboss.node.name} if undefined)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => expression "${jboss.node.name}", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "obfuscate-session-route" => { "type" => BOOLEAN, "description" => "Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Operation Adds subsystem", "request-properties" => { "default-security-domain" => { "type" => STRING, "description" => "The default security domain used by web deployments", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "other", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "default-server" => { "type" => STRING, "description" => "The default server to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default-server", "capability-reference" => "org.wildfly.undertow.server", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "default-servlet-container" => { "type" => STRING, "description" => "The default servlet container to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.servlet-container", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "default-virtual-host" => { "type" => STRING, "description" => "The default virtual host to use for deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default-host", "capability-reference" => "org.wildfly.undertow.host", "capability-reference-pattern-elements" => [ "default-server", "default-virtual-host" ], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "instance-id" => { "type" => STRING, "description" => "The cluster instance id (defaults to {$jboss.node.name} if undefined)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => expression "${jboss.node.name}", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "obfuscate-session-route" => { "type" => BOOLEAN, "description" => "Obfuscate the instance-id when routing, thus preventing that data from being sent across connections when serving HTTP requests with the HTTP invoker", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "statistics-enabled" => { "type" => BOOLEAN, "description" => "Configures if statistics are enabled. Changes take effect on the connector level statistics immediately, deployment level statistics will only be affected after the deployment is redeployed (or the container is reloaded).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Operation Removes subsystem", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "byte-buffer-pool" => { "description" => "A byte buffer pool used for IO operations, this provides the same capabilities as the buffer pool from the IO subsystem, so they can be used interchangeably and must have a unique name. This buffer pool allows for more precise configuration of the total amount of retained memory than the IO subsystem.", "model-description" => {"*" => { "description" => "A byte buffer pool used for IO operations, this provides the same capabilities as the buffer pool from the IO subsystem, so they can be used interchangeably and must have a unique name. This buffer pool allows for more precise configuration of the total amount of retained memory than the IO subsystem.", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.byte-buffer-pool", "dynamic" => true, "dynamic-elements" => ["byte-buffer-pool"], "stability" => "default" }], "attributes" => { "buffer-size" => { "type" => INT, "description" => "The size of the buffer", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "direct" => { "type" => BOOLEAN, "description" => "If this is true the buffer pool will use direct buffers, this is recommended for best performance", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "leak-detection-percent" => { "type" => INT, "description" => "The percentage of buffers that will be allocated with a leak detector. This should only be larger than zero if you are experiencing issues with buffers leaking.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-pool-size" => { "type" => INT, "description" => "The maximum amount of buffers to keep in the pool. If more buffers are required at runtime they will be allocated dynamically. Setting this to zero effectively disables pooling.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "thread-local-cache-size" => { "type" => INT, "description" => "The maximum number of buffers to cache on each thread. The actual number may be lower depending on the calculated usage pattern.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 12, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a new byte buffer pool", "request-properties" => { "buffer-size" => { "type" => INT, "description" => "The size of the buffer", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "direct" => { "type" => BOOLEAN, "description" => "If this is true the buffer pool will use direct buffers, this is recommended for best performance", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "leak-detection-percent" => { "type" => INT, "description" => "The percentage of buffers that will be allocated with a leak detector. This should only be larger than zero if you are experiencing issues with buffers leaking.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "max-pool-size" => { "type" => INT, "description" => "The maximum amount of buffers to keep in the pool. If more buffers are required at runtime they will be allocated dynamically. Setting this to zero effectively disables pooling.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "thread-local-cache-size" => { "type" => INT, "description" => "The maximum number of buffers to cache on each thread. The actual number may be lower depending on the calculated usage pattern.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 12, "min" => 0L, "max" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a byte buffer pool", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "servlet-container" => { "description" => "A servlet container", "model-description" => {"*" => { "description" => "A servlet container", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.servlet-container", "dynamic" => true, "dynamic-elements" => ["servlet-container"], "stability" => "default" }], "attributes" => { "allow-non-standard-wrappers" => { "type" => BOOLEAN, "description" => "If true then request and response wrappers that do not extend the standard wrapper classes can be used", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "allow-orphan-session" => { "type" => BOOLEAN, "description" => "Indicates whether session creation should be permitted after a response-closing operation, e.g. HttpServletResponse.sendRedirect(...). Enabling this behavior is generally discouraged, as the created session will be unreferenceable.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-buffer-cache" => { "type" => STRING, "description" => "The buffer cache to use for caching static resources", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-cookie-version" => { "type" => INT, "description" => "The default cookie version servlet applications will send", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 1L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-encoding" => { "type" => STRING, "description" => "Default encoding to use for all deployed applications", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-session-timeout" => { "type" => INT, "description" => "The default session timeout (in minutes) for all applications deployed in the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "unit" => "MINUTES", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "directory-listing" => { "type" => BOOLEAN, "description" => "If directory listing should be enabled for default servlets.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-caching-for-secured-pages" => { "type" => BOOLEAN, "description" => "If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-file-watch-service" => { "type" => BOOLEAN, "description" => "If this is true then the file watch service will not be used to monitor exploded deployments for changes", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-session-id-reuse" => { "type" => BOOLEAN, "description" => "If this is true then an unknown session ID will never be reused, and a new session id will be generated. If this is false then it will be re-used if and only if it is present in the session manager of another deployment, to allow the same session id to be shared between applications on the same server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "eager-filter-initialization" => { "type" => BOOLEAN, "description" => "If true undertow calls filter init() on deployment start rather than when first requested.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "file-cache-max-file-size" => { "type" => INT, "description" => "The maximum size of a file that will be cached in the file cache", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "file-cache-metadata-size" => { "type" => INT, "description" => "The maximum number of files that will have their metadata cached", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 100, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "file-cache-time-to-live" => { "type" => INT, "description" => "The length of time in ms an item will stay cached. By default this is 2000 for exploded deployments, and -1 (infinite) for archive deployments", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ignore-flush" => { "type" => BOOLEAN, "description" => "Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-sessions" => { "type" => INT, "description" => "The maximum number of sessions that can be active at one time", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "preserve-path-on-forward" => { "type" => BOOLEAN, "description" => "If this is true Undertow will reset request path, URL and URI information to original values after forward.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "proactive-authentication" => { "type" => BOOLEAN, "description" => "If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "session-id-length" => { "type" => INT, "description" => "The length of the generated session ID. Longer session ID's are more secure. This number refers to the number of bytes of randomness that are used to generate the session ID, the actual ID that is sent to the client will be base64 encoded so will be approximately 33% larger (e.g. a session id length of 30 will result in a cookie value of length 40).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "min" => 16L, "max" => 200L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "stack-trace-on-error" => { "type" => STRING, "description" => "If an error page with the stack trace should be generated on error. Values are all, none and local-only", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "local-only", "allowed" => [ "none", "local-only", "all" ], "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-listener-encoding" => { "type" => BOOLEAN, "description" => "Use encoding defined on listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a servlet container", "request-properties" => { "allow-non-standard-wrappers" => { "type" => BOOLEAN, "description" => "If true then request and response wrappers that do not extend the standard wrapper classes can be used", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-orphan-session" => { "type" => BOOLEAN, "description" => "Indicates whether session creation should be permitted after a response-closing operation, e.g. HttpServletResponse.sendRedirect(...). Enabling this behavior is generally discouraged, as the created session will be unreferenceable.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "default-buffer-cache" => { "type" => STRING, "description" => "The buffer cache to use for caching static resources", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "default-cookie-version" => { "type" => INT, "description" => "The default cookie version servlet applications will send", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 1L, "stability" => "default" }, "default-encoding" => { "type" => STRING, "description" => "Default encoding to use for all deployed applications", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "default-session-timeout" => { "type" => INT, "description" => "The default session timeout (in minutes) for all applications deployed in the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "unit" => "MINUTES", "stability" => "default" }, "directory-listing" => { "type" => BOOLEAN, "description" => "If directory listing should be enabled for default servlets.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "disable-caching-for-secured-pages" => { "type" => BOOLEAN, "description" => "If Undertow should set headers to disable caching for secured paged. Disabling this can cause security problems, as sensitive pages may be cached by an intermediary.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "disable-file-watch-service" => { "type" => BOOLEAN, "description" => "If this is true then the file watch service will not be used to monitor exploded deployments for changes", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "disable-session-id-reuse" => { "type" => BOOLEAN, "description" => "If this is true then an unknown session ID will never be reused, and a new session id will be generated. If this is false then it will be re-used if and only if it is present in the session manager of another deployment, to allow the same session id to be shared between applications on the same server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "eager-filter-initialization" => { "type" => BOOLEAN, "description" => "If true undertow calls filter init() on deployment start rather than when first requested.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "file-cache-max-file-size" => { "type" => INT, "description" => "The maximum size of a file that will be cached in the file cache", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760, "stability" => "default" }, "file-cache-metadata-size" => { "type" => INT, "description" => "The maximum number of files that will have their metadata cached", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 100, "stability" => "default" }, "file-cache-time-to-live" => { "type" => INT, "description" => "The length of time in ms an item will stay cached. By default this is 2000 for exploded deployments, and -1 (infinite) for archive deployments", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "ignore-flush" => { "type" => BOOLEAN, "description" => "Ignore flushes on the servlet output stream. In most cases these just hurt performance for no good reason.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "max-sessions" => { "type" => INT, "description" => "The maximum number of sessions that can be active at one time", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "preserve-path-on-forward" => { "type" => BOOLEAN, "description" => "If this is true Undertow will reset request path, URL and URI information to original values after forward.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "proactive-authentication" => { "type" => BOOLEAN, "description" => "If proactive authentication should be used. If this is true a user will always be authenticated if credentials are present.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "session-id-length" => { "type" => INT, "description" => "The length of the generated session ID. Longer session ID's are more secure. This number refers to the number of bytes of randomness that are used to generate the session ID, the actual ID that is sent to the client will be base64 encoded so will be approximately 33% larger (e.g. a session id length of 30 will result in a cookie value of length 40).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "min" => 16L, "max" => 200L, "stability" => "default" }, "stack-trace-on-error" => { "type" => STRING, "description" => "If an error page with the stack trace should be generated on error. Values are all, none and local-only", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "local-only", "allowed" => [ "none", "local-only", "all" ], "stability" => "default" }, "use-listener-encoding" => { "type" => BOOLEAN, "description" => "Use encoding defined on listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a servlet container", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "welcome-file" => { "description" => "A welcome file", "model-description" => {"*" => { "description" => "The welcome file", "stability" => "default", "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a welcome file", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a welcome file", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "setting" => { "description" => "The servlet container settings", "model-description" => { "crawler-session-management" => { "description" => "Configures special session handling for crawler bots", "stability" => "default", "attributes" => { "session-timeout" => { "type" => INT, "description" => "The session timeout for sessions that are owned by crawlers", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "SECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "user-agents" => { "type" => STRING, "description" => "Regular expression that is used to match the user agent of a crawler", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds special session handling for crawler bots", "request-properties" => { "session-timeout" => { "type" => INT, "description" => "The session timeout for sessions that are owned by crawlers", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "SECONDS", "stability" => "default" }, "user-agents" => { "type" => STRING, "description" => "Regular expression that is used to match the user agent of a crawler", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes special session handling for crawler bots", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "affinity-cookie" => { "description" => "Affinity cookie configuration", "stability" => "default", "attributes" => { "domain" => { "type" => STRING, "description" => "Affinity cookie domain", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-only" => { "type" => BOOLEAN, "description" => "Is affinity cookie http-only", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-age" => { "type" => INT, "description" => "Max age of affinity cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "name" => { "type" => STRING, "description" => "Name of the affinity cookie", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "Is affinity cookie secure?", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add affinity cookie configuration", "request-properties" => { "domain" => { "type" => STRING, "description" => "Affinity cookie domain", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "http-only" => { "type" => BOOLEAN, "description" => "Is affinity cookie http-only", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "max-age" => { "type" => INT, "description" => "Max age of affinity cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "name" => { "type" => STRING, "description" => "Name of the affinity cookie", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "Is affinity cookie secure?", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove affinity cookie configuration", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "jsp" => { "description" => "Jakarta Server Pages container configuration.", "stability" => "default", "attributes" => { "check-interval" => { "type" => INT, "description" => "Check interval for Jakarta Server Pages updates using a background thread. This has no effect for most deployments where Jakarta Server Pages change notifications are handled using the File System notification API. This only takes effect if the file watch service is disabled.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "development" => { "type" => BOOLEAN, "description" => "Enable Development mode which enables reloading Jakarta Server Pages on-the-fly", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disabled" => { "type" => BOOLEAN, "description" => "Disable the Jakarta Server Pages container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "display-source-fragment" => { "type" => BOOLEAN, "description" => "When a runtime error occurs, attempts to display corresponding Jakarta Server Pages source fragment", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dump-smap" => { "type" => BOOLEAN, "description" => "Write SMAP data to a file.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-on-use-bean-invalid-class-attribute" => { "type" => BOOLEAN, "description" => "Enable errors when using a bad class in useBean.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "generate-strings-as-char-arrays" => { "type" => BOOLEAN, "description" => "Generate String constants as char arrays.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "java-encoding" => { "type" => STRING, "description" => "Specify the encoding used for Java sources.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "keep-generated" => { "type" => BOOLEAN, "description" => "Keep the generated Servlets.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "mapped-file" => { "type" => BOOLEAN, "description" => "Map to the Jakarta Server Pages source.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "modification-test-interval" => { "type" => INT, "description" => "Minimum amount of time between two tests for updates, in seconds.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "optimize-scriptlets" => { "type" => BOOLEAN, "description" => "If Jakarta Server Pages scriptlets should be optimised to remove string concatenation", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "recompile-on-fail" => { "type" => BOOLEAN, "description" => "Retry failed Jakarta Server Pages compilations on each request.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scratch-dir" => { "type" => STRING, "description" => "Specify a different work directory.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "smap" => { "type" => BOOLEAN, "description" => "Enable SMAP.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "source-vm" => { "type" => STRING, "description" => "Source VM level for compilation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tag-pooling" => { "type" => BOOLEAN, "description" => "Enable tag pooling.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "target-vm" => { "type" => STRING, "description" => "Target VM level for compilation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "trim-spaces" => { "type" => BOOLEAN, "description" => "Trim some spaces from the generated Servlet.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "x-powered-by" => { "type" => BOOLEAN, "description" => "Enable advertising the Jakarta Server Pages engine in x-powered-by.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds Jakarta Server Pages container configuration.", "request-properties" => { "check-interval" => { "type" => INT, "description" => "Check interval for Jakarta Server Pages updates using a background thread. This has no effect for most deployments where Jakarta Server Pages change notifications are handled using the File System notification API. This only takes effect if the file watch service is disabled.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "stability" => "default" }, "development" => { "type" => BOOLEAN, "description" => "Enable Development mode which enables reloading Jakarta Server Pages on-the-fly", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "disabled" => { "type" => BOOLEAN, "description" => "Disable the Jakarta Server Pages container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "display-source-fragment" => { "type" => BOOLEAN, "description" => "When a runtime error occurs, attempts to display corresponding Jakarta Server Pages source fragment", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "dump-smap" => { "type" => BOOLEAN, "description" => "Write SMAP data to a file.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "error-on-use-bean-invalid-class-attribute" => { "type" => BOOLEAN, "description" => "Enable errors when using a bad class in useBean.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "generate-strings-as-char-arrays" => { "type" => BOOLEAN, "description" => "Generate String constants as char arrays.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "java-encoding" => { "type" => STRING, "description" => "Specify the encoding used for Java sources.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "keep-generated" => { "type" => BOOLEAN, "description" => "Keep the generated Servlets.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "mapped-file" => { "type" => BOOLEAN, "description" => "Map to the Jakarta Server Pages source.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "modification-test-interval" => { "type" => INT, "description" => "Minimum amount of time between two tests for updates, in seconds.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4, "stability" => "default" }, "optimize-scriptlets" => { "type" => BOOLEAN, "description" => "If Jakarta Server Pages scriptlets should be optimised to remove string concatenation", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recompile-on-fail" => { "type" => BOOLEAN, "description" => "Retry failed Jakarta Server Pages compilations on each request.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "scratch-dir" => { "type" => STRING, "description" => "Specify a different work directory.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "smap" => { "type" => BOOLEAN, "description" => "Enable SMAP.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "source-vm" => { "type" => STRING, "description" => "Source VM level for compilation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "tag-pooling" => { "type" => BOOLEAN, "description" => "Enable tag pooling.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "target-vm" => { "type" => STRING, "description" => "Target VM level for compilation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "1.8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "trim-spaces" => { "type" => BOOLEAN, "description" => "Trim some spaces from the generated Servlet.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "x-powered-by" => { "type" => BOOLEAN, "description" => "Enable advertising the Jakarta Server Pages engine in x-powered-by.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes Jakarta Server Pages container configuration.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "persistent-sessions" => { "description" => "Session persistence sessions", "stability" => "default", "attributes" => { "path" => { "type" => STRING, "description" => "The path to the persistent session data directory. If this is null sessions will be stored in memory", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds the persistent sessions resource", "request-properties" => { "path" => { "type" => STRING, "description" => "The path to the persistent session data directory. If this is null sessions will be stored in memory", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the persistent sessions resource", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "session-cookie" => { "description" => "Session cookie configuration", "stability" => "default", "attributes" => { "comment" => { "type" => STRING, "description" => "Cookie comment", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "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" }, "domain" => { "type" => STRING, "description" => "Cookie domain", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-only" => { "type" => 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" }, "max-age" => { "type" => 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" }, "name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "Is cookie secure?", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add session cookie configuration", "request-properties" => { "comment" => { "type" => STRING, "description" => "Cookie comment", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "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" => STRING, "description" => "Cookie domain", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "http-only" => { "type" => BOOLEAN, "description" => "Is cookie http-only", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "max-age" => { "type" => INT, "description" => "Max age of cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "Is cookie secure?", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove session cookie configuration", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "websockets" => { "description" => "If websockets are enabled for this container", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.servlet-container.websocket", "dynamic" => true, "dynamic-elements" => ["servlet-container"], "stability" => "default" }], "attributes" => { "buffer-pool" => { "type" => STRING, "description" => "The buffer pool to use for websocket deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "deflater-level" => { "type" => INT, "description" => "Configures the level of compression of the DEFLATE algorithm", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 9L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "dispatch-to-worker" => { "type" => BOOLEAN, "description" => "If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "per-message-deflate" => { "type" => BOOLEAN, "description" => "Enables websocket's per-message compression extension, RFC-7692", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The worker to use for websocket deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds websockets support", "request-properties" => { "buffer-pool" => { "type" => STRING, "description" => "The buffer pool to use for websocket deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "deflater-level" => { "type" => INT, "description" => "Configures the level of compression of the DEFLATE algorithm", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 9L, "stability" => "default" }, "dispatch-to-worker" => { "type" => BOOLEAN, "description" => "If callbacks should be dispatched to a worker thread. If this is false then they will be run in the IO thread, which is faster however care must be taken not to perform blocking operations.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "per-message-deflate" => { "type" => BOOLEAN, "description" => "Enables websocket's per-message compression extension, RFC-7692", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "The worker to use for websocket deployments", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes websockets support", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} } } }, "mime-mapping" => { "description" => "Servlet mime mapping config", "model-description" => {"*" => { "description" => "The servlet container mime mapping config", "stability" => "default", "attributes" => {"value" => { "type" => STRING, "description" => "The mime type for this mapping", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a mime mapping", "request-properties" => {"value" => { "type" => STRING, "description" => "The mime type for this mapping", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a mime mapping", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } }} }, "configuration" => { "description" => "null", "model-description" => { "filter" => { "description" => "Undertow filters", "stability" => "default", "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds the filter element", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the filter element", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "error-page" => { "description" => "The error pages", "model-description" => {"*" => { "description" => "The error pages", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "code" => { "type" => INT, "description" => "Error page code", "expressions-allowed" => true, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "Error page path", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds an error page", "request-properties" => { "code" => { "type" => INT, "description" => "Error page code", "expressions-allowed" => true, "required" => true, "nillable" => false, "stability" => "default" }, "path" => { "type" => STRING, "description" => "Error page path", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes an error page", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "expression-filter" => { "description" => "A filter parsed from the undertow expression language", "model-description" => {"*" => { "description" => "A filter parsed from the undertow expression language", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "expression" => { "type" => STRING, "description" => "The expression that defines the filter", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "module" => { "type" => STRING, "description" => "Module to use to load the filter definitions", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add a filter parsed from the undertow expression language", "request-properties" => { "expression" => { "type" => STRING, "description" => "The expression that defines the filter", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "module" => { "type" => STRING, "description" => "Module to use to load the filter definitions", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove expression filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "gzip" => { "description" => "Defines gzip filter", "model-description" => {"*" => { "description" => "Defines gzip filter", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "mod-cluster" => { "description" => "A mod-cluster front end load balancer", "model-description" => {"*" => { "description" => "A mod-cluster front end load balancer", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.mod_cluster-filter", "dynamic" => true, "dynamic-elements" => ["mod-cluster"], "stability" => "default" }], "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "advertise-frequency" => { "type" => INT, "description" => "The frequency (in milliseconds) that mod-cluster advertises itself on the network", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "advertise-path" => { "type" => STRING, "description" => "The path that mod-cluster is registered under.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "advertise-protocol" => { "type" => STRING, "description" => "The protocol that is in use.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "advertise-socket-binding" => { "type" => STRING, "description" => "The multicast group and port that is used to advertise.", "expressions-allowed" => true, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "broken-node-timeout" => { "type" => INT, "description" => "The amount of time that must elapse before a broken node is removed from the table", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60, "unit" => "SECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "failover-strategy" => { "type" => STRING, "description" => "Determines how a failover node is chosen, in the event that the node to which a session has affinity is not available.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "LOAD_BALANCED", "allowed" => [ "LOAD_BALANCED", "DETERMINISTIC" ], "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "health-check-interval" => { "type" => INT, "description" => "The frequency of health check pings to backend nodes", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If push should be enabled for HTTP/2 connections", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "management-access-predicate" => { "type" => STRING, "description" => "A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "management-socket-binding" => { "type" => STRING, "description" => "The socket binding of the mod_cluster management address and port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible.", "expressions-allowed" => true, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 8192, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-request-time" => { "type" => INT, "description" => "The max amount of time that a request to a backend node can take before it is killed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => -1, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retries" => { "type" => INT, "description" => "The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-key" => { "type" => STRING, "description" => "The security key that is used for the mod-cluster group. All members must use the same security key.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this filter.", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-alias" => { "type" => BOOLEAN, "description" => "If an alias check is performed", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The XNIO worker that is used to send the advertise notifications", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a front end mod-proxy load balancer", "request-properties" => { "advertise-frequency" => { "type" => INT, "description" => "The frequency (in milliseconds) that mod-cluster advertises itself on the network", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "stability" => "default" }, "advertise-path" => { "type" => STRING, "description" => "The path that mod-cluster is registered under.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "advertise-protocol" => { "type" => STRING, "description" => "The protocol that is in use.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "advertise-socket-binding" => { "type" => STRING, "description" => "The multicast group and port that is used to advertise.", "expressions-allowed" => true, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "broken-node-timeout" => { "type" => INT, "description" => "The amount of time that must elapse before a broken node is removed from the table", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default" }, "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60, "unit" => "SECONDS", "stability" => "default" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default" }, "enable-http2" => { "type" => BOOLEAN, "description" => "If the load balancer should attempt to upgrade back end connections to HTTP2. If HTTP2 is not supported HTTP or HTTPS will be used as normal", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "failover-strategy" => { "type" => STRING, "description" => "Determines how a failover node is chosen, in the event that the node to which a session has affinity is not available.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "LOAD_BALANCED", "allowed" => [ "LOAD_BALANCED", "DETERMINISTIC" ], "stability" => "default" }, "health-check-interval" => { "type" => INT, "description" => "The frequency of health check pings to backend nodes", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "unit" => "MILLISECONDS", "stability" => "default" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If push should be enabled for HTTP/2 connections", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "management-access-predicate" => { "type" => STRING, "description" => "A predicate that is applied to incoming requests to determine if they can perform mod cluster management commands. Provides additional security on top of what is provided by limiting management to requests that originate from the management-socket-binding", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "management-socket-binding" => { "type" => STRING, "description" => "The socket binding of the mod_cluster management address and port. When using mod_cluster two HTTP listeners should be defined, a public one to handle requests, and one bound to the internal network to handle mod cluster commands. This socket binding should correspond to the internal listener, and should not be publicly accessible.", "expressions-allowed" => true, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum size for AJP packets. Increasing this will allow AJP to work for requests/responses that have a large amount of headers. This is an advanced option, and must be the same between load balancers and backend servers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 8192, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-request-time" => { "type" => INT, "description" => "The max amount of time that a request to a backend node can take before it is killed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => -1, "unit" => "MILLISECONDS", "stability" => "default" }, "max-retries" => { "type" => INT, "description" => "The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1L, "stability" => "default" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "stability" => "default" }, "security-key" => { "type" => STRING, "description" => "The security key that is used for the mod-cluster group. All members must use the same security key.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." } }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this filter.", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "use-alias" => { "type" => BOOLEAN, "description" => "If an alias check is performed", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "The XNIO worker that is used to send the advertise notifications", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a mod cluster proxy handler", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "affinity" => { "description" => "Determines how session affinity is handled. Typically used to enable ranked routing support or to disable routing completely.", "model-description" => { "single" => { "description" => "Web requests have an affinity for the member that last handled a given session. This option corresponds to traditional sticky session behavior.", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds single routing explicitly.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes single routing resource, however, retaining this as implicit default behavior.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "ranked" => { "description" => "Web requests will have an affinity for the first available node in a list typically comprised of: primary owner, backup nodes, local node (if not a primary nor backup owner).", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {"delimiter" => { "type" => STRING, "description" => "The delimiter used to separate ranked routes within the session ID.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ".", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => { "add" => { "operation-name" => "add", "description" => "Add ranked routing support.", "request-properties" => {"delimiter" => { "type" => STRING, "description" => "The delimiter used to separate ranked routes within the session ID.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ".", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove ranked routing support, defaulting to single routing.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "none" => { "description" => "Web requests will not have an affinity for any particular server, routing information will be ignored. Intended for use cases where web session state is not maintained within the application server.", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Disable routing parsing completely.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove no routing configuration.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} } } }, "balancer" => { "description" => "Runtime representation of a mod_cluster balancer", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster balancer", "stability" => "default", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "max-attempts" => { "type" => INT, "description" => "Maximum number of failover attempts by reverse proxy when sending the request to the backend server.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "sticky-session" => { "type" => BOOLEAN, "description" => "If sticky sessions are enabled", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-cookie" => { "type" => STRING, "description" => "The session cookie name", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-force" => { "type" => BOOLEAN, "description" => "If this is true then an error will be returned if the request cannot be routed to the sticky node, otherwise it will be routed to another node", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-path" => { "type" => STRING, "description" => "The path of the sticky session cookie", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "sticky-session-remove" => { "type" => BOOLEAN, "description" => "Remove the session cookie if the request cannot be routed to the correct host", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "wait-worker" => { "type" => INT, "description" => "The number of seconds to wait for an available worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "node" => { "description" => "Runtime representation of a mod_cluster node", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster node", "stability" => "default", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "aliases" => { "type" => LIST, "description" => "The nodes aliases", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "cache-connections" => { "type" => INT, "description" => "The number of connections to keep alive indefinitely", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "elected" => { "type" => INT, "description" => "The elected count", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "flush-packets" => { "type" => BOOLEAN, "description" => "If received data should be immediately flushed", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "load" => { "type" => INT, "description" => "The current load of this node", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "load-balancing-group" => { "type" => STRING, "description" => "The load balancing group this node belongs to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "max-connections" => { "type" => INT, "description" => "The maximum number of connections per IO thread", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "open-connections" => { "type" => INT, "description" => "The current number of open connections", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "ping" => { "type" => INT, "description" => "The nodes ping", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "queue-new-requests" => { "type" => BOOLEAN, "description" => "If a request is received and there is no worker immediately available should it be queued", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "read" => { "type" => LONG, "description" => "The number of bytes read from the node", "expressions-allowed" => false, "required" => false, "nillable" => true, "unit" => "BYTES", "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "request-queue-size" => { "type" => INT, "description" => "The size of the request queue", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "status" => { "type" => STRING, "description" => "The current status of this node", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "timeout" => { "type" => INT, "description" => "The request timeout", "expressions-allowed" => false, "required" => false, "nillable" => true, "unit" => "SECONDS", "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "ttl" => { "type" => LONG, "description" => "The time connections will stay alive with no requests before being closed, if the number of connections is larger than cache-connections", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "uri" => { "type" => STRING, "description" => "The URI that the load balancer uses to connect to the node", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "written" => { "type" => LONG, "description" => "The number of bytes transferred to the node", "expressions-allowed" => false, "required" => false, "nillable" => true, "unit" => "BYTES", "stability" => "default", "access-type" => "read-only", "storage" => "runtime" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "enable" => { "operation-name" => "enable", "description" => "Enables all contexts on this node", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "stop" => { "operation-name" => "stop", "description" => "Stops all contests on this node", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "disable" => { "operation-name" => "disable", "description" => "Disables all contexts on this node", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {"context" => { "description" => "Runtime representation of a mod_cluster context", "model-description" => {"*" => { "description" => "Runtime representation of a mod_cluster context", "stability" => "default", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "requests" => { "type" => INT, "description" => "The number of requests against this context", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" }, "status" => { "type" => STRING, "description" => "The status of this context", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-only", "storage" => "runtime" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "enable" => { "operation-name" => "enable", "description" => "Enables this context", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "stop" => { "operation-name" => "stop", "description" => "Stops this context", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "disable" => { "operation-name" => "disable", "description" => "Disables this context", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }} }} }, "load-balancing-group" => { "description" => "A load balancing group", "model-description" => {"*" => { "description" => "A load balancing group", "stability" => "default", "storage" => "runtime-only", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => {}, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "stop-nodes" => { "operation-name" => "stop-nodes", "description" => "Stops all nodes in the load balancing group", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "disable-nodes" => { "operation-name" => "disable-nodes", "description" => "Disables all nodes in the load balancing group", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "enable-nodes" => { "operation-name" => "enable-nodes", "description" => "Enables all nodes in the load balancing group", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } }} } } }} }, "rewrite" => { "description" => "A rewrite (or redirect) filter", "model-description" => {"*" => { "description" => "A rewrite (or redirect) filter", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "redirect" => { "type" => BOOLEAN, "description" => "If this is true then a redirect will be done instead of a rewrite", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "target" => { "type" => STRING, "description" => "The expression that defines the target. If you are redirecting to a constant target put single quotes around the value", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add a rewrite filter", "request-properties" => { "redirect" => { "type" => BOOLEAN, "description" => "If this is true then a redirect will be done instead of a rewrite", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "target" => { "type" => STRING, "description" => "The expression that defines the target. If you are redirecting to a constant target put single quotes around the value", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove rewrite filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "response-header" => { "description" => "Response header filter allows you to add custom headers.", "model-description" => {"*" => { "description" => "Response header filter allows you to add custom headers.", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "header-name" => { "type" => STRING, "description" => "Header name", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "header-value" => { "type" => STRING, "description" => "Value for header", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds filter", "request-properties" => { "header-name" => { "type" => STRING, "description" => "Header name", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "header-value" => { "type" => STRING, "description" => "Value for header", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "request-limit" => { "description" => "Concurrent request limiter handler", "model-description" => {"*" => { "description" => "Concurrent request limiter handler", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "max-concurrent-requests" => { "type" => INT, "description" => "Maximum number of concurrent requests", "expressions-allowed" => true, "required" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-size" => { "type" => INT, "description" => "Number of requests to queue before they start being rejected", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add request limiter", "request-properties" => { "max-concurrent-requests" => { "type" => INT, "description" => "Maximum number of concurrent requests", "expressions-allowed" => true, "required" => true, "nillable" => false, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "queue-size" => { "type" => INT, "description" => "Number of requests to queue before they start being rejected", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 0, "min" => 0L, "max" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "removes limiter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "custom-filter" => { "description" => "Custom filter", "model-description" => {"*" => { "description" => "Custom filter", "stability" => "default", "access-constraints" => {"sensitive" => {"undertow-filter" => {"type" => "undertow"}}}, "attributes" => { "class-name" => { "type" => STRING, "description" => "Class name of HttpHandler", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "module" => { "type" => STRING, "description" => "Module name where class can be loaded from", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "parameters" => { "type" => OBJECT, "description" => "Filter parameters", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add custom filter", "request-properties" => { "class-name" => { "type" => STRING, "description" => "Class name of HttpHandler", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "module" => { "type" => STRING, "description" => "Module name where class can be loaded from", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "parameters" => { "type" => OBJECT, "description" => "Filter parameters", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove custom filter", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } }, "handler" => { "description" => "Undertow handlers", "stability" => "default", "attributes" => {}, "operations" => { "add" => { "operation-name" => "add", "description" => "Add the handler element", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the handler element", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "file" => { "description" => "File handler", "model-description" => {"*" => { "description" => "File handler", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.extension.undertow.handler", "dynamic" => true, "dynamic-elements" => ["file"], "stability" => "default" }], "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "cache-buffer-size" => { "type" => LONG, "description" => "Size of the buffers, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "cache-buffers" => { "type" => LONG, "description" => "Number of buffers", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "case-sensitive" => { "type" => BOOLEAN, "description" => "Use case sensitive file handling", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "directory-listing" => { "type" => BOOLEAN, "description" => "Enable directory listing?", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "follow-symlink" => { "type" => BOOLEAN, "description" => "Enable following symbolic links", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "Path on filesystem from where file handler will serve resources", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "safe-symlink-paths" => { "type" => LIST, "description" => "Paths that are safe to be targets of symbolic links", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add file handler", "request-properties" => { "cache-buffer-size" => { "type" => LONG, "description" => "Size of the buffers, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "stability" => "default" }, "cache-buffers" => { "type" => LONG, "description" => "Number of buffers", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "stability" => "default" }, "case-sensitive" => { "type" => BOOLEAN, "description" => "Use case sensitive file handling", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "directory-listing" => { "type" => BOOLEAN, "description" => "Enable directory listing?", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "follow-symlink" => { "type" => BOOLEAN, "description" => "Enable following symbolic links", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "path" => { "type" => STRING, "description" => "Path on filesystem from where file handler will serve resources", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "safe-symlink-paths" => { "type" => LIST, "description" => "Paths that are safe to be targets of symbolic links", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove file handler", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "reverse-proxy" => { "description" => "A reverse proxy handler", "model-description" => {"*" => { "description" => "A reverse proxy handler", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.extension.undertow.handler", "dynamic" => true, "dynamic-elements" => ["reverse-proxy"], "stability" => "default" }], "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 5, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-request-time" => { "type" => INT, "description" => "The maximum time that a proxy request can be active for, before being killed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => -1, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-retries" => { "type" => INT, "description" => "The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "problem-server-retry" => { "type" => INT, "description" => "Time in seconds to wait before attempting to reconnect to a server that is down", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "unit" => "SECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "session-cookie-names" => { "type" => STRING, "description" => "Comma separated list of session cookie names. Generally this will just be JSESSIONID.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONID", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a reverse proxy handler", "request-properties" => { "cached-connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be kept alive indefinitely", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 5, "stability" => "default" }, "connection-idle-timeout" => { "type" => INT, "description" => "The amount of time a connection can be idle before it will be closed. Connections will not time out once the pool size is down to the configured minimum (as configured by cached-connections-per-thread)", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default" }, "connections-per-thread" => { "type" => INT, "description" => "The number of connections that will be maintained to backend servers, per IO thread.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 40, "stability" => "default" }, "max-request-time" => { "type" => INT, "description" => "The maximum time that a proxy request can be active for, before being killed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => -1, "unit" => "MILLISECONDS", "stability" => "default" }, "max-retries" => { "type" => INT, "description" => "The number of times to attempt to retry a request if it fails. Note that if a request is not considered idempotent then it will only be retried if the proxy can be sure it was not sent to the backend server).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1L, "stability" => "default" }, "problem-server-retry" => { "type" => INT, "description" => "Time in seconds to wait before attempting to reconnect to a server that is down", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 30, "unit" => "SECONDS", "stability" => "default" }, "request-queue-size" => { "type" => INT, "description" => "The number of requests that can be queued if the connection pool is full before requests are rejected with a 503", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10, "stability" => "default" }, "session-cookie-names" => { "type" => STRING, "description" => "Comma separated list of session cookie names. Generally this will just be JSESSIONID.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONID", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a reverse proxy handler", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {"host" => { "description" => "A host that the reverse proxy will forward requests to", "model-description" => {"*" => { "description" => "A host that the reverse proxy will forward requests to", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.reverse-proxy.host", "dynamic" => true, "dynamic-elements" => [ "reverse-proxy", "host" ], "stability" => "default" }], "access-constraints" => {"sensitive" => {"undertow-handler" => {"type" => "undertow"}}}, "attributes" => { "enable-http2" => { "type" => BOOLEAN, "description" => "If this is true then the proxy will attempt to use HTTP/2 to connect to the backend. If it is not supported it will fall back to HTTP/1.1.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "instance-id" => { "type" => STRING, "description" => "The instance id (aka JVM route) that will be used to enable sticky sessions", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "outbound-socket-binding" => { "type" => STRING, "description" => "Outbound socket binding for this host", "expressions-allowed" => true, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "Optional path if host is using non root resource", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "scheme" => { "type" => STRING, "description" => "What kind of scheme is used", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration for the connection to the host", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "12.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this handler.", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a reverse proxy handler host", "request-properties" => { "enable-http2" => { "type" => BOOLEAN, "description" => "If this is true then the proxy will attempt to use HTTP/2 to connect to the backend. If it is not supported it will fall back to HTTP/1.1.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "instance-id" => { "type" => STRING, "description" => "The instance id (aka JVM route) that will be used to enable sticky sessions", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "outbound-socket-binding" => { "type" => STRING, "description" => "Outbound socket binding for this host", "expressions-allowed" => true, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.outbound-socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "path" => { "type" => STRING, "description" => "Optional path if host is using non root resource", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "scheme" => { "type" => STRING, "description" => "What kind of scheme is used", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "http", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "security-realm" => { "type" => STRING, "description" => "The security realm that provides the SSL configuration for the connection to the host", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "12.0.0", "reason" => "Use the ssl-context attribute to reference a configured SSLContext directly." } }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this handler.", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a reverse proxy handler host", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }} }} } } } } }, "application-security-domain" => { "description" => "A Mapping from a security domain references in a deployed application.", "model-description" => {"*" => { "description" => "A Mapping from a security domain references in a deployed application.", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.application-security-domain", "dynamic" => true, "dynamic-elements" => ["application-security-domain"], "stability" => "default" }], "access-constraints" => { "sensitive" => {"application-security-domain" => {"type" => "undertow"}}, "application" => {"application-security-domain" => {"type" => "undertow"}} }, "attributes" => { "enable-jacc" => { "type" => BOOLEAN, "description" => "Enable authorization using Jakarta Authorization", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enable-jaspi" => { "type" => BOOLEAN, "description" => "Enable JASPI authentication for the associated deployments.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-authentication-factory" => { "type" => STRING, "description" => "The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["security-domain"], "capability-reference" => "org.wildfly.security.http-authentication-factory", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"authentication-factory-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "integrated-jaspi" => { "type" => BOOLEAN, "description" => "Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "override-deployment-config" => { "type" => BOOLEAN, "description" => "Should the authentication configuration in the deployment be overridden by the factory.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "requires" => ["http-authentication-factory"], "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "referencing-deployments" => { "type" => LIST, "description" => "The deployments currently referencing this mapping.", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-only", "storage" => "runtime" }, "security-domain" => { "type" => STRING, "description" => "The SecurityDomain to be used by deployments that reference the mapped security domain.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["http-authentication-factory"], "capability-reference" => "org.wildfly.security.security-domain", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"elytron-security-domain-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add a new application referenced security domain mapping.", "request-properties" => { "enable-jacc" => { "type" => BOOLEAN, "description" => "Enable authorization using Jakarta Authorization", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "enable-jaspi" => { "type" => BOOLEAN, "description" => "Enable JASPI authentication for the associated deployments.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "http-authentication-factory" => { "type" => STRING, "description" => "The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["security-domain"], "capability-reference" => "org.wildfly.security.http-authentication-factory", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "integrated-jaspi" => { "type" => BOOLEAN, "description" => "Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "override-deployment-config" => { "type" => BOOLEAN, "description" => "Should the authentication configuration in the deployment be overridden by the factory.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "requires" => ["http-authentication-factory"], "stability" => "default" }, "security-domain" => { "type" => STRING, "description" => "The SecurityDomain to be used by deployments that reference the mapped security domain.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["http-authentication-factory"], "capability-reference" => "org.wildfly.security.security-domain", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove the application referenced security domain mapping.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {"setting" => { "description" => "Settings", "model-description" => {"single-sign-on" => { "description" => "An SSO authentication mechanism configuration.", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.extension.undertow.application-security-domain.single-sign-on.credential-store", "dynamic" => true, "dynamic-elements" => ["application-security-domain"], "stability" => "default" }, { "name" => "org.wildfly.extension.undertow.application-security-domain.single-sign-on.client-ssl-context", "dynamic" => true, "dynamic-elements" => ["application-security-domain"], "stability" => "default" }, { "name" => "org.wildfly.extension.undertow.application-security-domain.single-sign-on.key-store", "dynamic" => true, "dynamic-elements" => ["application-security-domain"], "stability" => "default" } ], "access-constraints" => { "sensitive" => {"application-security-domain" => {"type" => "undertow"}}, "application" => {"application-security-domain" => {"type" => "undertow"}} }, "attributes" => { "client-ssl-context" => { "type" => STRING, "description" => "Reference to the SSL context used to secure back-channel logout connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "cookie-name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONIDSSO", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "credential-reference" => { "type" => OBJECT, "description" => "The credential reference to decrypt the private key entry.", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-constraints" => {"sensitive" => {"credential" => {"type" => "core"}}}, "value-type" => { "store" => { "type" => STRING, "description" => "The name of the credential store holding the alias to credential.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.security.credential-store", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "alias" => { "type" => STRING, "description" => "The alias which denotes stored secret or credential in the store.", "expressions-allowed" => true, "required" => false, "nillable" => true, "requires" => ["store"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "type" => { "type" => STRING, "description" => "The type of credential this reference is denoting.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "clear-text" => { "type" => STRING, "description" => "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "domain" => { "type" => STRING, "description" => "The cookie domain that will be used.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-only" => { "type" => BOOLEAN, "description" => "Set Cookie httpOnly attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "key-alias" => { "type" => STRING, "description" => "Alias of the private key entry used for signing and verifying back-channel logout connection.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "key-store" => { "type" => STRING, "description" => "Reference to key store containing a private key entry.", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.security.key-store", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "path" => { "type" => STRING, "description" => "Cookie path.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "Set Cookie secure attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds an SSO authentication mechanism.", "request-properties" => { "client-ssl-context" => { "type" => STRING, "description" => "Reference to the SSL context used to secure back-channel logout connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "cookie-name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONIDSSO", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "credential-reference" => { "type" => OBJECT, "description" => "The credential reference to decrypt the private key entry.", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "value-type" => { "store" => { "type" => STRING, "description" => "The name of the credential store holding the alias to credential.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.security.credential-store", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "alias" => { "type" => STRING, "description" => "The alias which denotes stored secret or credential in the store.", "expressions-allowed" => true, "required" => false, "nillable" => true, "requires" => ["store"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "type" => { "type" => STRING, "description" => "The type of credential this reference is denoting.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "clear-text" => { "type" => STRING, "description" => "The secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } } }, "domain" => { "type" => STRING, "description" => "The cookie domain that will be used.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "http-only" => { "type" => BOOLEAN, "description" => "Set Cookie httpOnly attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "key-alias" => { "type" => STRING, "description" => "Alias of the private key entry used for signing and verifying back-channel logout connection.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key-store" => { "type" => STRING, "description" => "Reference to key store containing a private key entry.", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.security.key-store", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "path" => { "type" => STRING, "description" => "Cookie path.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "Set Cookie secure attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the SSO authentication mechanism.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }} }} }, "server" => { "description" => "A server", "model-description" => {"*" => { "description" => "A server", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.web.common.server", "dynamic" => false, "stability" => "default" }, { "name" => "org.wildfly.undertow.server", "dynamic" => true, "dynamic-elements" => ["server"], "stability" => "default" } ], "attributes" => { "default-host" => { "type" => STRING, "description" => "The servers default virtual host", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default-host", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "servlet-container" => { "type" => STRING, "description" => "The servers default servlet container", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a server", "request-properties" => { "default-host" => { "type" => STRING, "description" => "The servers default virtual host", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "default-host", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "servlet-container" => { "type" => STRING, "description" => "The servers default servlet container", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a server", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "host" => { "description" => "The servers host", "model-description" => {"*" => { "description" => "An Undertow host", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.undertow.host", "dynamic" => true, "dynamic-elements" => [ "server", "host" ], "stability" => "default" }, { "name" => "org.wildfly.web.common.host", "dynamic" => true, "dynamic-elements" => ["host"], "stability" => "default" } ], "attributes" => { "alias" => { "type" => LIST, "description" => "Aliases for the host", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-response-code" => { "type" => INT, "description" => "If set, this will be response code sent back in case requested context does not exist on server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 404, "min" => 400L, "max" => 599L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "default-web-module" => { "type" => STRING, "description" => "Default web module", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "ROOT.war", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "disable-console-redirect" => { "type" => BOOLEAN, "description" => "if set to true, /console redirect wont be enabled for this host, default is false", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "queue-requests-on-start" => { "type" => BOOLEAN, "description" => "If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a new host", "request-properties" => { "alias" => { "type" => LIST, "description" => "Aliases for the host", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "default-response-code" => { "type" => INT, "description" => "If set, this will be response code sent back in case requested context does not exist on server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 404, "min" => 400L, "max" => 599L, "stability" => "default" }, "default-web-module" => { "type" => STRING, "description" => "Default web module", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "ROOT.war", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "disable-console-redirect" => { "type" => BOOLEAN, "description" => "if set to true, /console redirect wont be enabled for this host, default is false", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "queue-requests-on-start" => { "type" => BOOLEAN, "description" => "If requests should be queued on start for this host. If this is set to false the default response code will be returned instead.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a host", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => { "location" => { "description" => "Holds configuration of location resource", "model-description" => {"*" => { "description" => "Holds configuration of location resource", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.host.location", "dynamic" => true, "dynamic-elements" => [ "server", "host", "location" ], "stability" => "default" }], "attributes" => {"handler" => { "type" => STRING, "description" => "Default handler for this location", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.extension.undertow.handler", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }}, "operations" => { "add" => { "operation-name" => "add", "description" => "Add new location", "request-properties" => {"handler" => { "type" => STRING, "description" => "Default handler for this location", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.extension.undertow.handler", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "remove this location", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {"filter-ref" => { "description" => "Reference to filter", "model-description" => {"*" => { "description" => "Reference to filter", "stability" => "default", "attributes" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "priority" => { "type" => INT, "description" => "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add new reference", "request-properties" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "priority" => { "type" => INT, "description" => "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "remove selected reference", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }} }} }, "setting" => { "description" => "Settings", "model-description" => { "access-log" => { "description" => "The access log configuration for this virtual server.", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.host.access-log", "dynamic" => true, "dynamic-elements" => [ "server", "host" ], "stability" => "default" }], "access-constraints" => {"sensitive" => {"web-access-log" => {"type" => "undertow"}}}, "attributes" => { "directory" => { "type" => STRING, "description" => "Directory in which to save logs", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => expression "${jboss.server.log.dir}", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "extended" => { "type" => BOOLEAN, "description" => "If the log uses the extended log file format", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "pattern" => { "type" => STRING, "description" => "The access log pattern.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "common", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "predicate" => { "type" => STRING, "description" => "Predicate that determines if the request should be logged", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "prefix" => { "type" => STRING, "description" => "Prefix for the log file name.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "access_log.", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "rotate" => { "type" => BOOLEAN, "description" => "Rotate the access log every day.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "suffix" => { "type" => STRING, "description" => "Suffix for the log file name.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "log", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "use-server-log" => { "type" => BOOLEAN, "description" => "If the log should be written to the server log, rather than a separate file.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "Name of the worker to use for logging", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add access log configuration to this virtual server.", "request-properties" => { "directory" => { "type" => STRING, "description" => "Directory in which to save logs", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => expression "${jboss.server.log.dir}", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "extended" => { "type" => BOOLEAN, "description" => "If the log uses the extended log file format", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "pattern" => { "type" => STRING, "description" => "The access log pattern.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "common", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "predicate" => { "type" => STRING, "description" => "Predicate that determines if the request should be logged", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "prefix" => { "type" => STRING, "description" => "Prefix for the log file name.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "access_log.", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "relative-to" => { "type" => STRING, "description" => "The directory the path is relative to", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "rotate" => { "type" => BOOLEAN, "description" => "Rotate the access log every day.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "suffix" => { "type" => STRING, "description" => "Suffix for the log file name.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "log", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "use-server-log" => { "type" => BOOLEAN, "description" => "If the log should be written to the server log, rather than a separate file.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "Name of the worker to use for logging", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Remove access log configuration from this virtual server.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "console-access-log" => { "description" => "Allows the access log to be written to the console.", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.host.console-access-log", "dynamic" => true, "dynamic-elements" => [ "server", "host" ], "stability" => "default" }], "attributes" => { "attributes" => { "type" => OBJECT, "description" => "The attributes to be included in the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => { "remote-host" => {}, "remote-user" => {}, "date-time" => {}, "request-line" => {}, "response-code" => {}, "bytes-sent" => {} }, "stability" => "default", "value-type" => { "authentication-type" => { "type" => OBJECT, "description" => "The authentication type used.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "authenticationType", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "bytes-sent" => { "type" => OBJECT, "description" => "The number of bytes, excluding HTTP headers, sent.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "bytesSent", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "date-time" => { "type" => OBJECT, "description" => "The date and time.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "dateTime", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "date-format" => { "type" => STRING, "description" => "The pattern, in the SimpleDateFormatter pattern, used to format the date with.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "time-zone" => { "type" => STRING, "description" => "The time zone used to format the date and/or time assuming the date format was defined. This must be a valid java.util.TimeZone.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" } } }, "host-and-port" => { "type" => OBJECT, "description" => "The host and port for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "hostAndPort", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-ip" => { "type" => OBJECT, "description" => "The IP address of the local connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localIp", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-port" => { "type" => OBJECT, "description" => "The port of the local connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localPort", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-server-name" => { "type" => OBJECT, "description" => "The local server name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localServerName", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "path-parameter" => { "type" => OBJECT, "description" => "The name of a parameter in the path. Note that the key for the structured output will be the parameter name and the value will be the value of of the parameter.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "predicate" => { "type" => OBJECT, "description" => "The name of the predicate context. Note that the key will be the name of the predicate and the value will be the resolved from the predicate context.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "query-parameter" => { "type" => OBJECT, "description" => "The name of a query parameter. Note that the key for the structured output will be the query parameter name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "query-string" => { "type" => OBJECT, "description" => "The query string.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "queryString", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-question-mark" => { "type" => BOOLEAN, "description" => "Indicates whether or not the query string should be include the question mark.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } } }, "relative-path" => { "type" => OBJECT, "description" => "The relative path of the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "relativePath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "remote-host" => { "type" => OBJECT, "description" => "The remote host name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteHost", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "remote-ip" => { "type" => OBJECT, "description" => "The remote IP address.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteIp", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "obfuscated" => { "type" => BOOLEAN, "description" => "Indicates whether or not the IP address should be obfuscated.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } } }, "remote-user" => { "type" => OBJECT, "description" => "Remote user that was authenticated.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteUser", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-header" => { "type" => OBJECT, "description" => "The name of a request header. Note that the key for the structured data will be the headers name and the value will be the value of the header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "request-line" => { "type" => OBJECT, "description" => "The request line.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestLine", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-method" => { "type" => OBJECT, "description" => "The request method.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestMethod", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-path" => { "type" => OBJECT, "description" => "The relative path for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestPath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-protocol" => { "type" => OBJECT, "description" => "The protocol for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestProtocol", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-scheme" => { "type" => OBJECT, "description" => "The request URI's scheme.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestScheme", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-url" => { "type" => OBJECT, "description" => "The original request URI. This will include the host name, protocol etc. if it was specified by the client.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestUrl", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "resolved-path" => { "type" => OBJECT, "description" => "The resolved path.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "resolvedPath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-code" => { "type" => OBJECT, "description" => "The response code.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseCode", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-header" => { "type" => OBJECT, "description" => "The name of the response header. Note the key for the structured data will be the header name and the value will be the value of the header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "response-reason-phrase" => { "type" => OBJECT, "description" => "The text reason for the response code.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseReasonPhrase", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-time" => { "type" => OBJECT, "description" => "The time used to process the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseTime", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "time-unit" => { "type" => STRING, "description" => "The unit of time used for the response time.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "MILLISECONDS", "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS" ], "stability" => "default" } } }, "secure-exchange" => { "type" => OBJECT, "description" => "Indicates whether or not the exchange was secure.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "secureExchange", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-cipher" => { "type" => OBJECT, "description" => "The SSL cipher.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslCipher", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-client-cert" => { "type" => OBJECT, "description" => "The SSL client certificate.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslClientCert", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-session-id" => { "type" => OBJECT, "description" => "The SSL session id.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslSessionId", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "stored-response" => { "type" => OBJECT, "description" => "The stored response.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "storedResponse", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "thread-name" => { "type" => OBJECT, "description" => "The thread name of the current thread.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "threadName", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "transport-protocol" => { "type" => OBJECT, "description" => "The protocol used to transmit messages on this connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "transportProtocol", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} } }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "include-host-name" => { "type" => BOOLEAN, "description" => "Indicates whether or not the host name should included in the JSON structured output. If set to true the key will be hostName in the structured data and the value will be the host this console-access-log belongs to.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "metadata" => { "type" => OBJECT, "description" => "Any additional metadata to add to the JSON structured output.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "predicate" => { "type" => STRING, "description" => "Predicate that determines if the request should be logged.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "Name of the worker to use for logging.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds an access logger which writes to the console. The data is written in a JSON format.", "request-properties" => { "attributes" => { "type" => OBJECT, "description" => "The attributes to be included in the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => { "remote-host" => {}, "remote-user" => {}, "date-time" => {}, "request-line" => {}, "response-code" => {}, "bytes-sent" => {} }, "stability" => "default", "value-type" => { "authentication-type" => { "type" => OBJECT, "description" => "The authentication type used.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "authenticationType", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "bytes-sent" => { "type" => OBJECT, "description" => "The number of bytes, excluding HTTP headers, sent.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "bytesSent", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "date-time" => { "type" => OBJECT, "description" => "The date and time.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "dateTime", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "date-format" => { "type" => STRING, "description" => "The pattern, in the SimpleDateFormatter pattern, used to format the date with.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "time-zone" => { "type" => STRING, "description" => "The time zone used to format the date and/or time assuming the date format was defined. This must be a valid java.util.TimeZone.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" } } }, "host-and-port" => { "type" => OBJECT, "description" => "The host and port for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "hostAndPort", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-ip" => { "type" => OBJECT, "description" => "The IP address of the local connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localIp", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-port" => { "type" => OBJECT, "description" => "The port of the local connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localPort", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "local-server-name" => { "type" => OBJECT, "description" => "The local server name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "localServerName", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "path-parameter" => { "type" => OBJECT, "description" => "The name of a parameter in the path. Note that the key for the structured output will be the parameter name and the value will be the value of of the parameter.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "predicate" => { "type" => OBJECT, "description" => "The name of the predicate context. Note that the key will be the name of the predicate and the value will be the resolved from the predicate context.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "query-parameter" => { "type" => OBJECT, "description" => "The name of a query parameter. Note that the key for the structured output will be the query parameter name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "query-string" => { "type" => OBJECT, "description" => "The query string.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "queryString", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-question-mark" => { "type" => BOOLEAN, "description" => "Indicates whether or not the query string should be include the question mark.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } } }, "relative-path" => { "type" => OBJECT, "description" => "The relative path of the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "relativePath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "remote-host" => { "type" => OBJECT, "description" => "The remote host name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteHost", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "remote-ip" => { "type" => OBJECT, "description" => "The remote IP address.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteIp", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "obfuscated" => { "type" => BOOLEAN, "description" => "Indicates whether or not the IP address should be obfuscated.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } } }, "remote-user" => { "type" => OBJECT, "description" => "Remote user that was authenticated.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "remoteUser", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-header" => { "type" => OBJECT, "description" => "The name of a request header. Note that the key for the structured data will be the headers name and the value will be the value of the header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "request-line" => { "type" => OBJECT, "description" => "The request line.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestLine", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-method" => { "type" => OBJECT, "description" => "The request method.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestMethod", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-path" => { "type" => OBJECT, "description" => "The relative path for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestPath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-protocol" => { "type" => OBJECT, "description" => "The protocol for the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestProtocol", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-scheme" => { "type" => OBJECT, "description" => "The request URI's scheme.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestScheme", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "request-url" => { "type" => OBJECT, "description" => "The original request URI. This will include the host name, protocol etc. if it was specified by the client.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "requestUrl", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "resolved-path" => { "type" => OBJECT, "description" => "The resolved path.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "resolvedPath", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-code" => { "type" => OBJECT, "description" => "The response code.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseCode", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-header" => { "type" => OBJECT, "description" => "The name of the response header. Note the key for the structured data will be the header name and the value will be the value of the header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key-prefix" => { "type" => STRING, "description" => "The prefix used to help keep unique keys. The name will be appended to the prefix if the prefix is defined. Otherwise just the name will be used as the key for the structured data.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "names" => { "type" => LIST, "description" => "A list of names used to resolve the exchange values.", "expressions-allowed" => true, "required" => true, "nillable" => false, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING } } }, "response-reason-phrase" => { "type" => OBJECT, "description" => "The text reason for the response code.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseReasonPhrase", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "response-time" => { "type" => OBJECT, "description" => "The time used to process the request.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => { "key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "responseTime", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "time-unit" => { "type" => STRING, "description" => "The unit of time used for the response time.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "MILLISECONDS", "allowed" => [ "NANOSECONDS", "MICROSECONDS", "MILLISECONDS", "SECONDS" ], "stability" => "default" } } }, "secure-exchange" => { "type" => OBJECT, "description" => "Indicates whether or not the exchange was secure.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "secureExchange", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-cipher" => { "type" => OBJECT, "description" => "The SSL cipher.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslCipher", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-client-cert" => { "type" => OBJECT, "description" => "The SSL client certificate.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslClientCert", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "ssl-session-id" => { "type" => OBJECT, "description" => "The SSL session id.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "sslSessionId", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "stored-response" => { "type" => OBJECT, "description" => "The stored response.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "storedResponse", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "thread-name" => { "type" => OBJECT, "description" => "The thread name of the current thread.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "threadName", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} }, "transport-protocol" => { "type" => OBJECT, "description" => "The protocol used to transmit messages on this connection.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default", "value-type" => {"key" => { "type" => STRING, "description" => "The key for the structured output.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "transportProtocol", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }} } } }, "include-host-name" => { "type" => BOOLEAN, "description" => "Indicates whether or not the host name should included in the JSON structured output. If set to true the key will be hostName in the structured data and the value will be the host this console-access-log belongs to.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "metadata" => { "type" => OBJECT, "description" => "Any additional metadata to add to the JSON structured output.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING }, "predicate" => { "type" => STRING, "description" => "Predicate that determines if the request should be logged.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "Name of the worker to use for logging.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Stops the access logger from writing to the console.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "single-sign-on" => { "description" => "An SSO authentication mechanism configuration.", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.host.sso", "dynamic" => true, "dynamic-elements" => [ "server", "host" ], "stability" => "default" }], "deprecated" => { "since" => "12.0.0", "reason" => "Legacy PicketBox based security is no longer supported." }, "attributes" => { "cookie-name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONIDSSO", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "domain" => { "type" => STRING, "description" => "The cookie domain that will be used.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http-only" => { "type" => BOOLEAN, "description" => "Set Cookie httpOnly attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "Cookie path.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "Set Cookie secure attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds an SSO authentication mechanism.", "request-properties" => { "cookie-name" => { "type" => STRING, "description" => "Name of the cookie", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "JSESSIONIDSSO", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "domain" => { "type" => STRING, "description" => "The cookie domain that will be used.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "http-only" => { "type" => BOOLEAN, "description" => "Set Cookie httpOnly attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "path" => { "type" => STRING, "description" => "Cookie path.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "/", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "Set Cookie secure attribute.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the SSO authentication mechanism.", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "resource-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }, "http-invoker" => { "description" => "The HTTP invoker services that allows remote HTTP based invocation of services such as Jakarta Enterprise Beans and naming", "stability" => "default", "capabilities" => [{ "name" => "org.wildfly.undertow.http-invoker.host", "dynamic" => true, "dynamic-elements" => [ "server", "host" ], "stability" => "default" }], "attributes" => { "http-authentication-factory" => { "type" => STRING, "description" => "The HTTP authentication factory to use for authentication", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.http-authentication-factory", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"authentication-factory-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "path" => { "type" => STRING, "description" => "The path that the services are installed under", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "wildfly-services", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "security-realm" => { "type" => STRING, "description" => "The legacy security realm to use for authentication", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["http-authentication-factory"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "12.0.0", "reason" => "Use an http-authentication-factory to provide authentication capabilities to the invoker." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds the HTTP invoker service to the host", "request-properties" => { "http-authentication-factory" => { "type" => STRING, "description" => "The HTTP authentication factory to use for authentication", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["security-realm"], "capability-reference" => "org.wildfly.security.http-authentication-factory", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "path" => { "type" => STRING, "description" => "The path that the services are installed under", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "wildfly-services", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "security-realm" => { "type" => STRING, "description" => "The legacy security realm to use for authentication", "expressions-allowed" => false, "required" => false, "nillable" => true, "alternatives" => ["http-authentication-factory"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "12.0.0", "reason" => "Use an http-authentication-factory to provide authentication capabilities to the invoker." } } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes the HTTP invoker service", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} } } }, "filter-ref" => { "description" => "Reference to filter", "model-description" => {"*" => { "description" => "Reference to filter", "stability" => "default", "attributes" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "priority" => { "type" => INT, "description" => "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Add new reference", "request-properties" => { "predicate" => { "type" => STRING, "description" => "Predicates provide a simple way of making a true/false decision based on an exchange. Many handlers have a requirement that they be applied conditionally, and predicates provide a general way to specify a condition.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "priority" => { "type" => INT, "description" => "Defines filter order. A lower number instructs the server to be included earlier in the handler chain than others with higher numbers. Values range from 1, indicating the filter will be handled first, to 2147483647, resulting in the filter being handled last.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1, "min" => 1L, "max" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "remove selected reference", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } }} }, "http-listener" => { "description" => "A HTTP listener", "model-description" => {"*" => { "description" => "http listener", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.undertow.listener", "dynamic" => true, "dynamic-elements" => ["http-listener"], "stability" => "default" }, { "name" => "org.wildfly.undertow.server.listener", "dynamic" => true, "dynamic-elements" => [ "server", "http-listener" ], "stability" => "default" }, { "name" => "org.wildfly.undertow.listener.http-upgrade-registry", "dynamic" => true, "dynamic-elements" => ["http-listener"], "stability" => "default" } ], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "proxy-protocol" => { "type" => BOOLEAN, "description" => "If this is true then the listener will use the proxy protocol v1, as defined by https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt. This option MUST only be enabled for listeners that are behind a load balancer that supports the same protocol.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "reset-statistics" => { "operation-name" => "reset-statistics", "description" => "Resets all the connector statistics to zero", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Listener name", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "add" => { "operation-name" => "add", "description" => "Add listener", "request-properties" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." } }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "proxy-protocol" => { "type" => BOOLEAN, "description" => "If this is true then the listener will use the proxy protocol v1, as defined by https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt. This option MUST only be enabled for listeners that are behind a load balancer that supports the same protocol.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "ajp-listener" => { "description" => "An AJP listener", "model-description" => {"*" => { "description" => "http listener", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.undertow.listener", "dynamic" => true, "dynamic-elements" => ["ajp-listener"], "stability" => "default" }, { "name" => "org.wildfly.undertow.server.listener", "dynamic" => true, "dynamic-elements" => [ "server", "ajp-listener" ], "stability" => "default" } ], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum supported size of AJP packets. If this is modified it has to be increased on the load balancer and the backend server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 8192, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "scheme" => { "type" => STRING, "description" => "The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "reset-statistics" => { "operation-name" => "reset-statistics", "description" => "Resets all the connector statistics to zero", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Listener name", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "add" => { "operation-name" => "add", "description" => "Add listener", "request-properties" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." } }, "max-ajp-packet-size" => { "type" => INT, "description" => "The maximum supported size of AJP packets. If this is modified it has to be increased on the load balancer and the backend server.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 8192, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "redirect-socket" => { "type" => STRING, "description" => "If this listener is supporting non-SSL requests, and a request is received for which a matching requires SSL transport, undertow will automatically redirect the request to the socket binding port specified here.", "expressions-allowed" => false, "required" => false, "nillable" => true, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "scheme" => { "type" => STRING, "description" => "The listener scheme, can be HTTP or HTTPS. By default the scheme will be taken from the incoming AJP request.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} }, "https-listener" => { "description" => "A HTTPS listener", "model-description" => {"*" => { "description" => "http listener", "stability" => "default", "capabilities" => [ { "name" => "org.wildfly.undertow.listener", "dynamic" => true, "dynamic-elements" => ["https-listener"], "stability" => "default" }, { "name" => "org.wildfly.undertow.server.listener", "dynamic" => true, "dynamic-elements" => [ "server", "https-listener" ], "stability" => "default" }, { "name" => "org.wildfly.undertow.listener.http-upgrade-registry", "dynamic" => true, "dynamic-elements" => ["https-listener"], "stability" => "default" } ], "access-constraints" => {"sensitive" => {"web-connector" => {"type" => "undertow"}}}, "attributes" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "bytes-received" => { "type" => LONG, "description" => "The number of bytes that have been received by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "bytes-sent" => { "type" => LONG, "description" => "The number of bytes that have been sent out on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "BYTES", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enable-spdy" => { "type" => BOOLEAN, "description" => "Enables SPDY support for this listener. This has been deprecated and has no effect, HTTP/2 should be used instead", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "SPDY has been replaced by HTTP/2" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled-cipher-suites" => { "type" => STRING, "description" => "Configures Enabled SSL ciphers", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured with the cipher suites to be supported." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "enabled-protocols" => { "type" => STRING, "description" => "Configures SSL protocols", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is references it should be configured with the supported protocols." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "error-count" => { "type" => LONG, "description" => "The number of 500 responses that have been sent by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "max-processing-time" => { "type" => LONG, "description" => "The maximum processing time taken by a request on this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "processing-time" => { "type" => LONG, "description" => "The total processing time of all requests handed by this listener", "expressions-allowed" => false, "required" => true, "nillable" => false, "unit" => "NANOSECONDS", "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "proxy-protocol" => { "type" => BOOLEAN, "description" => "If this is true then the listener will use the proxy protocol v1, as defined by https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt. This option MUST only be enabled for listeners that are behind a load balancer that supports the same protocol.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "request-count" => { "type" => LONG, "description" => "The number of requests this listener has served", "expressions-allowed" => false, "required" => true, "nillable" => false, "stability" => "default", "access-type" => "metric", "storage" => "runtime" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "resource-services" }, "security-realm" => { "type" => STRING, "description" => "The listeners security realm", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "A defined SSLContext should be referenced using the ssl-context attribute." }, "access-constraints" => {"sensitive" => {"security-realm-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"socket-binding-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this listener.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => [ "security-realm", "verify-client", "enabled-cipher-suites", "enabled-protocols", "ssl-session-cache-size", "ssl-session-timeout" ], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-constraints" => {"sensitive" => {"ssl-ref" => {"type" => "core"}}}, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "ssl-session-cache-size" => { "type" => INT, "description" => "The maximum number of active SSL sessions", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "This can now be configured on the Elytron security context" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "ssl-session-timeout" => { "type" => INT, "description" => "The timeout for SSL sessions, in seconds", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "SECONDS", "alternatives" => ["ssl-context"], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "This can now be configured on the Elytron security context" }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" }, "verify-client" => { "type" => STRING, "description" => "The desired SSL client authentication mode for SSL channels", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "NOT_REQUESTED", "alternatives" => ["ssl-context"], "allowed" => [ "NOT_REQUESTED", "REQUESTED", "REQUIRED" ], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured directly for the required mode of client verification." }, "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "no-services" } }, "operations" => { "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "reset-statistics" => { "operation-name" => "reset-statistics", "description" => "Resets all the connector statistics to zero", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => true }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Listener name", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "add" => { "operation-name" => "add", "description" => "Add listener", "request-properties" => { "allow-encoded-slash" => { "type" => BOOLEAN, "description" => "If a request comes in with encoded / characters (i.e. %2F), will these be decoded.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-equals-in-cookie-value" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will allow non-escaped equals characters in unquoted cookie values. Unquoted cookie values may not contain equals characters. If present the value ends before the equals sign. The remainder of the cookie value will be dropped.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "allow-unescaped-characters-in-url" => { "type" => BOOLEAN, "description" => "If this is true Undertow will accept non-encoded characters that are disallowed by the URI specification. This defaults to false, and in general should not be needed as most clients correctly encode characters. Note that setting this to true can be considered a security risk, as allowing non-standard characters can allow request smuggling attacks in some circumstances.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "always-set-keep-alive" => { "type" => BOOLEAN, "description" => "If this is true then a Connection: keep-alive header will be added to responses, even when it is not strictly required by the specification.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "buffer-pipelined-data" => { "type" => BOOLEAN, "description" => "If we should buffer pipelined requests.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "buffer-pool" => { "type" => STRING, "description" => "The listeners buffer pool", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.undertow.byte-buffer-pool", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "certificate-forwarding" => { "type" => BOOLEAN, "description" => "If certificate forwarding should be enabled. If this is enabled then the listener will take the certificate from the SSL_CLIENT_CERT attribute. This should only be enabled if behind a proxy, and the proxy is configured to always set these headers.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "decode-url" => { "type" => BOOLEAN, "description" => "If this is true then the parser will decode the URL and query parameters using the selected character encoding (UTF-8 by default). If this is false they will not be decoded. This will allow a later handler to decode them into whatever charset is desired.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "disallowed-methods" => { "type" => LIST, "description" => "A comma separated list of HTTP methods that are not allowed", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => ["TRACE"], "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "enable-http2" => { "type" => BOOLEAN, "description" => "Enables HTTP2 support for this listener", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "enable-spdy" => { "type" => BOOLEAN, "description" => "Enables SPDY support for this listener. This has been deprecated and has no effect, HTTP/2 should be used instead", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "SPDY has been replaced by HTTP/2" } }, "enabled" => { "type" => BOOLEAN, "description" => "If the listener is enabled", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default", "deprecated" => { "since" => "3.2.0", "reason" => "Enabled attributes are being deprecated, as they cause problems in enforcement of configuration consistency." } }, "enabled-cipher-suites" => { "type" => STRING, "description" => "Configures Enabled SSL ciphers", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured with the cipher suites to be supported." } }, "enabled-protocols" => { "type" => STRING, "description" => "Configures SSL protocols", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is references it should be configured with the supported protocols." } }, "http2-enable-push" => { "type" => BOOLEAN, "description" => "If server push is enabled for this connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "http2-header-table-size" => { "type" => INT, "description" => "The size of the header table used for HPACK compression, in bytes. This amount of memory will be allocated per connection for compression. Larger values use more memory but may give better compression.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 4096, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-initial-window-size" => { "type" => INT, "description" => "The flow control window size that controls how quickly the client can send data to the server", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 65535, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-concurrent-streams" => { "type" => INT, "description" => "The maximum number of HTTP/2 streams that can be active at any time on a single connection", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-frame-size" => { "type" => INT, "description" => "The max HTTP/2 frame size", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "http2-max-header-list-size" => { "type" => INT, "description" => "The maximum size of request headers the server is prepared to accept", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-buffered-request-size" => { "type" => INT, "description" => "Maximum size of a buffered request, in bytes. Requests are not usually buffered, the most common case is when performing SSL renegotiation for a POST request, and the post data must be fully buffered in order to perform the renegotiation.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 16384, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-connections" => { "type" => INT, "description" => "The maximum number of concurrent connections. Only values greater than 0 are allowed. For unlimited connections simply undefine this attribute value.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-cookies" => { "type" => INT, "description" => "The maximum number of cookies that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-header-size" => { "type" => INT, "description" => "The maximum size of a http request header, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1048576, "unit" => "BYTES", "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-headers" => { "type" => INT, "description" => "The maximum number of headers that will be parsed. This is used to protect against hash vulnerabilities.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 200, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-parameters" => { "type" => INT, "description" => "The maximum number of parameters that will be parsed. This is used to protect against hash vulnerabilities. This applies to both query parameters, and to POST data, but is not cumulative (i.e. you can potentially have max parameters * 2 total parameters).", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "max-post-size" => { "type" => LONG, "description" => "The maximum size of a post that will be accepted, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10485760L, "unit" => "BYTES", "min" => 0L, "max" => 9223372036854775807L, "stability" => "default" }, "no-request-timeout" => { "type" => INT, "description" => "The length of time in milliseconds that the connection can be idle before it is closed by the container.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 60000, "unit" => "MILLISECONDS", "stability" => "default" }, "proxy-address-forwarding" => { "type" => BOOLEAN, "description" => "Enables handling of x-forwarded-host header (and other x-forwarded-* headers) and use this header information to set the remote address. This should only be used behind a trusted proxy that sets these headers otherwise a remote user can spoof their IP address.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "proxy-protocol" => { "type" => BOOLEAN, "description" => "If this is true then the listener will use the proxy protocol v1, as defined by https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt. This option MUST only be enabled for listeners that are behind a load balancer that supports the same protocol.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "read-timeout" => { "type" => INT, "description" => "Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a {@link ReadTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" }, "receive-buffer" => { "type" => INT, "description" => "The receive buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "record-request-start-time" => { "type" => BOOLEAN, "description" => "If this is true then Undertow will record the request start time, to allow for request time to be logged. This has a small but measurable performance impact", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "request-parse-timeout" => { "type" => INT, "description" => "The maximum amount of time (in milliseconds) that can be spent parsing the request", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "MILLISECONDS", "stability" => "default" }, "require-host-http11" => { "type" => BOOLEAN, "description" => "Require that all HTTP/1.1 requests have a 'Host' header, as per the RFC. IF the request does not include this header it will be rejected with a 403.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "resolve-peer-address" => { "type" => BOOLEAN, "description" => "Enables host dns lookup", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "rfc6265-cookie-validation" => { "type" => BOOLEAN, "description" => "If cookies should be validated to ensure they comply with RFC6265.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "secure" => { "type" => BOOLEAN, "description" => "If this is true then requests that originate from this listener are marked as secure, even if the request is not using HTTPS.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "security-realm" => { "type" => STRING, "description" => "The listeners security realm", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => ["ssl-context"], "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "A defined SSLContext should be referenced using the ssl-context attribute." } }, "send-buffer" => { "type" => INT, "description" => "The send buffer size, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "socket-binding" => { "type" => STRING, "description" => "The listener socket binding", "expressions-allowed" => false, "required" => true, "nillable" => false, "capability-reference" => "org.wildfly.network.socket-binding", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "ssl-context" => { "type" => STRING, "description" => "Reference to the SSLContext to be used by this listener.", "expressions-allowed" => false, "required" => true, "nillable" => true, "alternatives" => [ "security-realm", "verify-client", "enabled-cipher-suites", "enabled-protocols", "ssl-session-cache-size", "ssl-session-timeout" ], "capability-reference" => "org.wildfly.security.ssl-context", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "ssl-session-cache-size" => { "type" => INT, "description" => "The maximum number of active SSL sessions", "expressions-allowed" => true, "required" => false, "nillable" => true, "alternatives" => ["ssl-context"], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "This can now be configured on the Elytron security context" } }, "ssl-session-timeout" => { "type" => INT, "description" => "The timeout for SSL sessions, in seconds", "expressions-allowed" => true, "required" => false, "nillable" => true, "unit" => "SECONDS", "alternatives" => ["ssl-context"], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "This can now be configured on the Elytron security context" } }, "tcp-backlog" => { "type" => INT, "description" => "Configure a server with the specified backlog.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10000, "min" => 1L, "max" => 2147483647L, "stability" => "default" }, "tcp-keep-alive" => { "type" => BOOLEAN, "description" => "Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default" }, "url-charset" => { "type" => STRING, "description" => "URL charset", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "UTF-8", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "verify-client" => { "type" => STRING, "description" => "The desired SSL client authentication mode for SSL channels", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => "NOT_REQUESTED", "alternatives" => ["ssl-context"], "allowed" => [ "NOT_REQUESTED", "REQUESTED", "REQUIRED" ], "stability" => "default", "deprecated" => { "since" => "4.0.0", "reason" => "Where an SSLContext is referenced it should be configured directly for the required mode of client verification." } }, "worker" => { "type" => STRING, "description" => "The listeners XNIO worker", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "default", "capability-reference" => "org.wildfly.io.worker", "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "write-timeout" => { "type" => INT, "description" => "Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a {@link WriteTimeoutException}.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 90000, "unit" => "MILLISECONDS", "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } }} }, "buffer-cache" => { "description" => "The buffer cache used to cache static content", "model-description" => {"*" => { "description" => "The buffer cache used to cache static content", "stability" => "default", "attributes" => { "buffer-size" => { "type" => INT, "description" => "The size of an individual buffer, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "buffers-per-region" => { "type" => INT, "description" => "The numbers of buffers in a region", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" }, "max-regions" => { "type" => INT, "description" => "The maximum number of regions", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "stability" => "default", "access-type" => "read-write", "storage" => "configuration", "restart-required" => "all-services" } }, "operations" => { "add" => { "operation-name" => "add", "description" => "Adds a buffer cache", "request-properties" => { "buffer-size" => { "type" => INT, "description" => "The size of an individual buffer, in bytes.", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "buffers-per-region" => { "type" => INT, "description" => "The numbers of buffers in a region", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 1024, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "max-regions" => { "type" => INT, "description" => "The maximum number of regions", "expressions-allowed" => true, "required" => false, "nillable" => true, "default" => 10, "min" => 0L, "max" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "request-properties" => { "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the full key/value pair for any singleton registration.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children types" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "whoami" => { "operation-name" => "whoami", "description" => "Returns the identity of the currently authenticated user.", "request-properties" => {"verbose" => { "type" => BOOLEAN, "description" => "If set to true whoami also returns the users roles.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => STRING, "description" => "The identify of the authenticated user and their roles if requested." }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "map-clear" => { "operation-name" => "map-clear", "description" => "Clear all entries from map attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-get" => { "operation-name" => "list-get", "description" => "Get entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Index entry to get", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "query" => { "operation-name" => "query", "description" => "query a resource", "request-properties" => { "select" => { "type" => LIST, "description" => "a list of attribute names to reduce to", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 0L, "max-length" => 2147483647L, "stability" => "default", "value-type" => STRING }, "where" => { "type" => OBJECT, "description" => "a list of filter criteria tuples (i.e. 'running=true')", "expressions-allowed" => true, "required" => false, "nillable" => true, "stability" => "default", "value-type" => STRING } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets description of given operation", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of operation", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "locale" => { "type" => STRING, "description" => "Locale in which to return description", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "access-control" => { "type" => BOOLEAN, "description" => "Whether or not to include information about what rights the current user has on the operation.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => {"type" => OBJECT}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "write-attribute" => { "operation-name" => "write-attribute", "description" => "Sets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to set the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selected resource. May be null if the underlying model supports null values.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-get" => { "operation-name" => "map-get", "description" => "Get entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to return", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-clear" => { "operation-name" => "list-clear", "description" => "Clear all entries from list attribute", "request-properties" => {"name" => { "type" => STRING, "description" => "Name of list attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "remove" => { "operation-name" => "remove", "description" => "Removes a buffer cache", "request-properties" => {}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "restart-required" => "all-services", "runtime-only" => false }, "map-remove" => { "operation-name" => "map-remove", "description" => "Remove entry from map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key of entry to remove", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "list-add" => { "operation-name" => "list-add", "description" => "Add entry to list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to add to list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index where to insert value to", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-attribute-group" => { "operation-name" => "read-attribute-group", "description" => "Gets the value of attributes for the selected group", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of the group to get the attribute", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' include attributes which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => PROPERTY, "description" => "The attributes" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "undefine-attribute" => { "operation-name" => "undefine-attribute", "description" => "Sets the value of an attribute of the selected resource to 'undefined'", "request-properties" => {"name" => { "type" => STRING, "description" => "The name of the attribute which should be set to 'undefined'", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }}, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "map-put" => { "operation-name" => "map-put", "description" => "Add entry to map attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of map attribute to add entry to", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "key" => { "type" => STRING, "description" => "Key under which value will be added", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value to be added", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-names" => { "operation-name" => "read-children-names", "description" => "Gets the names of all children under the selected resource with the given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the node under which to get the children names", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "include-singletons" => { "type" => BOOLEAN, "description" => "If 'true' include the allowed values for any singleton registration, even if no resource currently exists with that name.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The children names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-attribute-group-names" => { "operation-name" => "read-attribute-group-names", "description" => "Gets the names of all the attribute groups under the selected resource", "request-properties" => {}, "reply-properties" => { "type" => LIST, "value-type" => STRING }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "request-properties" => {"access-control" => { "type" => BOOLEAN, "description" => "If 'true' only operations the user is allowed to see are returned, and filtered operations are listed in the 'access-control' response header.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }}, "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "list-remove" => { "operation-name" => "list-remove", "description" => "Remove entry from list attribute", "request-properties" => { "name" => { "type" => STRING, "description" => "Name of list attribute to remove entry from", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "value" => { "type" => STRING, "description" => "Value remove from list", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "index" => { "type" => INT, "description" => "Optional 0 based index to tell what element to remove", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" } }, "reply-properties" => {}, "stability" => "default", "read-only" => false, "runtime-only" => false }, "read-children-resources" => { "operation-name" => "read-children-resources", "description" => "Reads information about all of a resource's children that are of a given type", "request-properties" => { "child-type" => { "type" => STRING, "description" => "The name of the resource under which to get the child resources", "expressions-allowed" => false, "required" => true, "nillable" => false, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default. Ignored if the 'recursive' parameter is set to 'true'; i.e. runtime attributes can only be read in non-recursive queries.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" } }, "reply-properties" => { "type" => LIST, "value-type" => OBJECT, "description" => "The children resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource-description" => { "operation-name" => "read-resource-description", "description" => "Gets the description of a resource's attributes, types of children and, optionally, operations", "request-properties" => { "operations" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's operations. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "notifications" => { "type" => BOOLEAN, "description" => "Whether to include descriptions of the resource's notifications. Default is false", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "access-control" => { "type" => STRING, "description" => "Include information about what rights the current user has on the actual resources, attributes and operations.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => "none", "allowed" => [ "none", "combined-descriptions", "trim-descriptions" ], "stability" => "default" }, "locale" => { "type" => STRING, "description" => "The locale to get the resource description in. If null, the default locale will be used", "expressions-allowed" => false, "required" => false, "nillable" => true, "min-length" => 1L, "max-length" => 2147483647L, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" }, "stability" => "default", "read-only" => true, "runtime-only" => false }, "read-resource" => { "operation-name" => "read-resource", "description" => "Reads a model resource's attribute values along with either basic or complete information about any child resources", "request-properties" => { "resolve-expressions" => { "type" => BOOLEAN, "description" => "Resolves expressions to current runtime values. Will only resolve against basic resolution sources like system properties and environment variables; expressions requiring resolution using other sources will not be resolved.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "expressions-allowed" => false, "required" => false, "nillable" => true, "stability" => "default" }, "recursive-depth" => { "type" => INT, "description" => "The depth to which information about child resources should be included.", "expressions-allowed" => false, "required" => false, "nillable" => true, "min" => 0L, "max" => 2147483647L, "stability" => "default" }, "proxies" => { "type" => BOOLEAN, "description" => "Whether to include remote resources in a recursive query (i.e. host level resources in a query of the domain root; running server resources in a query of a host). If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-runtime" => { "type" => BOOLEAN, "description" => "Whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. If absent, false is the default.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-defaults" => { "type" => BOOLEAN, "description" => "Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => true, "stability" => "default" }, "attributes-only" => { "type" => BOOLEAN, "description" => "Whether or not to only read the attributes on the specified resource. Cannot be used in conjunction with 'recursive' or 'recursive-depth'.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" }, "include-aliases" => { "type" => BOOLEAN, "description" => "If 'true' and recursive, include children which are aliases.", "expressions-allowed" => false, "required" => false, "nillable" => true, "default" => false, "stability" => "default" } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" }, "stability" => "default", "read-only" => true, "runtime-only" => false } }, "notifications" => undefined, "children" => {} }} } } } }