org.jclouds.vcloud.terremark
Interface TerremarkVCloudClient

All Superinterfaces:

CommonVCloudClient, VCloudExpressClient

All Known Subinterfaces:

TerremarkECloudClient, TerremarkVCloudExpressClient

public interface TerremarkVCloudClient
extends VCloudExpressClient

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.
Node	configureNode(URI nodeId, String name, boolean enabled, String description)
Task	configureVApp(VCloudExpressVApp 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)
TerremarkCatalogItem	findCatalogItemInOrgCatalogNamed(String orgName, String catalogName, String itemName)
KeyPair	findKeyPairInOrg(URI org, String keyPairName)
TerremarkOrg	findOrgNamed(String orgName)
KeyPair	generateKeyPairInOrg(URI org, String name, boolean makeDefault)
Set<InternetService>	getAllInternetServicesInVDC(URI vDCId)
TerremarkCatalogItem	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)
Node	getNode(URI nodeId)
Set<Node>	getNodes(URI internetServiceId)
TerremarkOrg	getOrg(URI orgId)
Set<InternetService>	getPublicIp(URI ipId)
Set<PublicIpAddress>	getPublicIpsAssociatedWithVDC(URI vDCId) This call returns a list of public IP addresses.
TerremarkVDC	getVDC(URI catalogItem)
Set<KeyPair>	listKeyPairsInOrg(URI org)

Methods inherited from interface org.jclouds.vcloud.VCloudExpressClient

cloneVAppInVDC, deleteVApp, deployVApp, findVAppInOrgVDCNamed, findVAppTemplateInOrgCatalogNamed, getVApp, getVAppTemplate, instantiateVAppTemplateInVDC, powerOffVApp, powerOnVApp, resetVApp, shutdownVApp, suspendVApp, undeployVApp

Methods inherited from interface org.jclouds.vcloud.CommonVCloudClient

cancelTask, findCatalogInOrgNamed, findNetworkInOrgVDCNamed, findTasksListInOrgNamed, findVDCInOrgNamed, getCatalog, getNetwork, getTask, getTasksList

Method Detail

getCatalogItem

TerremarkCatalogItem getCatalogItem(URI catalogItem)

Specified by:

getCatalogItem in interface CommonVCloudClient

getVDC

TerremarkVDC getVDC(URI catalogItem)

Specified by:

getVDC in interface CommonVCloudClient

findCatalogItemInOrgCatalogNamed

TerremarkCatalogItem findCatalogItemInOrgCatalogNamed(String orgName,
                                                      String catalogName,
                                                      String itemName)

Specified by:

findCatalogItemInOrgCatalogNamed in interface CommonVCloudClient

getOrg

TerremarkOrg getOrg(URI orgId)

Specified by:

getOrg in interface CommonVCloudClient

findOrgNamed

TerremarkOrg findOrgNamed(String orgName)

Specified by:

findOrgNamed in interface CommonVCloudClient

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(VCloudExpressVApp 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:

VCloudExpressVApp - 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)