Package | Description |
---|---|
com.tibco.amf.admin.api.amx.application |
The
application package defines the service and data objects for managing applications. |
com.tibco.amf.admin.api.amx.enterprise |
The
enterprise package defines the service and data objects for managing global configuration that is common across all AMX environments. |
com.tibco.amf.admin.api.amx.env |
The
env package defines the service and data objects for managing Environments. |
com.tibco.amf.admin.api.amx.host |
The
host package defines the service and data objects for managing Hosts. |
com.tibco.amf.admin.api.amx.node |
The
node package defines the service and data objects for managing Nodes. |
com.tibco.amf.admin.api.amx.resinstance |
The
resinstance package defines the service and data objects for managing Resource Instances. |
com.tibco.amf.admin.api.core.exception |
The
core.exception package defines the exception types that the ActiveMatrix Administrator APIs can throw. |
com.tibco.amf.admin.api.core.types |
The
core.type package defines a number of common data objects which are used throughout the API |
Modifier and Type | Method and Description |
---|---|
EntityIdentifier[] |
ApplicationService.getApplicationsMappedToNode(EntityIdentifier nodeId)
Retrieves list of applications whose components are distributed (mapped) to the specified node.
|
ApplicationStructureDesc[] |
ApplicationService.getApplicationStructureDetails(EntityIdentifier[] applicationId,
boolean deployedConfiguration)
Retrieves the structure of the applications identified by the array of
application IDs passed as argument.
|
ApplicationSummaryDesc |
ApplicationService.getApplicationSummaryById(EntityIdentifier appId)
Retrieve summary information for the specified AMX Application.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
EnterpriseService.getAdminVersion(int wsiCompliance)
Returns the version of the TIBCO ActiveMatrix Administrator
|
Modifier and Type | Method and Description |
---|---|
EnvDesc[] |
EnvService.getAllEnv()
Retrieve the list of all AMX Environments in the enterprise.
|
EnvTreeDesc[] |
EnvService.getAllEnvDescs(FilterDesc filter)
Retrieve a hierarchical list of all AMX Environments for display in a tree widget.
|
PlatformDesc[] |
EnvService.getEnabledHostsForNodeCreation(EntityIdentifier envid)
Returns hosts which have node creation permission and are currently enabled for an environment
|
EnvTreeDesc[] |
EnvService.getSpecifiedEnvDescs(FilterDesc filter,
EntityIdentifier[] envIds)
Similar to
EnvService.getAllEnvDescs(FilterDesc) , but this operation takes an input of specific environments to return data for. |
Modifier and Type | Method and Description |
---|---|
PlatformDesc[] |
HostService.getHosts()
Retrieve all bound hosts
|
Modifier and Type | Method and Description |
---|---|
NodeFeatureDesc[] |
NodeService.getAllFeatures(EntityIdentifier node)
Return all the features with flags to indicate if feature is enabled and provisioned in the given node.
|
PaginatedNodeSummaryList |
NodeService.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).
|
Modifier and Type | Method and Description |
---|---|
ResourceInstanceSummaryDesc[] |
ResourceInstanceService.getAllInstancesForObject(EntityDesc ownerId,
java.lang.String riType)
Gets the resource instance tree description collection for a given entity descriptor and a given Resource Instance Type.
|
ResourceInstanceSummaryDesc[] |
ResourceInstanceService.getInstancesOnHost(EntityIdentifier platformId)
Get all resource instances on a host.
|
Modifier and Type | Class and Description |
---|---|
class |
DuplicateEntityException
Common error that user is trying to add an entity with the same name as an existing one for a type that requires unique names.
|
class |
EntityNotFoundException
Common exception that the specified entity (based on id) does not currently exist in the Admin model.
|
class |
IllegalNullArgumentException
Common exception that a null value was specified for an argument that does not support nulls.
|
class |
NoPermissionException |
Modifier and Type | Method and Description |
---|---|
static ResultMessage |
ResultMessage.createErrorMsg(java.lang.String summary,
EntityIdentifier id,
AdminException exception) |
Constructor and Description |
---|
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail,
EntityIdentifier id,
AdminException exception) |