org.jclouds.abiquo.domain.cloud

Class VirtualMachine

java.lang.Object

org.jclouds.abiquo.domain.DomainWrapper<T>

org.jclouds.abiquo.domain.DomainWithTasksWrapper<com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto>

org.jclouds.abiquo.domain.cloud.VirtualMachine

public class VirtualMachine
extends DomainWithTasksWrapper<com.abiquo.server.core.cloud.VirtualMachineWithNodeExtendedDto>

Adds high level functionality to VirtualMachineWithNodeExtendedDto.

Author:

Ignasi Barrera, Francesc Montserrat

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VirtualMachine.Builder

Field Summary

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

context, target

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	attachDvd()
AsyncTask	attachHardDisks(HardDisk... hardDisks)
AsyncTask	attachVolumes(Volume... volumes)
static VirtualMachine.Builder	builder(RestContext<AbiquoApi,AbiquoAsyncApi> context, VirtualAppliance virtualAppliance, VirtualMachineTemplate template)
AsyncTask	changeState(com.abiquo.server.core.cloud.VirtualMachineState state) Change the state of the virtual machine.
void	delete() Delete the virtual machine.
AsyncTask	deploy()
AsyncTask	deploy(boolean forceEnterpriseSoftLimits)
AsyncTask	detachAllHardDisks()
AsyncTask	detachAllVolumes()
void	detachDvd()
AsyncTask	detachHardDisks(HardDisk... hardDisks)
AsyncTask	detachVolumes(Volume... volumes)
HardDisk	findAttachedHardDisk(com.google.common.base.Predicate<HardDisk> filter)
Ip<?,?>	findAttachedNic(com.google.common.base.Predicate<Ip<?,?>> filter)
Volume	findAttachedVolume(com.google.common.base.Predicate<Volume> filter)
int	getCpu()
String	getDescription()
Enterprise	getEnterprise() Retrieve the enterprise of this virtual machine.
long	getHdInBytes()
Integer	getId()
int	getIdState()
int	getIdType()
String	getInternalName()
String	getKeymap()
String	getNameLabel()
String	getOwnerName()
String	getPassword()
int	getRam()
com.abiquo.server.core.cloud.VirtualMachineState	getState() Retrieve the state of the virtual machine.
VirtualMachineTemplate	getTemplate() Retrieve the template of this virtual machine.
String	getUuid()
VirtualAppliance	getVirtualAppliance() Retrieve the virtual appliance where this virtual machine is.
VirtualDatacenter	getVirtualDatacenter() Retrieve the virtual datacenter where this virtual machine is.
String	getVncAddress()
int	getVncPort()
boolean	hasDvd()
boolean	isPersistent() Checks if the virtual machine is persistent.
List<HardDisk>	listAttachedHardDisks()
List<HardDisk>	listAttachedHardDisks(com.google.common.base.Predicate<HardDisk> filter)
List<Ip<?,?>>	listAttachedNics()
List<Ip<?,?>>	listAttachedNics(com.google.common.base.Predicate<Ip<?,?>> filter)
List<Volume>	listAttachedVolumes()
List<Volume>	listAttachedVolumes(com.google.common.base.Predicate<Volume> filter)
AsyncTask	reboot() Reboot a virtual machine.
void	refresh()
void	save() Create a new virtual machine in Abiquo.
void	setCpu(int cpu)
void	setDescription(String description)
void	setGatewayNetwork(Network<?> network)
AsyncTask	setHardDisks(HardDisk... hardDisks)
void	setKeymap(String keymap)
void	setNameLabel(String nameLabel)
AsyncTask	setNics(List<Ip<?,?>> ips)
AsyncTask	setNics(List<Ip<?,?>> ips, List<UnmanagedNetwork> unmanagetNetworks)
AsyncTask	setNics(Network<?> gatewayNetwork, List<Ip<?,?>> ips)
AsyncTask	setNics(Network<?> gatewayNetwork, List<Ip<?,?>> ips, List<UnmanagedNetwork> unmanagetNetworks)
void	setPassword(String password)
void	setRam(int ram)
AsyncTask	setVolumes(Boolean forceSoftLimits, Volume... volumes)
AsyncTask	setVolumes(Volume... volumes)
String	toString()
AsyncTask	undeploy()
AsyncTask	undeploy(boolean forceUndeploy)
AsyncTask	update() Update virtual machine information in the server with the data from this virtual machine.
AsyncTask	update(boolean force) Update virtual machine information in the server with the data from this virtual machine.

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

