Package org.jclouds.compute.domain.internal

Class TemplateBuilderImpl

java.lang.Object

org.jclouds.compute.domain.internal.TemplateBuilderImpl

All Implemented Interfaces:

TemplateBuilder

Direct Known Subclasses:

ArbitraryCpuRamTemplateBuilderImpl, EC2TemplateBuilderImpl

public class TemplateBuilderImpl
extends Object
implements TemplateBuilder

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	biggest
protected final com.google.common.base.Supplier<Location>	defaultLocation
protected final jakarta.inject.Provider<TemplateBuilder>	defaultTemplateProvider
protected boolean	fastest
protected Boolean	forceCacheReload
protected String	hardwareId
protected final com.google.common.base.Supplier<Set<? extends Hardware>>	hardwares
protected String	hypervisor
protected com.google.common.base.Function<Iterable<? extends Image>,Image>	imageChooser
protected String	imageDescription
protected String	imageId
protected String	imageName
protected com.google.common.base.Predicate<Image>	imagePredicate
protected final ImageCacheSupplier	images
protected String	imageVersion
protected Location	location
protected final com.google.common.base.Supplier<Set<? extends Location>>	locations
protected Logger	logger
protected double	minCores
protected double	minDisk
protected int	minRam
protected TemplateOptions	options
protected final jakarta.inject.Provider<TemplateOptions>	optionsProvider
protected Boolean	os64Bit
protected String	osArch
protected String	osDescription
protected OsFamily	osFamily
protected String	osName
protected String	osVersion

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TemplateBuilderImpl(com.google.common.base.Supplier<Set<? extends Location>> locations, com.google.common.base.Supplier<Set<? extends Image>> images, com.google.common.base.Supplier<Set<? extends Hardware>> hardwares, com.google.common.base.Supplier<Location> defaultLocation, jakarta.inject.Provider<TemplateOptions> optionsProvider, jakarta.inject.Provider<TemplateBuilder> defaultTemplateProvider)

Method Summary

