org.jclouds.trmk.vcloud_0_8
Interface TerremarkVCloudClient

All Known Subinterfaces:

TerremarkECloudClient, TerremarkVCloudExpressClient

public interface TerremarkVCloudClient

Provides access to VCloud resources via their REST API.

Author:

Adrian Cole

See Also:

Method Summary

InternetService	addInternetServiceToExistingIp(URI existingIpId, String serviceName, Protocol protocol, int port, AddInternetServiceOptions... options) This call adds an internet service to a known, existing public IP.
Node	addNode(URI internetServiceId, String ipAddress, String name, int port, AddNodeOptions... options) This call adds a node to an existing internet service.
void	cancelTask(URI taskId)
Task	cloneVAppInVDC(URI vDC, URI toClone, String newName, CloneVAppOptions... options)
Node	configureNode(URI nodeId, String name, boolean enabled, String description)
Task	configureVApp(VApp vApp, VAppConfiguration configuration) This call configures the settings of an existing vApp by passing the new configuration.
void	deleteInternetService(URI internetServiceId)
void	deleteKeyPair(URI keyPair)
void	deleteNode(URI nodeId)
void	deletePublicIp(URI ipId)
Task	deleteVApp(URI vAppId)
Task	deployVApp(URI vAppId)
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.
KeyPair	findKeyPairInOrg(URI org, String keyPairName)
Network	findNetworkInOrgVDCNamed(String orgName, String catalogName, String networkName)
Org	findOrgNamed(String orgName)
TasksList	findTasksListInOrgNamed(String orgName, String tasksListName)
VApp	findVAppInOrgVDCNamed(String orgName, String catalogName, String vAppName)
VAppTemplate	findVAppTemplateInOrgCatalogNamed(String orgName, String catalogName, String itemName) returns the vapp template corresponding to a catalog item in the catalog associated with the specified name.
VDC	findVDCInOrgNamed(String orgName, String vdcName) returns the VDC in the organization associated with the specified name.
KeyPair	generateKeyPairInOrg(URI org, String name, boolean makeDefault)
Set<InternetService>	getAllInternetServicesInVDC(URI vDCId)
Catalog	getCatalog(URI catalogId)
CatalogItem	getCatalogItem(URI catalogItem)
CustomizationParameters	getCustomizationOptions(URI customizationOptions)
InternetService	getInternetService(URI internetServiceId)
Set<InternetService>	getInternetServicesOnPublicIp(URI ipId) This call returns information about the internet service on a public IP.
KeyPair	getKeyPair(URI keyPair)
Network	getNetwork(URI network)
Node	getNode(URI nodeId)
Set<Node>	getNodes(URI internetServiceId)
Org	getOrg(URI orgId)
Set<InternetService>	getPublicIp(URI ipId)
Set<PublicIpAddress>	getPublicIpsAssociatedWithVDC(URI vDCId) This call returns a list of public IP addresses.
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)
VApp	getVApp(URI vApp)
VAppTemplate	getVAppTemplate(URI vAppTemplate)
VDC	getVDC(URI catalogItem)
VApp	instantiateVAppTemplateInVDC(URI vDC, URI template, String appName, InstantiateVAppTemplateOptions... options)
Set<KeyPair>	listKeyPairsInOrg(URI org)
Map<String,ReferenceType>	listOrgs()
Task	powerOffVApp(URI vAppId) This call powers off the vApp, as specified in the vApp's ovf:Startup element.
Task	powerOnVApp(URI vAppId) This call powers on the vApp, as specified in the vApp's ovf:Startup element.
Task	resetVApp(URI vAppId) This call resets the vApp.
void	shutdownVApp(URI vAppId) This call shuts down the vApp.
Task	suspendVApp(URI vAppId) This call suspends the vApp.
Task	undeployVApp(URI vAppId)

Method Detail

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

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

getNetwork

Network getNetwork(URI network)

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,
                                  String tasksListName)

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)

listOrgs

Map<String,ReferenceType> listOrgs()

Returns:

a listing of all orgs that the current user has access to.

instantiateVAppTemplateInVDC

VApp instantiateVAppTemplateInVDC(URI vDC,
                                  URI template,
                                  String appName,
                                  InstantiateVAppTemplateOptions... options)

cloneVAppInVDC

Task cloneVAppInVDC(URI vDC,
                    URI toClone,
                    String newName,
                    CloneVAppOptions... options)

getVAppTemplate

