LocalhostMachineProvisioningLocation (Apache Brooklyn)

java.lang.Object
- brooklyn.basic.AbstractBrooklynObject
- - brooklyn.location.basic.AbstractLocation
  - - brooklyn.location.basic.FixedListMachineProvisioningLocation<SshMachineLocation>
    - - brooklyn.location.basic.LocalhostMachineProvisioningLocation

All Implemented Interfaces:

BrooklynObject, BrooklynObjectInternal, LocationWithObjectStore, Rebindable, Configurable, Identifiable, AddressableLocation, LocationInternal, HasHostGeoInfo, Location, MachineProvisioningLocation<SshMachineLocation>, ProvisioningLocation<SshMachineLocation>, java.io.Closeable, java.io.Serializable, java.lang.AutoCloseable
```
public class LocalhostMachineProvisioningLocation
extends FixedListMachineProvisioningLocation<SshMachineLocation>
implements AddressableLocation, LocationWithObjectStore
```
An implementation of MachineProvisioningLocation that can provision a SshMachineLocation for the local host. By default you can only obtain a single SshMachineLocation for the localhost. Optionally, you can "overload" and choose to allow localhost to be provisioned multiple times, which may be useful in some testing scenarios.

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LocalhostMachineProvisioningLocation.LocalhostMachine
- Nested classes/interfaces inherited from class brooklyn.location.basic.FixedListMachineProvisioningLocation
  FixedListMachineProvisioningLocation.Builder
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject
  BrooklynObject.TagSupport
- Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable
  Configurable.ConfigurationSupport
- Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal
  BrooklynObjectInternal.ConfigurationSupportInternal

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalhostMachineProvisioningLocation.LocalhostMachine`

Field Summary

Fields
Modifier and Type Field and Description

static org.slf4j.Logger LOG

static ConfigKey<java.lang.Boolean> SKIP_ON_BOX_BASE_DIR_RESOLUTION
- Fields inherited from class brooklyn.location.basic.AbstractLocation
  PARENT_LOCATION, TEMPORARY_LOCATION
- Fields inherited from interface brooklyn.location.basic.LocationInternal
  FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Fields
Modifier and Type	Field and Description
`static org.slf4j.Logger`	`LOG`
`static ConfigKey<java.lang.Boolean>`	`SKIP_ON_BOX_BASE_DIR_RESOLUTION`

Constructor Summary

Constructors
Constructor and Description
`LocalhostMachineProvisioningLocation()` Construct a new instance.
`LocalhostMachineProvisioningLocation(java.util.Map properties)` Deprecated. since 0.6
`LocalhostMachineProvisioningLocation(java.lang.String name)`
`LocalhostMachineProvisioningLocation(java.lang.String name, int count)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canProvisionMore()`
`static boolean`	`checkPortAvailable(java.net.InetAddress localAddress, int portNumber)` checks the actual availability of the port on localhost, ie by binding to it; cf `Networking.isPortAvailable(int)`
`static void`	`clearStaticData()`
`LocalhostMachineProvisioningLocation`	`configure(java.util.Map<?,?> flags)` Will set fields from flags, and put the remaining ones into the 'leftovers' map.
`java.net.InetAddress`	`getAddress()` Return the single most appropriate address for this location.
`static java.net.InetAddress`	`getLocalhostInetAddress()`
`static boolean`	`isSudoAllowed()`
`PersistenceObjectStore`	`newPersistenceObjectStore(java.lang.String container)` Creates a `PersistenceObjectStore` pointed at the given container/directory.
`static int`	`obtainPort(java.net.InetAddress localAddress, PortRange range)`
`static int`	`obtainPort(PortRange range)`
`static boolean`	`obtainSpecificPort(java.net.InetAddress localAddress, int portNumber)`
`void`	`release(SshMachineLocation machine)` Release a previously-obtained machine.
`static void`	`releasePort(java.net.InetAddress localAddress, int portNumber)`
`static LocationSpec<LocalhostMachineProvisioningLocation>`	`spec()`

Methods inherited from class brooklyn.location.basic.FixedListMachineProvisioningLocation
addChild, addMachine, close, getAllMachines, getAvailable, getInUse, getProvisioningFlags, init, newSubLocation, obtain, obtain, removeChild, removeMachine, toVerboseString

Methods inherited from class brooklyn.location.basic.AbstractLocation
addExtension, config, containsLocation, equals, getAllConfig, getAllConfigBag, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocalConfigBag, getParent, getRawLocalConfigBag, getRebindSupport, hasConfig, hasExtension, hashCode, isManaged, onManagementStarted, onManagementStopped, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, toMetadataRecord, toString

Methods inherited from class brooklyn.basic.AbstractBrooklynObject
getCatalogItemId, getId, getManagementContext, getTagSupport, rebind, setCatalogItemId, tags

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface brooklyn.location.Location
containsLocation, getAllConfig, getChildren, getConfig, getConfig, getDisplayName, getExtension, getId, getParent, hasConfig, hasExtension, setParent, toVerboseString

Methods inherited from interface brooklyn.basic.BrooklynObject
getCatalogItemId, getTagSupport, tags

Methods inherited from interface brooklyn.entity.trait.Configurable
config, setConfig

Methods inherited from interface brooklyn.location.basic.LocationInternal
getManagementContext

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal
setCatalogItemId

- Field Detail
  - LOG
```
public static final org.slf4j.Logger LOG
```
  - SKIP_ON_BOX_BASE_DIR_RESOLUTION
```
public static final ConfigKey<java.lang.Boolean> SKIP_ON_BOX_BASE_DIR_RESOLUTION
```
- Constructor Detail
  - LocalhostMachineProvisioningLocation
```
public LocalhostMachineProvisioningLocation()
```
    Construct a new instance. The constructor recognises the following properties:
    - count - number of localhost machines to make available
  - LocalhostMachineProvisioningLocation
```
public LocalhostMachineProvisioningLocation(java.util.Map properties)
```
    Deprecated. since 0.6
    
    Parameters:
    properties - the properties of the new instance.
    See Also:
    LocalhostMachineProvisioningLocation()
  - LocalhostMachineProvisioningLocation
```
public LocalhostMachineProvisioningLocation(java.lang.String name)
```
  - LocalhostMachineProvisioningLocation
```
public LocalhostMachineProvisioningLocation(java.lang.String name,
                                    int count)
