Package org.jclouds.docker.compute.strategy

Class DockerComputeServiceAdapter

java.lang.Object

org.jclouds.docker.compute.strategy.DockerComputeServiceAdapter

All Implemented Interfaces:

ComputeServiceAdapter<Container,Hardware,Image,Location>

@Singleton
public class DockerComputeServiceAdapter
extends Object
implements ComputeServiceAdapter<Container,Hardware,Image,Location>

defines the connection between the DockerApi implementation and the jclouds ComputeService

Nested Class Summary

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

ComputeServiceAdapter.NodeAndInitialCredentials<N>

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger
static String	PREFIX_DOCKER_HUB_HOST	Some Docker versions returns host prefix even for images from Docker hub in repoTags field.
static String	SUFFIX_LATEST_VERSION	(Optional) Suffix used, when image version is not used during searching images.

Constructor Summary

Constructors

Constructor	Description
DockerComputeServiceAdapter(DockerApi api)

Method Summary

Modifier and Type	Method	Description
ComputeServiceAdapter.NodeAndInitialCredentials<Container>	createNodeWithGroupEncodedIntoName(String group, 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.
protected static com.google.common.base.Predicate<Image>	createPredicateMatchingRepoTags(String imageIdOrName)
void	destroyNode(String id)
Image	getImage(String imageIdOrName)	get a specific image by id
Container	getNode(String id)
Iterable<Hardware>	listHardwareProfiles()	Hardware profiles describe available cpu, memory, and disk configurations that can be used to run a node.
Set<Image>	listImages()	Method based on ImageApi.listImages().
Iterable<Location>	listLocations()
Iterable<Container>	listNodes()
Iterable<Container>	listNodesByIds(Iterable<String> ids)
void	rebootNode(String id)
void	resumeNode(String id)
void	suspendNode(String id)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX_DOCKER_HUB_HOST

public static final String PREFIX_DOCKER_HUB_HOST

Some Docker versions returns host prefix even for images from Docker hub in repoTags field. We use this constant to correctly identify requested image name.

See Also:

Constant Field Values

SUFFIX_LATEST_VERSION

public static final String SUFFIX_LATEST_VERSION

(Optional) Suffix used, when image version is not used during searching images.

See Also:

Constant Field Values

logger

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

Constructor Detail

DockerComputeServiceAdapter

@Inject
public DockerComputeServiceAdapter(DockerApi api)

Method Detail

createNodeWithGroupEncodedIntoName

public ComputeServiceAdapter.NodeAndInitialCredentials<Container> createNodeWithGroupEncodedIntoName(String group,
                                                                                                     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<Container,Hardware,Image,Location>

Parameters:

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

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<Container,Hardware,Image,Location>

Returns:

a non-null iterable of available hardware profiles.

See Also:

ComputeService.listHardwareProfiles()

listImages

public Set<Image> listImages()

Method based on ImageApi.listImages(). It retrieves additional information by inspecting each image.

Specified by:

listImages in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

Returns:

a non-null iterable of available images.

See Also:

ComputeServiceAdapter.listImages()

getImage

public Image getImage(String imageIdOrName)

Description copied from interface: ComputeServiceAdapter

get a specific image by id

Specified by:

getImage in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

Parameters:

imageIdOrName - Image#getId, which is not necessarily Image#getProviderId

Returns:

image or null if not exists.

listNodes

public Iterable<Container> listNodes()

Specified by:

listNodes in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

listNodesByIds

public Iterable<Container> listNodesByIds(Iterable<String> ids)

Specified by:

listNodesByIds in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

listLocations

public Iterable<Location> listLocations()

Specified by:

listLocations in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

getNode

public Container getNode(String id)

Specified by:

getNode in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

destroyNode

public void destroyNode(String id)

Specified by:

destroyNode in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

rebootNode

public void rebootNode(String id)

Specified by:

rebootNode in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

resumeNode

public void resumeNode(String id)

Specified by:

resumeNode in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

suspendNode

public void suspendNode(String id)

Specified by:

suspendNode in interface ComputeServiceAdapter<Container,Hardware,Image,Location>

createPredicateMatchingRepoTags

protected static com.google.common.base.Predicate<Image> createPredicateMatchingRepoTags(String imageIdOrName)