VAppTemplate getVAppTemplate(URI vAppTemplate)

findVAppTemplateInOrgCatalogNamed

VAppTemplate findVAppTemplateInOrgCatalogNamed(@Nullable
                                               String orgName,
                                               @Nullable
                                               String catalogName,
                                               String itemName)

returns the vapp template corresponding to a 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

findVAppInOrgVDCNamed

VApp findVAppInOrgVDCNamed(@Nullable
                           String orgName,
                           @Nullable
                           String catalogName,
                           String vAppName)

getVApp

VApp getVApp(URI vApp)

deployVApp

Task deployVApp(URI vAppId)

undeployVApp

Task undeployVApp(URI vAppId)

powerOnVApp

Task powerOnVApp(URI vAppId)

This call powers on the vApp, as specified in the vApp's ovf:Startup element.

powerOffVApp

Task powerOffVApp(URI vAppId)

This call powers off the vApp, as specified in the vApp's ovf:Startup element.

shutdownVApp

void shutdownVApp(URI vAppId)

This call shuts down the vApp.

resetVApp

Task resetVApp(URI vAppId)

This call resets the vApp.

suspendVApp

Task suspendVApp(URI vAppId)

This call suspends the vApp.

deleteVApp

Task deleteVApp(URI vAppId)

getVDC

VDC getVDC(URI catalogItem)

getOrg

Org getOrg(URI orgId)

findOrgNamed

Org findOrgNamed(String orgName)

getCustomizationOptions

CustomizationParameters getCustomizationOptions(URI customizationOptions)

getPublicIpsAssociatedWithVDC

Set<PublicIpAddress> getPublicIpsAssociatedWithVDC(URI vDCId)

This call returns a list of public IP addresses.

deletePublicIp

void deletePublicIp(URI ipId)

addInternetServiceToExistingIp

InternetService addInternetServiceToExistingIp(URI existingIpId,
                                               String serviceName,
                                               Protocol protocol,
                                               int port,
                                               AddInternetServiceOptions... options)

This call adds an internet service to a known, existing public IP. This call is identical to Add Internet Service except you specify the public IP in the request.

deleteInternetService

void deleteInternetService(URI internetServiceId)

getInternetService

InternetService getInternetService(URI internetServiceId)

getAllInternetServicesInVDC

Set<InternetService> getAllInternetServicesInVDC(URI vDCId)

getInternetServicesOnPublicIp

Set<InternetService> getInternetServicesOnPublicIp(URI ipId)

This call returns information about the internet service on a public IP.

getPublicIp

Set<InternetService> getPublicIp(URI ipId)

addNode

Node addNode(URI internetServiceId,
             String ipAddress,
             String name,
             int port,
             AddNodeOptions... options)

This call adds a node to an existing internet service.

Every vDC is assigned a network of 60 IP addresses that can be used as nodes. Each node can associated with multiple internet service. You can get a list of the available IP addresses by calling Get IP Addresses for a Network.

Parameters:

internetServiceId -

ipAddress -

name -

port -

options -

Returns:

getNode

Node getNode(URI nodeId)

configureNode

Node configureNode(URI nodeId,
                   String name,
                   boolean enabled,
                   @Nullable
                   String description)

deleteNode

void deleteNode(URI nodeId)

getNodes

Set<Node> getNodes(URI internetServiceId)

configureVApp

Task configureVApp(VApp vApp,
                   VAppConfiguration configuration)

This call configures the settings of an existing vApp by passing the new configuration. The existing vApp must be in a powered off state (status = 2).

You can change the following items for a vApp.

1. vApp name Number of virtual CPUs
2. Amount of virtual memory
3. Add a virtual disk
4. Delete a virtual disk

You can make more than one change in a single request. For example, you can increase the number of virtual CPUs and the amount of virtual memory in the same request.

Parameters:

VApp - vApp to change in power state off

configuration - (s) to change

Returns:

task of configuration change

listKeyPairsInOrg

Set<KeyPair> listKeyPairsInOrg(URI org)

generateKeyPairInOrg

KeyPair generateKeyPairInOrg(URI org,
                             String name,
                             boolean makeDefault)

Throws:

IllegalStateException - if a key of the same name already exists

findKeyPairInOrg

KeyPair findKeyPairInOrg(URI org,
                         String keyPairName)

getKeyPair

KeyPair getKeyPair(URI keyPair)

deleteKeyPair

void deleteKeyPair(URI keyPair)