org.jclouds.abiquo.domain.cloud

Class VirtualAppliance

java.lang.Object

org.jclouds.abiquo.domain.DomainWrapper<com.abiquo.server.core.cloud.VirtualApplianceDto>

org.jclouds.abiquo.domain.cloud.VirtualAppliance

public class VirtualAppliance
extends DomainWrapper<com.abiquo.server.core.cloud.VirtualApplianceDto>

Represents a virtual appliance.

A virtual appliance is a logic container for virtual machines that together make an appliance.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

http://community.abiquo.com/display/ABI20/Virtual+Appliance+Resource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualAppliance.Builder

Field Summary

Fields inherited from class org.jclouds.abiquo.domain.DomainWrapper

context, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VirtualAppliance(RestContext<AbiquoApi,AbiquoAsyncApi> context, com.abiquo.server.core.cloud.VirtualApplianceDto target) Constructor to be used only by the builder.

Method Summary

Methods

Modifier and Type	Method and Description
static VirtualAppliance.Builder	builder(RestContext<AbiquoApi,AbiquoAsyncApi> context, VirtualDatacenter virtualDatacenter)
void	delete() Deletes the virtual appliance.
AsyncTask[]	deploy() Deploys the virtual appliance.
AsyncTask[]	deploy(boolean forceEnterpriseSoftLimits) Deploys the virtual appliance.
VirtualMachine	findVirtualMachine(com.google.common.base.Predicate<VirtualMachine> filter) Gets a single virtual machine in the virtual appliance matching the given filter.
Enterprise	getEnterprise() Gets the enterprise where the virtual appliance belongs to.
int	getError()
int	getHighDisponibility()
Integer	getId()
String	getName()
int	getPublicApp()
com.abiquo.server.core.cloud.VirtualApplianceState	getState() Gets the current state of the virtual appliance.
VirtualDatacenter	getVirtualDatacenter() Gets the virtual datacenter where the virtual appliance belongs to.
VirtualMachine	getVirtualMachine(Integer id) Gets a concrete virtual machine in the virtual appliance.
List<VirtualMachine>	listVirtualMachines() Gets the list of virtual machines in the virtual appliance.
List<VirtualMachine>	listVirtualMachines(com.google.common.base.Predicate<VirtualMachine> filter) Gets the list of virtual machines in the virtual appliance matching the given filter.
List<VirtualMachine>	listVirtualMachines(VirtualMachineOptions options) Gets the list of virtual machines in the virtual appliance.
void	save() Creates the virtual appliance in the selected virtual datacenter.
void	setHighDisponibility(int highDisponibility)
void	setName(String name)
void	setPublicApp(int publicApp)
String	toString()
AsyncTask[]	undeploy() Undeploys the virtual appliance.
AsyncTask[]	undeploy(boolean forceUndeploy) Undeploys the virtual appliance.
void	update() Updates the virtual appliance information when some of its properties have changed.

Methods inherited from class org.jclouds.abiquo.domain.DomainWrapper

getParentId, getTask, getTasks, getURI, join, unwrap, unwrap, updateLink, wrap, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VirtualAppliance

protected VirtualAppliance(RestContext<AbiquoApi,AbiquoAsyncApi> context,
                com.abiquo.server.core.cloud.VirtualApplianceDto target)

Constructor to be used only by the builder.

Method Detail

delete

public void delete()

Deletes the virtual appliance.

save

public void save()

Creates the virtual appliance in the selected virtual datacenter.

update

public void update()

Updates the virtual appliance information when some of its properties have changed.

getVirtualDatacenter

public VirtualDatacenter getVirtualDatacenter()

Gets the virtual datacenter where the virtual appliance belongs to.

See Also:

http://community.abiquo.com/display/ABI20/Virtual+Datacenter+Resource# VirtualDatacenterResource-RetrieveaVirtualDatacenter

getEnterprise

public Enterprise getEnterprise()

Gets the enterprise where the virtual appliance belongs to.

Returns:

The enterprise where the virtual appliance belongs to.

See Also:

