com.tibco.amf.admin.api.amx.node

Interface NodeService

public interface NodeService

Service for creating, retrieving and maintaining nodes. Includes managing substitution variables on nodes.

Method Summary

Methods

Modifier and Type	Method and Description
NodeFeatureDesc[]	getAllFeatures(EntityIdentifier node) Return all the features with flags to indicate if feature is enabled and provisioned in the given node.
PaginatedNodeSummaryList	getNodesInEnvironment(EntityIdentifier envIdentifier, PaginationInput input) Retrieve a list of AMX nodes in the specified AMX environment, in a paginated form (returns a specific page of results).

Method Detail

getNodesInEnvironment

PaginatedNodeSummaryList getNodesInEnvironment(EntityIdentifier envIdentifier,
                                             PaginationInput input)
                                               throws AdminException

Retrieve a list of AMX nodes in the specified AMX environment, in a paginated form (returns a specific page of results). Specifying -1 value for PaginationInput.RequestedPage will disable pagination and return all nodes in the environment.

Parameters:

envIdentifier - environment id

input - pagination parameters that control what items are returned

Returns:

Paginated list of node summary, suitable for display in a master list of nodes.

Throws:

AdminException

getAllFeatures

NodeFeatureDesc[] getAllFeatures(EntityIdentifier node)
                                 throws AdminException

Return all the features with flags to indicate if feature is enabled and provisioned in the given node.

Parameters:

node - node id

Returns:

array of feature documents

Throws:

AdminException