findTask, listTasks, listTasks

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

VirtualMachine

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

Constructor to be used only by the builder.

Method Detail

delete

public void delete()

Delete the virtual machine.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource#VirtualMachineResource -Deleteavirtualmachine

save

public void save()

Create a new virtual machine in Abiquo.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource# VirtualMachineResource-Createavirtualmachine

update

public AsyncTask update()

Update virtual machine information in the server with the data from this virtual machine. This is an asynchronous call. This method returns a AsyncTask object that keeps track of the task completion. Please refer to the documentation for details.

Returns:

The task reference or null if the operation completed synchronously.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource# VirtualMachineResource-Modifyavirtualmachine, https://github.com/abiquo/jclouds-abiquo/wiki/Asynchronous-monitor-example

update

public AsyncTask update(boolean force)

Update virtual machine information in the server with the data from this virtual machine. This is an asynchronous call. This method returns a AsyncTask object that keeps track of the task completion. Please refer to the documentation for details.

Parameters:

force - Force update.

Returns:

The task reference or null if the operation completed synchronously.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource# VirtualMachineResource-Modifyavirtualmachine, https://github.com/abiquo/jclouds-abiquo/wiki/Asynchronous-monitor-example

changeState

public AsyncTask changeState(com.abiquo.server.core.cloud.VirtualMachineState state)

Change the state of the virtual machine. This is an asynchronous call. This method returns a AsyncTask object that keeps track of the task completion. Please refer to the documentation for details.

Parameters:

state - The new state of the virtual machine.

Returns:

The task reference or null if the operation completed synchronously.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource# VirtualMachineResource-Changethestateofavirtualmachine, https://github.com/abiquo/jclouds-abiquo/wiki/Asynchronous-monitor-example

getState

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

Retrieve the state of the virtual machine.

Returns:

Current state of the virtual machine.

See Also:

http://community.abiquo.com/display/ABI20/VirtualMachineResource# VirtualMachineResource-Retrievethestateofthevirtualmachine

refresh

public void refresh()

getVirtualAppliance

public VirtualAppliance getVirtualAppliance()

Retrieve the virtual appliance where this virtual machine is.

Returns:

The virtual appliance where this virtual machine is.

See Also:

http://community.abiquo.com/display/ABI20/VirtualApplianceResource# VirtualApplianceResource-Retrieveavirtualappliance

getVirtualDatacenter

public VirtualDatacenter getVirtualDatacenter()

Retrieve the virtual datacenter where this virtual machine is.

Returns:

The virtual datacenter where this virtual machine is.

See Also:

http://community.abiquo.com/display/ABI20/VirtualDatacenterResource# VirtualDatacenterResource-Retireveavirtualdatacenter

getEnterprise

public Enterprise getEnterprise()

Retrieve the enterprise of this virtual machine.

Returns:

Enterprise of this virtual machine.

See Also:

http://community.abiquo.com/display/ABI20/EnterpriseResource#EnterpriseResource- RetrieveanEnterprise

getTemplate

public VirtualMachineTemplate getTemplate()

Retrieve the template of this virtual machine.

Returns:

Template of this virtual machine.

listAttachedHardDisks

public List<HardDisk> listAttachedHardDisks()

listAttachedHardDisks

public List<HardDisk> listAttachedHardDisks(com.google.common.base.Predicate<HardDisk> filter)

findAttachedHardDisk

public HardDisk findAttachedHardDisk(com.google.common.base.Predicate<HardDisk> filter)

listAttachedVolumes

public List<Volume> listAttachedVolumes()

listAttachedVolumes

public List<Volume> listAttachedVolumes(com.google.common.base.Predicate<Volume> filter)