Modifier and Type	Method	Description
TemplateBuilder	any()	prime this builder with parameters known to work on the current compute provider.
TemplateBuilder	biggest()	configure this template to the largest hardware, based on cores, ram, then disk
Template	build()	Generate an immutable template from the current builder.
TemplateBuilder	fastest()	configure this template to the fastest hardware, based on cpu
protected Hardware	findHardwareWithId(Set<? extends Hardware> hardwaresToSearch)
TemplateBuilder	forceCacheReload()	Forces an image lookup against the provider to reload the image cache.
TemplateBuilder	from(String spec)	Configure and return this template, updating it with the populated values of the given spec.
TemplateBuilder	from(TemplateBuilderSpec spec)	Configure and return this template, updating it with the populated values of the given spec.
TemplateBuilder	fromHardware(Hardware hardware)	Configure this template to require the minimum hardware of the parameter.
TemplateBuilder	fromImage(Image image)	Configure this template to fuzzy-match on the image parameter
TemplateBuilder	fromTemplate(Template template)	Configure this template to match the resources of the template parameter.
protected Set<? extends Image>	getImages()
TemplateBuilder	hardwareId(String hardwareId)	Configure this template to require a specific hardwareId.
protected com.google.common.collect.Ordering<Hardware>	hardwareSorter()
TemplateBuilder	hypervisorMatches(String hypervisor)	Configure this template to have an hypervisor that matches the regular expression
protected com.google.common.base.Function<Iterable<? extends Image>,Image>	imageChooser()
TemplateBuilderImpl	imageChooser(com.google.common.base.Function<Iterable<? extends Image>,Image> imageChooser)	Configure this template with a specific preference function which operates on images which match the other criteria.
TemplateBuilder	imageDescriptionMatches(String descriptionRegex)	Configure this template to have an image description that matches the regular expression
TemplateBuilder	imageId(String imageId)	Configure this template to require a specific imageId.
TemplateBuilder	imageMatches(com.google.common.base.Predicate<Image> condition)	Configure this template to have an image that matches the supplied condition ex.
TemplateBuilder	imageNameMatches(String nameRegex)	Configure this template to have an image name that matches the regular expression
TemplateBuilder	imageVersionMatches(String imageVersionRegex)	Configure this template to have an image version that matches the regular expression
TemplateBuilder	locationId(String locationId)	Configure this template to start in a specific location
TemplateBuilder	minCores(double minCores)	Configure this template to require the minimum cores below
TemplateBuilder	minDisk(double gigabytes)	Configure this template with required minimum disk space in gigabytes
TemplateBuilder	minRam(int megabytes)	Configure this template to require the minimum ram in megabytes below
TemplateBuilder	options(TemplateOptions options)	Sets options on the template (i.e.
TemplateBuilder	os64Bit(boolean is64Bit)	Configure this template to require a 64 bit operating system.
TemplateBuilder	osArchMatches(String osArchitectureRegex)	Configure this template to require a specific architecture.
TemplateBuilder	osDescriptionMatches(String osDescriptionRegex)	Configure this template to have an operating system description that matches the regular expression
TemplateBuilder	osFamily(OsFamily os)	Configure this template to use a specific operating system image.
TemplateBuilder	osNameMatches(String osNameRegex)	Configure this template to have an operating system name that matches the regular expression
TemplateBuilder	osVersionMatches(String osVersionRegex)	Configure this template to have an os version that matches the regular expression
protected Hardware	resolveHardware(Set<? extends Hardware> hardwarel, Iterable<? extends Image> images)
protected Image	resolveImage(Hardware hardware, Iterable<? extends Image> supportedImages)
TemplateBuilder	smallest()	configure this template to the smallest hardware, based on cores, ram, then disk
protected com.google.common.base.MoreObjects.ToStringHelper	string()
protected NoSuchElementException	throwNoSuchElementExceptionAfterLoggingHardwareIds(String message, Iterable<? extends Hardware> hardwares)
protected NoSuchElementException	throwNoSuchElementExceptionAfterLoggingImageIds(String message, Iterable<? extends Image> images)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

logger

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

images

protected final ImageCacheSupplier images

hardwares

protected final com.google.common.base.Supplier<Set<? extends Hardware>> hardwares

locations

protected final com.google.common.base.Supplier<Set<? extends Location>> locations

defaultLocation

protected final com.google.common.base.Supplier<Location> defaultLocation

optionsProvider

protected final jakarta.inject.Provider<TemplateOptions> optionsProvider

defaultTemplateProvider

protected final jakarta.inject.Provider<TemplateBuilder> defaultTemplateProvider

location

protected Location location

imageId

protected String imageId

hardwareId

protected String hardwareId

hypervisor

protected String hypervisor

imageVersion

protected String imageVersion

osFamily

protected OsFamily osFamily

osVersion

protected String osVersion

os64Bit

protected Boolean os64Bit

osName

protected String osName

osDescription

protected String osDescription

osArch

protected String osArch

imageName

protected String imageName

imageDescription

protected String imageDescription

imagePredicate

protected com.google.common.base.Predicate<Image> imagePredicate

imageChooser

protected com.google.common.base.Function<Iterable<? extends Image>,Image> imageChooser

minCores

protected double minCores

minRam

protected int minRam

minDisk

protected double minDisk

biggest

protected boolean biggest

fastest

protected boolean fastest

options

protected TemplateOptions options

forceCacheReload

protected Boolean forceCacheReload

Constructor Details

TemplateBuilderImpl

@Inject
protected TemplateBuilderImpl(com.google.common.base.Supplier<Set<? extends Location>> locations,
 com.google.common.base.Supplier<Set<? extends Image>> images,
 com.google.common.base.Supplier<Set<? extends Hardware>> hardwares,
 com.google.common.base.Supplier<Location> defaultLocation,
 @Named("DEFAULT")
 jakarta.inject.Provider<TemplateOptions> optionsProvider,
 @Named("DEFAULT")
 jakarta.inject.Provider<TemplateBuilder> defaultTemplateProvider)

Method Details

fromTemplate

public TemplateBuilder fromTemplate(Template template)

Configure this template to match the resources of the template parameter.

Specified by:

fromTemplate in interface TemplateBuilder

fromHardware

public TemplateBuilder fromHardware(Hardware hardware)

Configure this template to require the minimum hardware of the parameter.

Specified by:

fromHardware in interface TemplateBuilder

fromImage

public TemplateBuilder fromImage(Image image)

Configure this template to fuzzy-match on the image parameter

Specified by:

fromImage in interface TemplateBuilder

smallest

public TemplateBuilder smallest()

configure this template to the smallest hardware, based on cores, ram, then disk

Specified by:

smallest in interface TemplateBuilder

biggest

public TemplateBuilder biggest()

configure this template to the largest hardware, based on cores, ram, then disk

Specified by:

biggest in interface TemplateBuilder

fastest

public TemplateBuilder fastest()

configure this template to the fastest hardware, based on cpu

Specified by:

fastest in interface TemplateBuilder

locationId

public TemplateBuilder locationId(String locationId)

Configure this template to start in a specific location

Specified by:

locationId in interface TemplateBuilder

osFamily

public TemplateBuilder osFamily(OsFamily os)

Configure this template to use a specific operating system image.

Specified by:

osFamily in interface TemplateBuilder

build

public Template build()

Generate an immutable template from the current builder.

Specified by:

build in interface TemplateBuilder

findHardwareWithId

protected Hardware findHardwareWithId(Set<? extends Hardware> hardwaresToSearch)

throwNoSuchElementExceptionAfterLoggingImageIds

protected NoSuchElementException throwNoSuchElementExceptionAfterLoggingImageIds(String message,
 Iterable<? extends Image> images)

throwNoSuchElementExceptionAfterLoggingHardwareIds

protected NoSuchElementException throwNoSuchElementExceptionAfterLoggingHardwareIds(String message,
 Iterable<? extends Hardware> hardwares)

resolveHardware

protected Hardware resolveHardware(Set<? extends Hardware> hardwarel,
 Iterable<? extends Image> images)

imageChooser

protected com.google.common.base.Function<Iterable<? extends Image>,Image> imageChooser()

hardwareSorter

protected com.google.common.collect.Ordering<Hardware> hardwareSorter()

resolveImage

protected Image resolveImage(Hardware hardware,
 Iterable<? extends Image> supportedImages)

Parameters:

hardware -

supportedImages -

Throws:

NoSuchElementException - if there's no image that matches the predicate

getImages

protected Set<? extends Image> getImages()

imageId

public TemplateBuilder imageId(String imageId)

Configure this template to require a specific imageId.

Note that image Ids are often scoped to location

Specified by:

imageId in interface TemplateBuilder

imageNameMatches

public TemplateBuilder imageNameMatches(String nameRegex)

Configure this template to have an image name that matches the regular expression

Specified by:

imageNameMatches in interface TemplateBuilder

imageDescriptionMatches

public TemplateBuilder imageDescriptionMatches(String descriptionRegex)

Configure this template to have an image description that matches the regular expression

Specified by:

imageDescriptionMatches in interface TemplateBuilder

imageMatches

public TemplateBuilder imageMatches(com.google.common.base.Predicate<Image> condition)

Configure this template to have an image that matches the supplied condition ex.

 builder.imageMatches(ImagePredicates.userMetadataContains("author", "sue"));
 

Specified by:

imageMatches in interface TemplateBuilder

imageChooser

public TemplateBuilderImpl imageChooser(com.google.common.base.Function<Iterable<? extends Image>,Image> imageChooser)

Configure this template with a specific preference function which operates on images which match the other criteria.

If no function is supplied, jclouds will select one according to an internal strategy. This strategy may change from version to version.

Specified by:

imageChooser in interface TemplateBuilder

imageVersionMatches

public TemplateBuilder imageVersionMatches(String imageVersionRegex)

Configure this template to have an image version that matches the regular expression

Specified by:

imageVersionMatches in interface TemplateBuilder

osVersionMatches

public TemplateBuilder osVersionMatches(String osVersionRegex)

Configure this template to have an os version that matches the regular expression

Specified by:

osVersionMatches in interface TemplateBuilder

osArchMatches

public TemplateBuilder osArchMatches(String osArchitectureRegex)

Configure this template to require a specific architecture. ex. virtualizationType or

Specified by:

osArchMatches in interface TemplateBuilder

minCores

public TemplateBuilder minCores(double minCores)

Configure this template to require the minimum cores below

Specified by:

minCores in interface TemplateBuilder

minRam

public TemplateBuilder minRam(int megabytes)

Configure this template to require the minimum ram in megabytes below

Specified by:

minRam in interface TemplateBuilder

minDisk

public TemplateBuilder minDisk(double gigabytes)

Configure this template with required minimum disk space in gigabytes

Specified by:

minDisk in interface TemplateBuilder

osNameMatches

public TemplateBuilder osNameMatches(String osNameRegex)

Configure this template to have an operating system name that matches the regular expression

Specified by:

osNameMatches in interface TemplateBuilder

osDescriptionMatches

public TemplateBuilder osDescriptionMatches(String osDescriptionRegex)

Configure this template to have an operating system description that matches the regular expression

Specified by:

osDescriptionMatches in interface TemplateBuilder

hardwareId

public TemplateBuilder hardwareId(String hardwareId)

Configure this template to require a specific hardwareId.

Specified by:

hardwareId in interface TemplateBuilder

hypervisorMatches

public TemplateBuilder hypervisorMatches(String hypervisor)

Configure this template to have an hypervisor that matches the regular expression

Specified by:

hypervisorMatches in interface TemplateBuilder

options

public TemplateBuilder options(TemplateOptions options)

Sets options on the template (i.e. items which adorn a created node rather than restricting selection of the node). Note that this method typically replaces any options previously specified in the builder. Normal usage is to build up all options and pass them to the builder with a single call to this method.

Specified by:

options in interface TemplateBuilder

any

public TemplateBuilder any()

prime this builder with parameters known to work on the current compute provider.

Specified by:

any in interface TemplateBuilder

toString

public String toString()

Overrides:

toString in class Object

string

protected com.google.common.base.MoreObjects.ToStringHelper string()

Since:

1.5

os64Bit

public TemplateBuilder os64Bit(boolean is64Bit)

Description copied from interface: TemplateBuilder

Configure this template to require a 64 bit operating system.

Specified by:

os64Bit in interface TemplateBuilder

from

public TemplateBuilder from(TemplateBuilderSpec spec)

Description copied from interface: TemplateBuilder

Configure and return this template, updating it with the populated values of the given spec.

Specified by:

from in interface TemplateBuilder

from

public TemplateBuilder from(String spec)

Description copied from interface: TemplateBuilder

Configure and return this template, updating it with the populated values of the given spec. This is especially useful for command-line configuration of a TemplateBuilder.

Specified by:

from in interface TemplateBuilder

Parameters:

spec - a String in the format specified by TemplateBuilderSpec

forceCacheReload

public TemplateBuilder forceCacheReload()

Description copied from interface: TemplateBuilder

Forces an image lookup against the provider to reload the image cache.

Use with caution. In some providers getting the list of images is an expensive operation, and the use of the image cache is recommended. If there is a need to minimize the amount of time the images are cached, consider configuring the cache expiration time by setting the Constants.PROPERTY_SESSION_INTERVAL property.

Specified by:

forceCacheReload in interface TemplateBuilder