This section is an in depth reference to the JBoss Application Server management API. Readers are encouraged to read the Management Clients and Core management concepts sections for fundamental background information, as well as the Management tasks and Domain Setup sections for key task oriented information. This section is meant as an in depth reference to delve into some of the key details.
6.1 Global operations
The JBoss Application Server management API includes a number of operations that apply to every resource.
6.1.1 The read-resource operation
Reads a management resource's attribute values along with either basic or complete information about any child resources. Supports the
following parameters, none of which are required:
– (boolean, default is ) – whether to include complete information about child
recursive false
resources, recursively.
– (int) – The depth to which information about child resources should be included recursive-depth
if recursive is {{true}. If not set, the depth will be unlimited; i.e. all descendant resources will be included.
– (boolean, default is ) – whether to include remote resources in a recursive query
proxies false
(i.e. host level resources from slave Host Controllers in a query of the Domain Controller; running server resources in a query of a host).
– (boolean, default is ) – whether to include runtime attributes (i.e. those
include-runtime false
whose value does not come from the persistent configuration) in the response.
– (boolean, default is ) – whether to include in the result default values not
include-defaults true
set by users. Many attributes have a default value that will be used in the runtime if the users have not provided an explicit value. If this parameter is false the value for such attributes in the result will be
. If the result will include the default value for such parameters. undefined true
6.1.2 The read-attribute operation
Reads the value of an individual attribute. Takes a single, required, parameter: – (string) – the name of the attribute to read.
name
– (boolean, default is ) – whether to include in the result default values not
include-defaults true
set by users. Many attributes have a default value that will be used in the runtime if the users have not provided an explicit value. If this parameter is false the value for such attributes in the result will be
. If the result will include the default value for such parameters. undefined true
JBoss Community Documentation Page 161 of 660
6.1.3 The write-attribute operation
Writes the value of an individual attribute. Takes two required parameters: – (string) – the name of the attribute to write.
name
– (type depends on the attribute being written) – the new value. value
6.1.4 The unset-attribute operation
Sets the value of an individual attribute to the undefined value, if such a value is allowed for the attribute. The operation will fail if the undefined value is not allowed. Takes a single required parameter:
– (string) – the name of the attribute to write. name
6.1.5 The read-resource-description operation
Returns the description of a resource's attributes, types of children and, optionally, operations. Supports the following parameters, none of which are required:
– (boolean, default is ) – whether to include information about child resources,
recursive false
recursively.
– (boolean, default is ) – whether to include remote resources in a recursive query
proxies false
(i.e. host level resources from slave Host Controllers in a query of the Domain Controller; running server resources in a query of a host)
– (boolean, default is ) – whether to include descriptions of the resource's
operations false
operations
– (boolean, default is ) – if is , whether to include descriptions of
inherited true operations true
operations inherited from higher level resources. The global operations described in this section are themselves inherited from the root resource, so the primary effect of setting inherited to false is to exclude the descriptions of the global operations from the output.
See Description of the Management Model for details on the result of this operation.
6.1.6 The read-operation-names operation
6.1.7 The read-operation-description operation
Returns the description of an operation, along with details of its parameter types and its return value. Takes a single, required, parameter:
– (string) – the name of the operation name
See Description of the Management Model for details on the result of this operation.
6.1.8 The read-children-types operation
Returns a list of the types of child resources the resource supports. Takes no parameters.
6.1.9 The read-children-names operation
Returns a list of the names of all child resources of a given type. Takes a single, required, parameter: – (string) – the name of the type
child-type
6.1.10 The read-children-resources operation
Returns information about all of a resource's children that are of a given type. For each child resource, the returned information is equivalent to executing the read-resource operation on that resource. Takes the following parameters, of which only {{child-type} is required:
– (string) – the name of the type of child resource child-type
– (boolean, default is ) – whether to include complete information about child
recursive false
resources, recursively.
– (int) – The depth to which information about child resources should be included recursive-depth
if recursive is {{true}. If not set, the depth will be unlimited; i.e. all descendant resources will be included.
– (boolean, default is ) – whether to include remote resources in a recursive query
proxies false
(i.e. host level resources from slave Host Controllers in a query of the Domain Controller; running server resources in a query of a host)
– (boolean, default is ) – whether to include runtime attributes (i.e. those
include-runtime false
whose value does not come from the persistent configuration) in the response.
– (boolean, default is ) – whether to include in the result default values not
include-defaults true
set by users. Many attributes have a default value that will be used in the runtime if the users have not provided an explicit value. If this parameter is false the value for such attributes in the result will be
. If the result will include the default value for such parameters. undefined true
JBoss Community Documentation Page 163 of 660
6.1.11 Standard Operations
Besides the global operations described above, by convention nearly every resource should expose an add operation and a remove operation. Exceptions to this convention are the root resource, and resources that do not store persistent configuration and are created dynamically at runtime (e.g. resources representing the JVM's platform mbeans or resources representing aspects of the running state of a deployment.)