org.jclouds.virtualbox.compute

Class VirtualBoxComputeServiceAdapter

java.lang.Object

org.jclouds.virtualbox.compute.VirtualBoxComputeServiceAdapter

All Implemented Interfaces:

ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

public class VirtualBoxComputeServiceAdapter
extends Object
implements ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

Defines the connection between the VirtualBoxManager implementation and the jclouds ComputeService

Author:

Mattias Holmqvist, Andrea Turli, David Alves

Nested Class Summary

Nested classes/interfaces inherited from interface org.jclouds.compute.ComputeServiceAdapter

ComputeServiceAdapter.NodeAndInitialCredentials<N>

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger

Constructor Summary

Constructors

Constructor and Description

VirtualBoxComputeServiceAdapter(com.google.common.base.Supplier<org.virtualbox_4_1.VirtualBoxManager> manager, com.google.common.base.Supplier<Map<Image,YamlImage>> imagesMapper, com.google.common.cache.LoadingCache<Image,Master> mastersLoader, com.google.common.base.Function<NodeSpec,ComputeServiceAdapter.NodeAndInitialCredentials<org.virtualbox_4_1.IMachine>> cloneCreator, com.google.common.base.Function<org.virtualbox_4_1.IMachine,Image> imachineToImage)

Method Summary

Methods

Modifier and Type	Method and Description
ComputeServiceAdapter.NodeAndInitialCredentials<org.virtualbox_4_1.IMachine>	createNodeWithGroupEncodedIntoName(String tag, String name, Template template) ComputeService.createNodesInGroup(String, int, Template) generates the parameters passed into this method such that each node in the set has a unique name.
void	destroyNode(String vmName)
Image	getImage(String vmName) get a specific image by id
org.virtualbox_4_1.IMachine	getNode(String vmName)
Iterable<Hardware>	listHardwareProfiles() Hardware profiles describe available cpu, memory, and disk configurations that can be used to run a node.
Iterable<Image>	listImages() Images are the available configured operating systems that someone can run a node with.
Iterable<Location>	listLocations()
Iterable<org.virtualbox_4_1.IMachine>	listNodes()
void	rebootNode(String vmName)
void	resumeNode(String vmName)
void	suspendNode(String vmName)

Methods inherited from class java.lang.Object

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

Field Detail

logger

@Named(value="jclouds.compute")
protected Logger logger

Constructor Detail

VirtualBoxComputeServiceAdapter

@Inject
public VirtualBoxComputeServiceAdapter(com.google.common.base.Supplier<org.virtualbox_4_1.VirtualBoxManager> manager,
                                      com.google.common.base.Supplier<Map<Image,YamlImage>> imagesMapper,
                                      com.google.common.cache.LoadingCache<Image,Master> mastersLoader,
                                      com.google.common.base.Function<NodeSpec,ComputeServiceAdapter.NodeAndInitialCredentials<org.virtualbox_4_1.IMachine>> cloneCreator,
                                      com.google.common.base.Function<org.virtualbox_4_1.IMachine,Image> imachineToImage)

Method Detail

createNodeWithGroupEncodedIntoName

public ComputeServiceAdapter.NodeAndInitialCredentials<org.virtualbox_4_1.IMachine> createNodeWithGroupEncodedIntoName(String tag,
                                                                                                              String name,
                                                                                                              Template template)

Description copied from interface: ComputeServiceAdapter

ComputeService.createNodesInGroup(String, int, Template) generates the parameters passed into this method such that each node in the set has a unique name.

note

It is intentional to return the library native node object, as generic type N. If you are not using library-native objects (such as libvirt Domain) use JCloudsNativeComputeServiceAdapter instead.

note

Your responsibility is to create a node with the underlying library and return after storing its credentials in the supplied map corresponding to credentialStore

Specified by:

createNodeWithGroupEncodedIntoName in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

Parameters:

tag - used to aggregate nodes with identical configuration

name - unique supplied name for the node, which has the group encoded into it.

template - includes imageId, locationId, and hardwareId used to resume the instance.

Returns:

library-native representation of a node. TODO: return typed exception on createNodeFailure

See Also:

ComputeService.createNodesInGroup(String, int, Template)

listNodes

public Iterable<org.virtualbox_4_1.IMachine> listNodes()

Specified by:

listNodes in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

listHardwareProfiles

public Iterable<Hardware> listHardwareProfiles()

Description copied from interface: ComputeServiceAdapter

Hardware profiles describe available cpu, memory, and disk configurations that can be used to run a node.

To implement this method, return the library native hardware profiles available to the user. These will be used to launch nodes as a part of the template.

Specified by:

listHardwareProfiles in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

Returns:

a non-null iterable of available hardware profiles.

See Also:

ComputeService.listHardwareProfiles()

listImages

public Iterable<Image> listImages()

Description copied from interface: ComputeServiceAdapter

Images are the available configured operating systems that someone can run a node with.

To implement this method, return the library native images available to the user. These will be used to launch nodes as a part of the template.

Specified by:

listImages in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

Returns:

a non-null iterable of available images.

See Also:

ComputeService.listImages()

listLocations

public Iterable<Location> listLocations()

Specified by:

listLocations in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

getNode

public org.virtualbox_4_1.IMachine getNode(String vmName)

Specified by:

getNode in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

getImage

public Image getImage(String vmName)

Description copied from interface: ComputeServiceAdapter

get a specific image by id

Specified by:

getImage in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

Parameters:

vmName - ComputeMetadata.getId(), which is not necessarily ComputeMetadata.getProviderId()

Returns:

image or null if not exists.

destroyNode

public void destroyNode(String vmName)

Specified by:

destroyNode in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

rebootNode

public void rebootNode(String vmName)

Specified by:

rebootNode in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

resumeNode

public void resumeNode(String vmName)

Specified by:

resumeNode in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>

suspendNode

public void suspendNode(String vmName)

Specified by:

suspendNode in interface ComputeServiceAdapter<org.virtualbox_4_1.IMachine,Hardware,Image,Location>