findAttachedVolume

public Volume findAttachedVolume(com.google.common.base.Predicate<Volume> filter)

listAttachedNics

public List<Ip<?,?>> listAttachedNics()

listAttachedNics

public List<Ip<?,?>> listAttachedNics(com.google.common.base.Predicate<Ip<?,?>> filter)

findAttachedNic

public Ip<?,?> findAttachedNic(com.google.common.base.Predicate<Ip<?,?>> filter)

deploy

public AsyncTask deploy()

deploy

public AsyncTask deploy(boolean forceEnterpriseSoftLimits)

undeploy

public AsyncTask undeploy()

undeploy

public AsyncTask undeploy(boolean forceUndeploy)

reboot

public AsyncTask reboot()

Reboot a virtual machine. This is an asynchronous call. This method returns a AsyncTask object that keeps track of the task completion. Please refer to the documentation for details.

Returns:

The task reference or null if the operation completed synchronously.

See Also:

http://community.abiquo.com/display/ABI20/Rack+Resource#/VirtualMachineResource# VirtualMachineResource-Resetavirtualmachine, https://github.com/abiquo/jclouds-abiquo/wiki/Asynchronous-monitor-example

attachHardDisks

public AsyncTask attachHardDisks(HardDisk... hardDisks)

detachAllHardDisks

public AsyncTask detachAllHardDisks()

detachHardDisks

public AsyncTask detachHardDisks(HardDisk... hardDisks)

setHardDisks

public AsyncTask setHardDisks(HardDisk... hardDisks)

attachVolumes

public AsyncTask attachVolumes(Volume... volumes)

detachAllVolumes

public AsyncTask detachAllVolumes()

detachVolumes

public AsyncTask detachVolumes(Volume... volumes)

setVolumes

public AsyncTask setVolumes(Boolean forceSoftLimits,
                   Volume... volumes)

setVolumes

public AsyncTask setVolumes(Volume... volumes)

setNics

public AsyncTask setNics(List<Ip<?,?>> ips)

setNics

public AsyncTask setNics(List<Ip<?,?>> ips,
                List<UnmanagedNetwork> unmanagetNetworks)

setNics

public AsyncTask setNics(Network<?> gatewayNetwork,
                List<Ip<?,?>> ips)

setNics

public AsyncTask setNics(Network<?> gatewayNetwork,
                List<Ip<?,?>> ips,
                List<UnmanagedNetwork> unmanagetNetworks)

setGatewayNetwork

public void setGatewayNetwork(Network<?> network)

isPersistent

public boolean isPersistent()

Checks if the virtual machine is persistent.

Persistent virtual machines have the system disc in an external volume. This way, when the virtual machine is undeployed, the contents of the system disk remain in the storage device and the user can deploy the virtual machine again without losing the data in the system disk.

Returns:

Boolean indicating if the virtual machine is persistent.

hasDvd

public boolean hasDvd()

attachDvd

public void attachDvd()

detachDvd

public void detachDvd()

builder

public static VirtualMachine.Builder builder(RestContext<AbiquoApi,AbiquoAsyncApi> context,
                             VirtualAppliance virtualAppliance,
                             VirtualMachineTemplate template)

getCpu

public int getCpu()

getDescription

public String getDescription()

getHdInBytes

public long getHdInBytes()

getId

public Integer getId()

getIdState

public int getIdState()

getIdType

public int getIdType()

getNameLabel

public String getNameLabel()

getOwnerName

public String getOwnerName()

getInternalName

public String getInternalName()

getPassword

public String getPassword()

getRam

public int getRam()

getUuid

public String getUuid()

getVncAddress

public String getVncAddress()

getVncPort

public int getVncPort()

getKeymap

public String getKeymap()

setCpu

public void setCpu(int cpu)

setDescription

public void setDescription(String description)

setNameLabel

public void setNameLabel(String nameLabel)

setPassword

public void setPassword(String password)

setRam

public void setRam(int ram)

setKeymap

public void setKeymap(String keymap)

toString

public String toString()

Overrides:

toString in class Object