org.apache.brooklyn.location.byon

Class FixedListMachineProvisioningLocation<T extends MachineLocation>

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.location.byon.FixedListMachineProvisioningLocation<T>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Location, MachineProvisioningLocation<T>, ProvisioningLocation<T>, Rebindable, BrooklynObject, Configurable, Identifiable, HasHostGeoInfo, LocationInternal, BrooklynObjectInternal

Direct Known Subclasses:

LocalhostMachineProvisioningLocation, SingleMachineProvisioningLocation

public class FixedListMachineProvisioningLocation<T extends MachineLocation>
extends AbstractLocation
implements MachineProvisioningLocation<T>, java.io.Closeable

A provisioner of MachineLocations which takes a list of machines it can connect to. The collection of initial machines should be supplied in the 'machines' flag in the constructor, for example a list of machines which can be SSH'd to. This can be extended to have a mechanism to make more machines to be available (override provisionMore and canProvisionMore).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FixedListMachineProvisioningLocation.Builder Facilitates fluent/programmatic style for constructing a fixed pool of machines.

Nested classes/interfaces inherited from class org.apache.brooklyn.core.location.AbstractLocation

AbstractLocation.BasicSubscriptionSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<<any>>	INITIAL_MACHINES_FACTORY The initialMachinesFactory allows JcloudsByonLocationResolver to work, to defer instantiating the JcloudsLocation and the JcloudsMachineLocation instances.
static ConfigKey<<any>>	MACHINE_CHOOSER
static ConfigKey<java.util.Collection<MachineLocationCustomizer>>	MACHINE_LOCATION_CUSTOMIZERS
static ConfigKey<java.util.List<LocationSpec<? extends MachineLocation>>>	MACHINE_SPECS The machineSpecs allows ByonLocationResolver to work with just LocationSpecs, rather than having to instantiate the machines immediately (which would be bad, because the caller might not use the spec and thus might not unmanage the machine instances).

Fields inherited from class org.apache.brooklyn.core.location.AbstractLocation

PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors

Constructor and Description
FixedListMachineProvisioningLocation()
FixedListMachineProvisioningLocation(java.util.Map<?,?> properties)

Method Summary

Modifier and Type	Method and Description
void	addChild(Location child)
void	addMachine(T machine)
void	close()
AbstractLocation	configure(java.util.Map<?,?> properties) Will set fields from flags, and put the remaining ones into the 'leftovers' map.
java.util.Set<T>	getAllMachines()
java.util.Set<T>	getAvailable()
java.util.Set<T>	getInUse()
java.util.Map<java.lang.String,java.lang.Object>	getProvisioningFlags(java.util.Collection<java.lang.String> tags) Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map).
void	init() Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.
FixedListMachineProvisioningLocation<T>	newSubLocation(java.util.Map<?,?> newFlags) Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g.
T	obtain()
T	obtain(java.util.Map<?,?> flags) Obtain a machine in this location.
void	release(T machine) Release a previously-obtained machine.
boolean	removeChild(Location child)
void	removeMachine(T machine)
java.lang.String	toVerboseString()

Methods inherited from class org.apache.brooklyn.core.location.AbstractLocation

addExtension, config, containsLocation, equals, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocationTypeInternal, getParent, getRebindSupport, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, rebind, relations, setDisplayName, setHostGeoInfo, setManagementContext, setParent, setParent, subscriptions, toMetadataRecord, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, getManagementContext, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.location.Location

containsLocation, getChildren, getConfig, getDisplayName, getExtension, getId, getParent, hasExtension, relations, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.core.location.internal.LocationInternal

getManagementContext

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Field Detail

MACHINE_CHOOSER

public static final ConfigKey<<any>> MACHINE_CHOOSER

MACHINE_LOCATION_CUSTOMIZERS

public static final ConfigKey<java.util.Collection<MachineLocationCustomizer>> MACHINE_LOCATION_CUSTOMIZERS

MACHINE_SPECS

public static final ConfigKey<java.util.List<LocationSpec<? extends MachineLocation>>> MACHINE_SPECS

The machineSpecs allows ByonLocationResolver to work with just LocationSpecs, rather than having to instantiate the machines immediately (which would be bad, because the caller might not use the spec and thus might not unmanage the machine instances). We clear the machineSpecs in init, so they will never be persisted. This will help with backwards compatibility if we change how this is done. By the end of init(), the machines will contain the full list of locations; it will never contain a LocationSpec.

INITIAL_MACHINES_FACTORY

public static final ConfigKey<<any>> INITIAL_MACHINES_FACTORY

