org.apache.brooklyn.api.location

Interface ProvisioningLocation<T extends Location>

All Superinterfaces:

BrooklynObject, Configurable, Identifiable, Location

All Known Subinterfaces:

JcloudsLocationPublic, MachineManagementMixins.RichMachineProvisioningLocation<T>, MachineProvisioningLocation<T>

All Known Implementing Classes:

AbstractCloudMachineProvisioningLocation, AggregatingMachineProvisioningLocation, DockerJcloudsLocation, FixedListMachineProvisioningLocation, JcloudsLocation, KubernetesLocation, LocalhostMachineProvisioningLocation, MultiLocation, OpenShiftLocation, ServerPoolLocation, SingleMachineProvisioningLocation

public interface ProvisioningLocation<T extends Location>
extends Location

A location that is able to provision new locations within it.

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
T	obtain(java.util.Map<?,?> flags) Obtain a new (sub)-location in the location represented by this class.
void	release(T machine) Release a previously-obtained location.

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

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

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

Method Detail

obtain

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

Obtain a new (sub)-location in the location represented by this class.

Parameters:

flags - Constraints and details of the location to be provisioned

Returns:

the location provisioned

Throws:

LocationNotAvailableException - if could not provision such a location

release

void release(T machine)

Release a previously-obtained location.

Parameters:

location - a location previously obtained

Throws:

java.lang.IllegalStateException - if the machine did not come from a call to #obtain() or it has already been released.