[jboss-jira] [JBoss JIRA] (AS7-2179) Operation description not consumable on CLI

Operation description not consumable on CLI ------------------------------------------- Key: AS7-2179 URL: https://issues.jboss.org/browse/AS7-2179 Project: Application Server 7 Issue Type: Bug Components: CLI, OSGi Reporter: Thomas Diesler Assignee: Alexey Loubyansky The output below is not human consumable IMHO. I suggest to split the subsystem specific operations from standard operations {code} [standalone@localhost:9999 /] /subsystem=osgi:read-resource-description(recursive=true,operations=true) { "outcome" => "success", "result" => { "description" => "The the OSGi subsystem configuration.", "head-comment-allowed" => true, "tail-comment-allowed" => true, "namespace" => "urn:jboss:domain:osgi:1.0", "attributes" => { "activation" => { "description" => "Activation flag for the OSGi subsystem. Possible values: lazy, eager.", "type" => STRING, "default" => "LAZY", "access-type" => "read-write", "restart-required" => "no-services", "storage" => "configuration" }, "startlevel" => { "description" => "The current Start Level of the OSGi Framework. Changing this value will change the start level of the Framework accordingly. ", "type" => INT, "access-type" => "read-write", "restart-required" => "no-services", "storage" => "runtime" } }, "children" => { "configuration" => { "description" => "A configuration entry.", "model-description" => {"*" => { "description" => "A configuration entry.", "attributes" => {"entries" => { "description" => "The list of configuration entries.", "required" => true, "type" => LIST, "value-type" => UNDEFINED, "access-type" => "read-only", "restart-required" => "RESTART_ALL_SERVICES", "storage" => "configuration" }}, "operations" => { "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", "nillable" => false }}, "reply-properties" => { "type" => LIST, "description" => "The children names", "value-type" => STRING } }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets the details of an operation on the given resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The description of the operation. Undefined if not found", "required" => false, "nillable" => false }, "locale" => { "type" => STRING, "nillable" => true, "description" => "The locale to get the operation description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the operation. Undefined if not found" } }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" } }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "reply-properties" => { "type" => LIST, "description" => "The children types", "value-type" => STRING } }, "remove" => { "operation-name" => "remove", "description" => "Remove a configuration entry.", "request-properties" => {}, "reply-properties" => {} }, "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", "nillable" => false }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "nillable" => true }, "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", "nillable" => true }, "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.", "required" => false, "nillable" => true }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => LIST, "description" => "The children resources", "value-type" => OBJECT } }, "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", "required" => false, "nillable" => true }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "nillable" => true }, "recursive" => { "required" => false, "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "nillable" => true }, "locale" => { "type" => STRING, "required" => false, "nillable" => true, "description" => "The locale to get the resource description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" } }, "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" => { "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "required" => false, "nillable" => true, "default" => false }, "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", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" } }, "validate-address" => { "operation-name" => "validate-address", "description" => "Validates the operation's address", "request-properties" => {}, "reply-properties" => {} }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "nillable" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" } }, "add" => { "operation-name" => "add", "description" => "Add a configuration entry.", "request-properties" => {"entries" => { "description" => "The list of configuration entries.", "type" => OBJECT, "required" => true, "value-type" => OBJECT }}, "reply-properties" => {} }, "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", "nillable" => false }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selcted resource. May be null if the underlying model supports null values.", "nillable" => true, "required" => false } } } } }} }, "property" => { "description" => "A framework property.", "model-description" => {"*" => { "description" => "A framework property.", "attributes" => {"value" => { "description" => "The framework property value.", "type" => STRING, "required" => true, "access-type" => "read-only", "restart-required" => "RESTART_ALL_SERVICES", "storage" => "configuration" }}, "operations" => { "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", "nillable" => false }}, "reply-properties" => { "type" => LIST, "description" => "The children names", "value-type" => STRING } }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets the details of an operation on the given resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The description of the operation. Undefined if not found", "required" => false, "nillable" => false }, "locale" => { "type" => STRING, "nillable" => true, "description" => "The locale to get the operation description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the operation. Undefined if not found" } }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" } }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "reply-properties" => { "type" => LIST, "description" => "The children types", "value-type" => STRING } }, "remove" => { "operation-name" => "remove", "description" => "Remove a framework property.", "request-properties" => {}, "reply-properties" => {} }, "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", "nillable" => false }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "nillable" => true }, "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", "nillable" => true }, "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.", "required" => false, "nillable" => true }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => LIST, "description" => "The children resources", "value-type" => OBJECT } }, "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", "required" => false, "nillable" => true }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "nillable" => true }, "recursive" => { "required" => false, "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "nillable" => true }, "locale" => { "type" => STRING, "required" => false, "nillable" => true, "description" => "The locale to get the resource description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" } }, "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" => { "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "required" => false, "nillable" => true, "default" => false }, "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", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" } }, "validate-address" => { "operation-name" => "validate-address", "description" => "Validates the operation's address", "request-properties" => {}, "reply-properties" => {} }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "nillable" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" } }, "add" => { "operation-name" => "add", "description" => "Add a framework property.", "request-properties" => {"value" => { "description" => "The framework property value.", "type" => STRING, "required" => true }}, "reply-properties" => {} }, "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", "nillable" => false }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selcted resource. May be null if the underlying model supports null values.", "nillable" => true, "required" => false } } } } }} }, "capability" => { "description" => "A framework capability.", "model-description" => {"*" => { "description" => "A framework capability.", "attributes" => {"startlevel" => { "description" => "The startlevel for the capability.", "type" => INT, "required" => false, "access-type" => "read-only", "restart-required" => "RESTART_ALL_SERVICES", "storage" => "configuration" }}, "operations" => { "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", "nillable" => false }}, "reply-properties" => { "type" => LIST, "description" => "The children names", "value-type" => STRING } }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets the details of an operation on the given resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The description of the operation. Undefined if not found", "required" => false, "nillable" => false }, "locale" => { "type" => STRING, "nillable" => true, "description" => "The locale to get the operation description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the operation. Undefined if not found" } }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" } }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "reply-properties" => { "type" => LIST, "description" => "The children types", "value-type" => STRING } }, "remove" => { "operation-name" => "remove", "description" => "Remove a framework capability.", "request-properties" => {}, "reply-properties" => {} }, "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", "nillable" => false }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "nillable" => true }, "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", "nillable" => true }, "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.", "required" => false, "nillable" => true }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => LIST, "description" => "The children resources", "value-type" => OBJECT } }, "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", "required" => false, "nillable" => true }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "nillable" => true }, "recursive" => { "required" => false, "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "nillable" => true }, "locale" => { "type" => STRING, "required" => false, "nillable" => true, "description" => "The locale to get the resource description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" } }, "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" => { "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "required" => false, "nillable" => true, "default" => false }, "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", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" } }, "validate-address" => { "operation-name" => "validate-address", "description" => "Validates the operation's address", "request-properties" => {}, "reply-properties" => {} }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "nillable" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" } }, "add" => { "operation-name" => "add", "description" => "Add a framework capability.", "request-properties" => {"startlevel" => { "description" => "The startlevel for the capability.", "type" => INT, "required" => false }}, "reply-properties" => {} }, "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", "nillable" => false }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selcted resource. May be null if the underlying model supports null values.", "nillable" => true, "required" => false } } } } }} }, "bundle" => { "description" => "Runtime bundle information.", "model-description" => {"*" => { "description" => "Runtime bundle information.", "attributes" => { "id" => { "type" => LONG, "description" => "The bundle ID.", "access-type" => "read-only", "storage" => "runtime" }, "startlevel" => { "type" => INT, "description" => "The bundle's start level.", "access-type" => "read-only", "required" => false, "storage" => "runtime" }, "symbolic-name" => { "type" => STRING, "description" => "The bundle symbolic name.", "access-type" => "read-only", "storage" => "runtime" }, "version" => { "type" => STRING, "description" => "The bundle version.", "access-type" => "read-only", "storage" => "runtime" } }, "operations" => { "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", "nillable" => false }}, "reply-properties" => { "type" => LIST, "description" => "The children names", "value-type" => STRING } }, "stop" => { "operation-name" => "stop", "description" => "Stops the bundle.", "request-properties" => {}, "reply-properties" => {} }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets the details of an operation on the given resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The description of the operation. Undefined if not found", "required" => false, "nillable" => false }, "locale" => { "type" => STRING, "nillable" => true, "description" => "The locale to get the operation description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the operation. Undefined if not found" } }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" } }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "reply-properties" => { "type" => LIST, "description" => "The children types", "value-type" => STRING } }, "start" => { "operation-name" => "start", "description" => "Starts the bundle.", "request-properties" => {}, "reply-properties" => {} }, "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", "nillable" => false }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "nillable" => true }, "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", "nillable" => true }, "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.", "required" => false, "nillable" => true }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => LIST, "description" => "The children resources", "value-type" => OBJECT } }, "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", "required" => false, "nillable" => true }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "nillable" => true }, "recursive" => { "required" => false, "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "nillable" => true }, "locale" => { "type" => STRING, "required" => false, "nillable" => true, "description" => "The locale to get the resource description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" } }, "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" => { "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "required" => false, "nillable" => true, "default" => false }, "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", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" } }, "validate-address" => { "operation-name" => "validate-address", "description" => "Validates the operation's address", "request-properties" => {}, "reply-properties" => {} }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "nillable" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" } }, "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", "nillable" => false }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selcted resource. May be null if the underlying model supports null values.", "nillable" => true, "required" => false } } } } }} } }, "operations" => { "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", "nillable" => false }}, "reply-properties" => { "type" => LIST, "description" => "The children names", "value-type" => STRING } }, "activate" => { "operation-name" => "activate", "description" => "Activate the OSGi subsystem.", "request-properties" => {}, "reply-properties" => {} }, "read-operation-description" => { "operation-name" => "read-operation-description", "description" => "Gets the details of an operation on the given resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The description of the operation. Undefined if not found", "required" => false, "nillable" => false }, "locale" => { "type" => STRING, "nillable" => true, "description" => "The locale to get the operation description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the operation. Undefined if not found" } }, "read-operation-names" => { "operation-name" => "read-operation-names", "description" => "Gets the names of all the operations for the given resource", "reply-properties" => { "type" => LIST, "value-type" => STRING, "description" => "The operation names" } }, "read-children-types" => { "operation-name" => "read-children-types", "description" => "Gets the type names of all the children under the selected resource", "reply-properties" => { "type" => LIST, "description" => "The children types", "value-type" => STRING } }, "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", "nillable" => false }, "recursive" => { "type" => BOOLEAN, "description" => "Whether to get the children recursively. If absent, false is the default", "nillable" => true }, "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", "nillable" => true }, "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.", "required" => false, "nillable" => true }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => LIST, "description" => "The children resources", "value-type" => OBJECT } }, "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", "required" => false, "nillable" => true }, "inherited" => { "type" => BOOLEAN, "description" => "If 'operations' is true, whether to include descriptions of the resource's inherited operations. Default is true.", "nillable" => true }, "recursive" => { "required" => false, "type" => BOOLEAN, "description" => "Whether to include recursively descriptions of child resources. Default is false.", "nillable" => true }, "locale" => { "type" => STRING, "required" => false, "nillable" => true, "description" => "The locale to get the resource description in. If null, the default locale will be used" } }, "reply-properties" => { "type" => OBJECT, "description" => "The description of the resource" } }, "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" => { "recursive" => { "type" => BOOLEAN, "description" => "Whether to include complete information about child resources, recursively. If absent, false is the default", "required" => false, "nillable" => true, "default" => false }, "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", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The resource's attribute values along with information about any child resources" } }, "validate-address" => { "operation-name" => "validate-address", "description" => "Validates the operation's address", "request-properties" => {}, "reply-properties" => {} }, "read-attribute" => { "operation-name" => "read-attribute", "description" => "Gets the value of an attribute for the selected resource", "request-properties" => { "name" => { "type" => STRING, "description" => "The name of the attribute to get the value for under the selected resource", "nillable" => false }, "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.", "required" => false, "nillable" => true, "default" => true } }, "reply-properties" => { "type" => OBJECT, "description" => "The value of the attribute. The type will be that of the attribute found" } }, "add" => { "operation-name" => "add", "description" => "Add the OSGi subsystem configuration.", "request-properties" => {"activation" => { "description" => "Activation flag for the OSGi subsystem. Possible values: lazy, eager.", "type" => STRING, "default" => "LAZY" }}, "reply-properties" => {} }, "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", "nillable" => false }, "value" => { "type" => STRING, "description" => "The value of the attribute to set the value for under the selcted resource. May be null if the underlying model supports null values.", "nillable" => true, "required" => false } } } } } } {code}