http://community.abiquo.com/display/ABI20/Enterprise+Resource#EnterpriseResource- RetrieveaEnterprise

getState

public com.abiquo.server.core.cloud.VirtualApplianceState getState()

Gets the current state of the virtual appliance.

Returns:

The current state of the virtual appliance.

listVirtualMachines

public List<VirtualMachine> listVirtualMachines()

Gets the list of virtual machines in the virtual appliance.

Returns:

The list of virtual machines in the virtual appliance.

See Also:

http://community.abiquo.com/display/ABI18/Virtual+Machine+Resource#VirtualMachineResource -RetrievethelistofVirtualMachines.

listVirtualMachines

public List<VirtualMachine> listVirtualMachines(VirtualMachineOptions options)

Gets the list of virtual machines in the virtual appliance.

Returns:

The list of virtual machines in the virtual appliance.

See Also:

http://community.abiquo.com/display/ABI18/Virtual+Machine+Resource#VirtualMachineResource -RetrievethelistofVirtualMachines.

listVirtualMachines

public List<VirtualMachine> listVirtualMachines(com.google.common.base.Predicate<VirtualMachine> filter)

Gets the list of virtual machines in the virtual appliance matching the given filter.

Parameters:

filter - The filter to apply.

Returns:

The list of virtual machines in the virtual appliance matching the given filter.

findVirtualMachine

public VirtualMachine findVirtualMachine(com.google.common.base.Predicate<VirtualMachine> filter)

Gets a single virtual machine in the virtual appliance matching the given filter.

Parameters:

filter - The filter to apply.

Returns:

The virtual machine or null if none matched the given filter.

getVirtualMachine

public VirtualMachine getVirtualMachine(Integer id)

Gets a concrete virtual machine in the virtual appliance.

Parameters:

id - The id of the virtual machine.

Returns:

The requested virtual machine.

deploy

public AsyncTask[] deploy()

Deploys the virtual appliance.

This method will start the deployment of all the virtual machines in the virtual appliance, and will return an AsyncTask reference for each deployment operation. The deployment will finish when all individual tasks finish.

Returns:

The list of tasks corresponding to the deploy process of each virtual machine in the appliance.

deploy

public AsyncTask[] deploy(boolean forceEnterpriseSoftLimits)

Deploys the virtual appliance.

This method will start the deployment of all the virtual machines in the virtual appliance, and will return an AsyncTask reference for each deploy operation. The deployment will finish when all individual tasks finish.

Parameters:

forceEnterpriseSoftLimits - Boolean indicating if the deployment must be executed even if the enterprise soft limits are reached.

Returns:

The list of tasks corresponding to the deploy process of each virtual machine in the appliance.

undeploy

public AsyncTask[] undeploy()

Undeploys the virtual appliance.

This method will start the undeploy of all the virtual machines in the virtual appliance, and will return an AsyncTask reference for each undeploy operation. The undeploy will finish when all individual tasks finish.

Returns:

The list of tasks corresponding to the undeploy process of each virtual machine in the appliance.

undeploy

public AsyncTask[] undeploy(boolean forceUndeploy)

Undeploys the virtual appliance.

This method will start the undeploy of all the virtual machines in the virtual appliance, and will return an AsyncTask reference for each undeploy operation. The undeploy will finish when all individual tasks finish.

Parameters:

forceUndeploy - Boolean flag to force the undeploy even if the virtual appliance contains imported virtual machines.

Returns:

The list of tasks corresponding to the undeploy process of each virtual machine in the appliance.

builder

public static VirtualAppliance.Builder builder(RestContext<AbiquoApi,AbiquoAsyncApi> context,
                               VirtualDatacenter virtualDatacenter)

getError

public int getError()

getHighDisponibility

public int getHighDisponibility()

getId

public Integer getId()

getName

public String getName()

getPublicApp

public int getPublicApp()

setHighDisponibility

public void setHighDisponibility(int highDisponibility)

setName

public void setName(String name)

setPublicApp

public void setPublicApp(int publicApp)

toString

public String toString()

Overrides:

toString in class Object