org.jclouds.vcloud
Interface CommonVCloudClient

public interface CommonVCloudClient

Provides access to VCloud resources via their REST API.

Author:

Adrian Cole

See Also:

Method Summary

void	cancelTask(URI taskId)
Catalog	findCatalogInOrgNamed(String orgName, String catalogName) returns the catalog in the organization associated with the specified name.
CatalogItem	findCatalogItemInOrgCatalogNamed(String orgName, String catalogName, String itemName) returns the catalog item in the catalog associated with the specified name.
OrgNetwork	findNetworkInOrgVDCNamed(String orgName, String catalogName, String networkName)
Org	findOrgNamed(String name) This call returns a list of all vCloud Data Centers (vdcs), catalogs, and task lists within the organization.
TasksList	findTasksListInOrgNamed(String orgName)
VDC	findVDCInOrgNamed(String orgName, String vdcName) returns the VDC in the organization associated with the specified name.
Catalog	getCatalog(URI catalogId)
CatalogItem	getCatalogItem(URI catalogItem)
OrgNetwork	getNetwork(URI network)
Org	getOrg(URI orgId)
Task	getTask(URI taskId) Whenever the result of a request cannot be returned immediately, the server creates a Task object and includes it in the response, as a member of the Tasks container in the response body.
TasksList	getTasksList(URI tasksListId)
VDC	getVDC(URI vdc)

Method Detail

getOrg

Org getOrg(URI orgId)

findOrgNamed

Org findOrgNamed(@Nullable
                 String name)

This call returns a list of all vCloud Data Centers (vdcs), catalogs, and task lists within the organization.

Parameters:

name - organization name, or null for the default

Throws:

NoSuchElementException - if you specified an org name that isn't present

getCatalog

Catalog getCatalog(URI catalogId)

findCatalogInOrgNamed

Catalog findCatalogInOrgNamed(@Nullable
                              String orgName,
                              @Nullable
                              String catalogName)

returns the catalog in the organization associated with the specified name. Note that both parameters can be null to choose default.

Parameters:

orgName - organization name, or null for the default

catalogName - catalog name, or null for the default

Throws:

NoSuchElementException - if you specified an org or catalog name that isn't present

getCatalogItem

CatalogItem getCatalogItem(URI catalogItem)

findCatalogItemInOrgCatalogNamed

CatalogItem findCatalogItemInOrgCatalogNamed(@Nullable
                                             String orgName,
                                             @Nullable
                                             String catalogName,
                                             String itemName)

returns the catalog item in the catalog associated with the specified name. Note that the org and catalog parameters can be null to choose default.

Parameters:

orgName - organization name, or null for the default

catalogName - catalog name, or null for the default

itemName - item you wish to lookup

Throws:

NoSuchElementException - if you specified an org, catalog, or catalog item name that isn't present

findNetworkInOrgVDCNamed

OrgNetwork findNetworkInOrgVDCNamed(@Nullable
                                    String orgName,
                                    @Nullable
                                    String catalogName,
                                    String networkName)

getNetwork

OrgNetwork getNetwork(URI network)

getVDC

VDC getVDC(URI vdc)

findVDCInOrgNamed

VDC findVDCInOrgNamed(String orgName,
                      String vdcName)

returns the VDC in the organization associated with the specified name. Note that both parameters can be null to choose default.

Parameters:

orgName - organization name, or null for the default

vdcName - catalog name, or null for the default

Throws:

NoSuchElementException - if you specified an org or vdc name that isn't present

getTasksList

TasksList getTasksList(URI tasksListId)

findTasksListInOrgNamed

TasksList findTasksListInOrgNamed(String orgName)

getTask

Task getTask(URI taskId)

Whenever the result of a request cannot be returned immediately, the server creates a Task object and includes it in the response, as a member of the Tasks container in the response body. Each Task has an href value, which is a URL that the client can use to retrieve the Task element alone, without the rest of the response in which it was contained. All information about the task is included in the Task element when it is returned in the response’s Tasks container, so a client does not need to make an additional request to the Task URL unless it wants to follow the progress of a task that was incomplete.

cancelTask

void cancelTask(URI taskId)