Skip to end of metadata
Go to start of metadata

The JBoss Application Server management API includes a number of operations that apply to every resource.

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:

  • recursive – (boolean, default is false) – whether to include complete information about child resources, recursively.
  • recursive-depth – (int) – The depth to which information about child resources should be included.
  • proxies – (boolean, default is false) – whether to include remote resources in a recursive query (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).
  • include-runtime – (boolean, default is false) – whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. Ignored if recursive is true, as reading runtime attributes may be expensive.
  • include-defaults – (boolean, default is true) – Boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.

The read-attribute operation

Reads the value of an individual attribute. Takes a single, required, parameter:

  • name – (string) – the name of the attribute to read.
  • include-defaults – boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.

The write-attribute operation

Writes the value of an individual attribute, Takes two required parameters:

  • name – (string) – the name of the attribute to write.
  • value – (type depends on the attribute being written) – the new value.

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:

  • operations – (boolean, default is false) – whether to include descriptions of the resource's operations.
  • inherited – (boolean, default is true) – if operations is true, whether to include descriptions of 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.
  • recursive – (boolean, default is false) – whether to include information about child resources, recursively.
  • proxies – (boolean, default is false) – whether to include remote resources in a recursive query (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).
  • recursive-depth – (int) – the depth to which information about child resources should be included.
  • locale – (string) – the locale to get the resource description in. If null, the default locale will be used.

The read-operation-names operation

Returns a list of the names of all the operations the resource supports. Takes no parameters.

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:

  • name – (string) – the name of the operation
  • locale – (string) – the locale to get the operation description in. If null, the default locale will be used.

The read-children-types operation

Returns a list of the types of child resources the resource supports. Takes no parameters.

The read-children-names operation

Returns a list of the names of all child resources of a given type. Takes a single, required, parameter:

  • child-type – (string) – the name of the type

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:

  • child-type – (string) – the name of the type of child resource.
  • recursive – (boolean, default is false) – whether to include complete information about child resources, recursively.
  • recursive depth – (int) – the depth to which information about child resources should be included.
  • proxies – (boolean, default is false) – whether to include remote resources in a recursive query (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).
  • include-runtime – (boolean, default is false) – whether to include runtime attributes (i.e. those whose value does not come from the persistent configuration) in the response. Ignored if recursive is true, as reading runtime attributes may be expensive.
  • include-defaults – (boolean, default is true) – boolean to enable/disable default reading. In case it is set to false only attribute set by user are returned ignoring undefined.

Standard Operations

Besides the global operations described above, by convention each resource (other than the root resource) should expose the following two operations:

The add operation

The operation that creates a new resource must be named add. The operation may take zero or more parameters; what those parameters are depends on the resource being created.

The remove operation

The operation that removes an existing resource must be named remove. The operation should take no parameters.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.