The initialMachinesFactory allows JcloudsByonLocationResolver to work, to defer instantiating the JcloudsLocation and the JcloudsMachineLocation instances. (Important because the caller might not use the spec and thus might not unmanage the machine instances). We clear the initialMachinesFactory in init, so they will never be persisted. This will help with backwards compatibility if we change how this is done. By the end of init(), the machines will contain the full list of locations.

Constructor Detail

FixedListMachineProvisioningLocation

public FixedListMachineProvisioningLocation()

FixedListMachineProvisioningLocation

public FixedListMachineProvisioningLocation(java.util.Map<?,?> properties)

Method Detail

init

public void init()

Description copied from class: AbstractBrooklynObject

Called by framework (in new-style instances where spec was used) after configuring etc, but before a reference to this instance is shared.

To preserve backwards compatibility for if the instance is constructed directly, one can call the code below, but that means it will be called after references to this policy have been shared with other entities.

 
 if (isLegacyConstruction()) {
     init();
 }
 
 

Overrides:

init in class AbstractLocation

toVerboseString

public java.lang.String toVerboseString()

Specified by:

toVerboseString in interface Location

Overrides:

toVerboseString in class AbstractLocation

Returns:

meta-data about the location (usually a long line, or a small number of lines).

configure

public AbstractLocation configure(java.util.Map<?,?> properties)

Description copied from class: AbstractBrooklynObject

Will set fields from flags, and put the remaining ones into the 'leftovers' map. For some types, you can find unused config via ConfigBag.getUnusedConfig().

To be overridden by AbstractEntity, AbstractLoation, AbstractPolicy, AbstractEnricher, etc.

But should not be overridden by specific entity types. If you do, the entity may break in subsequent releases. Also note that if you require fields to be initialized you must do that in this method. You must *not* rely on field initializers because they may not run until *after* this method (this method is invoked by the constructor in this class, so initializers in subclasses will not have run when this overridden method is invoked.)

Overrides:

configure in class AbstractLocation

newSubLocation

public FixedListMachineProvisioningLocation<T> newSubLocation(java.util.Map<?,?> newFlags)

Description copied from interface: MachineProvisioningLocation

Creates a new location of the same type, but with additional creation instructions in the form of flags, e.g. for specifying subnets, security groups, etc

Implementers who wish to subclass this provisioning location for additional functionality in a specific cloud can use the relevant implementation of this method as a guide.

Specified by:

newSubLocation in interface MachineProvisioningLocation<T extends MachineLocation>

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

addMachine

public void addMachine(T machine)

removeMachine

public void removeMachine(T machine)

getAvailable

public java.util.Set<T> getAvailable()

getInUse

public java.util.Set<T> getInUse()

getAllMachines

public java.util.Set<T> getAllMachines()

addChild

public void addChild(Location child)

Overrides:

addChild in class AbstractLocation

removeChild

public boolean removeChild(Location child)

Overrides:

removeChild in class AbstractLocation

obtain

public T obtain()
         throws NoMachinesAvailableException

Throws:

NoMachinesAvailableException

obtain

public T obtain(java.util.Map<?,?> flags)
         throws NoMachinesAvailableException

Description copied from interface: MachineProvisioningLocation

Obtain a machine in this location.

Specified by:

obtain in interface MachineProvisioningLocation<T extends MachineLocation>

Specified by:

obtain in interface ProvisioningLocation<T extends MachineLocation>

Parameters:

flags - Details of the desired machine (e.g. image, size, open ports, etc; some flag support is limited to selected providers). "callerContext" can be specified to have custom logging and error messages (useful if starting machines in parallel)

Returns:

a machine that is a child of this location.

Throws:

NoMachinesAvailableException - if there are no machines available in this location (or impls may return null, but that is discouraged)

release

public void release(T machine)

Description copied from interface: MachineProvisioningLocation

Release a previously-obtained machine.

Specified by:

release in interface MachineProvisioningLocation<T extends MachineLocation>

Specified by:

release in interface ProvisioningLocation<T extends MachineLocation>

Parameters:

machine - a MachineLocation previously obtained from a call to #obtain()

getProvisioningFlags

public java.util.Map<java.lang.String,java.lang.Object> getProvisioningFlags(java.util.Collection<java.lang.String> tags)

Description copied from interface: MachineProvisioningLocation

Gets flags, suitable as an argument to MachineProvisioningLocation.obtain(Map). The tags provided give hints about the machine required. The provisioning-location could be configured to understand those tags. For example, an AWS-location could be configured to understand that a particular entity type (e.g. "TomcatServer") requires a particular AMI in that region, so would return the required image id.

Specified by:

getProvisioningFlags in interface MachineProvisioningLocation<T extends MachineLocation>

Returns: