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.endpoint |
The
endpoint package defines the service and data objects for creating and managing services and references. |
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.amx.restemplate |
The
restemplate package defines the service and data objects for managing Resource Templates. |
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 |
com.tibco.amf.admin.api.reference |
The
api.reference package defines data objects with basic information for an AMX object. |
Modifier and Type | Class and Description |
---|---|
class |
ApplicationStructureDesc
POJO for details of the structure of the application
The EntityIdentifier base class represents the identity of the application. |
class |
ApplicationSummaryDesc
An object holding summary information for an application suitable for display in the details section of the UI.
|
class |
AppplicationMinDesc
A data object containing limited details of an application
The EntityIdentifier base type represents the identity of the application. |
class |
ComponentTreeIdentifier
POJO for summary of a component
Fields are: componentPath - path of the component inside the composite implementation - Implementation type for the component components - List of child components if the component is of Composite type implementation |
class |
PropertyDesc
Describes a property object.
|
Modifier and Type | Method and Description |
---|---|
EntityIdentifier[] |
ApplicationService.getApplicationsMappedToNode(EntityIdentifier nodeId)
Retrieves list of applications whose components are distributed (mapped) to the specified node.
|
EntityIdentifier |
ApplicationSummaryDesc.getEnvironment() |
EntityIdentifier |
ApplicationSummaryDesc.getFolder() |
EntityIdentifier[] |
ApplicationStructureDesc.getLogicalNodes() |
EntityIdentifier |
PropertyDesc.getSource() |
EntityIdentifier |
ApplicationSummaryDesc.getTargetApp() |
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.
|
void |
ApplicationSummaryDesc.setEnvironment(EntityIdentifier environment) |
void |
ApplicationSummaryDesc.setFolder(EntityIdentifier folder) |
void |
ApplicationStructureDesc.setLogicalNodes(EntityIdentifier[] logicalNodes) |
void |
PropertyDesc.setSource(EntityIdentifier source) |
void |
ApplicationSummaryDesc.setTargetApp(EntityIdentifier targetApp) |
Constructor and Description |
---|
ApplicationSummaryDesc(long id,
java.lang.String name,
java.lang.String contact,
java.lang.String description,
java.lang.String url,
java.lang.String lastDeployedBy,
java.util.Date lastDeployedOn,
java.lang.String modifiedBy,
java.util.Date modifiedOn,
java.lang.String appTemplateName,
java.lang.String appTemplateVersion,
long appFolderId,
java.lang.String appFolderName,
java.lang.String distributionPolicy,
EntityIdentifier targetApp) |
Modifier and Type | Class and Description |
---|---|
class |
BindingConfigSummaryDesc
Fields are: name - binding name id - binding internal identifier type - type of binding configuration. |
class |
ReferenceSummaryDesc
Summary description of a reference
|
class |
ServiceSummaryDesc
name and id of service along with an array of bindings associated with the service
|
Modifier and Type | Method and Description |
---|---|
EntityIdentifier |
ReferenceSummaryDesc.getTargetServiceBinding() |
Modifier and Type | Method and Description |
---|---|
void |
ReferenceSummaryDesc.setTargetServiceBinding(EntityIdentifier targetServiceBinding) |
Modifier and Type | Class and Description |
---|---|
class |
EnvDesc
Description of an environment
name - name of the environment
id - internal identifier
description - user entered description
modifiedBy - user who last edited the environment
lastModified - date when the environment was last edited
contact - optional name of person responsible for this environment
|
class |
EnvTreeDesc
Retrieves a tree of information about an environment for display by a UI
Contains: AdminEntityDesc +
folders - array of application folders with their child applications
nodes - array of nodes with the applications for which they contain fragments
promotedServices - array of services promoted to the environment level
promotedReferences - array of references promoted to the environment level
|
Modifier and Type | Method and Description |
---|---|
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 | Class and Description |
---|---|
class |
PlatformDesc
Describes a cluster or singleton host
|
Modifier and Type | Class and Description |
---|---|
class |
NodeSummaryDesc
POJO holding the summary data for a node.
|
Modifier and Type | Method and Description |
---|---|
EntityIdentifier |
NodeSummaryDesc.getEnvironment() |
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).
|
void |
NodeSummaryDesc.setEnvironment(EntityIdentifier environment) |
Modifier and Type | Class and Description |
---|---|
class |
ResourceInstanceSummaryDesc
Contains details of each resource instance.
|
Modifier and Type | Method and Description |
---|---|
EntityIdentifier |
ResourceInstanceSummaryDesc.getHostId() |
EntityIdentifier |
ResourceInstanceSummaryDesc.getNodeId()
The node id is returned only if the resource is present on node / Tibco Host.
|
EntityIdentifier |
ResourceInstanceSummaryDesc.getResourceTemplate() |
Modifier and Type | Method and Description |
---|---|
ResourceInstanceSummaryDesc[] |
ResourceInstanceService.getInstancesOnHost(EntityIdentifier platformId)
Get all resource instances on a host.
|
void |
ResourceInstanceSummaryDesc.setHostId(EntityIdentifier hostId)
Set the host id on which the resource is present.
|
void |
ResourceInstanceSummaryDesc.setNodeId(EntityIdentifier nodeId)
Set the node id on which the resource is present.
|
void |
ResourceInstanceSummaryDesc.setResourceTemplate(EntityIdentifier resourceTemplate) |
Modifier and Type | Class and Description |
---|---|
class |
Scope
Scope represents the parent scope for a resource template.
|
Constructor and Description |
---|
Scope(EntityIdentifier id,
java.lang.String type) |
Constructor and Description |
---|
EntityNotFoundException(EntityIdentifier id,
java.lang.String type) |
Modifier and Type | Class and Description |
---|---|
class |
ChildIdentifierList
A result that includes a list of child identifiers.
|
class |
DistributableChildIdentifierList |
class |
EntityDesc
Adds a type to the standard name & id in EntityIdentifier.
|
Modifier and Type | Method and Description |
---|---|
EntityIdentifier[] |
ChildIdentifierList.getChildren() |
EntityIdentifier |
ResultMessage.getId() |
Modifier and Type | Method and Description |
---|---|
static ResultMessage |
ResultMessage.createErrorMsg(java.lang.String summary,
EntityIdentifier id) |
static ResultMessage |
ResultMessage.createErrorMsg(java.lang.String summary,
EntityIdentifier id,
AdminException exception) |
static ResultMessage |
ResultMessage.createErrorMsg(java.lang.String summary,
EntityIdentifier id,
java.lang.Throwable exception) |
static ResultMessage |
ResultMessage.createErrorMsg(java.lang.Throwable e,
EntityIdentifier id) |
static ResultMessage |
ResultMessage.createSuccessMsg(java.lang.String summary,
EntityIdentifier id) |
static ResultMessage |
ResultMessage.createWarnMsg(java.lang.String summary,
EntityIdentifier id) |
void |
ChildIdentifierList.setChildren(EntityIdentifier[] children) |
void |
ResultMessage.setId(EntityIdentifier id) |
Constructor and Description |
---|
EntityDesc(java.lang.String type,
EntityIdentifier id) |
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail,
EntityIdentifier id,
AdminException exception) |
ResultMessage(java.lang.String messageType,
java.lang.String summary,
java.lang.String detail,
EntityIdentifier id,
java.lang.Throwable exception) |
Modifier and Type | Class and Description |
---|---|
class |
AdminEntityDesc
A data object with basic information about an AMX object that includes:
name - name of the object
id - internal identifier
description - user entered description
modifiedBy - user who last edited the object
lastModified - date when the object was last edited
contact - optional name of person responsible for this object
|