```
- Method Detail
  - clearStaticData
```
public static void clearStaticData()
```
  - spec
```
public static LocationSpec<LocalhostMachineProvisioningLocation> spec()
```
  - configure
```
public LocalhostMachineProvisioningLocation configure(java.util.Map<?,?> flags)
```
    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 FixedListMachineProvisioningLocation<SshMachineLocation>
  - getLocalhostInetAddress
```
public static java.net.InetAddress getLocalhostInetAddress()
```
  - getAddress
```
public java.net.InetAddress getAddress()
```
    Description copied from interface: AddressableLocation
    
    Return the single most appropriate address for this location. (An implementation or sub-interface definition may supply more information on the precise semantics of the address.) Should not return null, but in some "special cases" (e.g. CloudFoundryLocation it may return null if the location is not configured correctly). Users should expect a non-null result and treat null as a programming error or misconfiguration. Implementors of this interface should strive to not return null (and then we'll remove this caveat from the javadoc!).
    
    Specified by:
    
    getAddress in interface AddressableLocation
  - canProvisionMore
```
public boolean canProvisionMore()
```
  - obtainSpecificPort
```
public static boolean obtainSpecificPort(java.net.InetAddress localAddress,
                         int portNumber)
```
  - checkPortAvailable
```
public static boolean checkPortAvailable(java.net.InetAddress localAddress,
                         int portNumber)
```
    checks the actual availability of the port on localhost, ie by binding to it; cf Networking.isPortAvailable(int)
  - obtainPort
```
public static int obtainPort(PortRange range)
```
  - obtainPort
```
public static int obtainPort(java.net.InetAddress localAddress,
             PortRange range)
```
  - releasePort
```
public static void releasePort(java.net.InetAddress localAddress,
               int portNumber)
```
  - release
```
public void release(SshMachineLocation machine)
```
    Description copied from interface: MachineProvisioningLocation
    
    Release a previously-obtained machine.
    
    Specified by:
    
    release in interface MachineProvisioningLocation<SshMachineLocation>
    
    Specified by:
    
    release in interface ProvisioningLocation<SshMachineLocation>
    
    Overrides:
    
    release in class FixedListMachineProvisioningLocation<SshMachineLocation>
    
    Parameters:
    machine - a MachineLocation previously obtained from a call to #obtain()
  - isSudoAllowed
```
public static boolean isSudoAllowed()
```
  - newPersistenceObjectStore
```
public PersistenceObjectStore newPersistenceObjectStore(java.lang.String container)
```
    Description copied from interface: LocationWithObjectStore
    
    Creates a PersistenceObjectStore pointed at the given container/directory.
    
    Specified by:
    
    newPersistenceObjectStore in interface LocationWithObjectStore

Class LocalhostMachineProvisioningLocation

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.location.basic.FixedListMachineProvisioningLocation

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObject

Nested classes/interfaces inherited from interface brooklyn.entity.trait.Configurable

Nested classes/interfaces inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Summary

Fields inherited from class brooklyn.location.basic.AbstractLocation

Fields inherited from interface brooklyn.location.basic.LocationInternal

Constructor Summary

Method Summary

Methods inherited from class brooklyn.location.basic.FixedListMachineProvisioningLocation

Methods inherited from class brooklyn.location.basic.AbstractLocation

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

Methods inherited from class java.lang.Object

Methods inherited from interface brooklyn.location.Location

Methods inherited from interface brooklyn.basic.BrooklynObject

Methods inherited from interface brooklyn.entity.trait.Configurable

Methods inherited from interface brooklyn.location.basic.LocationInternal

Methods inherited from interface brooklyn.basic.BrooklynObjectInternal

Field Detail

LOG

SKIP_ON_BOX_BASE_DIR_RESOLUTION

Constructor Detail

LocalhostMachineProvisioningLocation

LocalhostMachineProvisioningLocation

LocalhostMachineProvisioningLocation

LocalhostMachineProvisioningLocation

Method Detail

clearStaticData

spec

configure

getLocalhostInetAddress

getAddress

canProvisionMore

obtainSpecificPort

checkPortAvailable

obtainPort

obtainPort

releasePort

release

isSudoAllowed

newPersistenceObjectStore