org.apache.brooklyn.location.localhost

Class LocalhostMachineProvisioningLocation.LocalhostMachine

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.core.location.AbstractMachineLocation

org.apache.brooklyn.location.ssh.SshMachineLocation

org.apache.brooklyn.location.localhost.LocalhostMachineProvisioningLocation.LocalhostMachine

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, AddressableLocation, Location, MachineLocation, PortSupplier, Rebindable, BrooklynObject, Configurable, Identifiable, HasHostGeoInfo, HasSubnetHostname, LocationInternal, BrooklynObjectInternal, CanResolveOnBoxDir, WithMutexes, HasNetworkAddresses

Enclosing class:

LocalhostMachineProvisioningLocation

public static class LocalhostMachineProvisioningLocation.LocalhostMachine
extends SshMachineLocation
implements HasSubnetHostname

Nested Class Summary

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<java.lang.Boolean>	SKIP_ON_BOX_BASE_DIR_RESOLUTION

Fields inherited from class org.apache.brooklyn.location.ssh.SshMachineLocation

ALL_SSH_CONFIG_KEY_NAMES, ALL_SSH_CONFIG_KEYS, ALLOCATE_PTY, CLOSE_CONNECTION, LOCAL_TEMP_DIR, LOG_PREFIX, NO_STDERR_LOGGING, NO_STDOUT_LOGGING, PASSWORD, PRIVATE_ADDRESSES, PRIVATE_KEY_DATA, PRIVATE_KEY_FILE, PRIVATE_KEY_PASSPHRASE, REUSABLE_SSH_PROPS, SCP_EXECUTABLE, SCRIPT_DIR, SSH_CACHE_EXPIRY_DURATION, SSH_CONFIG_GIVEN_TO_PROPS, SSH_ENV_MAP, SSH_EXECUTABLE, SSH_HOST, SSH_PORT, SSH_TOOL_CLASS, SSH_TOOL_CLASS_PROPERTIES_PREFIX, STDERR, STDOUT, TCP_PORT_MAPPINGS, UNIQUE_ID

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

DETECT_MACHINE_DETAILS, MACHINE_DETAILS

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
LocalhostMachine()
LocalhostMachine(java.util.Map<?,?> properties) Deprecated. since 0.6.0 use no-arg constructor (and spec) then configure

Method Summary

Modifier and Type	Method and Description
LocalhostMachineProvisioningLocation.LocalhostMachine	configure(java.util.Map<?,?> properties) Will set fields from flags, and put the remaining ones into the 'leftovers' map.
OsDetails	getOsDetails()
java.lang.String	getSubnetHostname() returns a hostname for use internally within a subnet / VPC
java.lang.String	getSubnetIp() returns an IP for use internally within a subnet / VPC
WithMutexes	mutexes()
int	obtainPort(PortRange range) Reserve a port for your application, with a port number in a specific range.
boolean	obtainSpecificPort(int portNumber) Reserve a specific port for an application.
void	releasePort(int portNumber) Release a previously reserved port.

Methods inherited from class org.apache.brooklyn.location.ssh.SshMachineLocation

acquireMutex, close, copyFrom, copyFrom, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, execCommands, execCommands, execCommands, execCommands, execScript, execScript, execScript, execScript, findKeyPair, findPassword, getAddress, getHostname, getPort, getPrivateAddresses, getPublicAddresses, getSshHostAndPort, getUser, hasMutex, init, installTo, installTo, installTo, installTo, isSshable, releaseMutex, resolveOnBoxDirFor, toString, toVerboseString, tryAcquireMutex

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

getMachineDetails

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

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

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.MachineLocation

getMachineDetails

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

SKIP_ON_BOX_BASE_DIR_RESOLUTION

public static final ConfigKey<java.lang.Boolean> SKIP_ON_BOX_BASE_DIR_RESOLUTION

Constructor Detail

LocalhostMachine

public LocalhostMachine()

LocalhostMachine

@Deprecated
public LocalhostMachine(java.util.Map<?,?> properties)

Deprecated. since 0.6.0 use no-arg constructor (and spec) then configure

Method Detail

mutexes

public WithMutexes mutexes()

Overrides:

mutexes in class AbstractMachineLocation

obtainSpecificPort

public boolean obtainSpecificPort(int portNumber)

Description copied from interface: PortSupplier

Reserve a specific port for an application. If your application requires a specific port - for example, port 80 for a web server - you should reserve this port before starting your application. Using this method, you will be able to detect if another application has already claimed this port number.

Specified by:

obtainSpecificPort in interface PortSupplier

Overrides:

obtainSpecificPort in class SshMachineLocation

Parameters:

portNumber - the required port number.

Returns:

true if the port was successfully reserved; false if it has been previously reserved.

See Also:

SshMachineLocation.obtainPort(PortRange), PortRanges.ANY_HIGH_PORT

obtainPort

public int obtainPort(PortRange range)

Description copied from interface: PortSupplier

Reserve a port for your application, with a port number in a specific range. If your application requires a port, but it does not mind exactly which port number - for example, a port for internal JMX monitoring - call this method.

Specified by:

obtainPort in interface PortSupplier

Overrides:

obtainPort in class SshMachineLocation

Parameters:

range - the range of acceptable port numbers.

Returns:

the port number that has been reserved, or -1 if there was no available port in the acceptable range.

releasePort

public void releasePort(int portNumber)

Description copied from interface: PortSupplier

Release a previously reserved port.

Specified by:

releasePort in interface PortSupplier

Overrides:

releasePort in class SshMachineLocation

Parameters:

portNumber - the port number from a call to PortSupplier.obtainPort(PortRange) or PortSupplier.obtainSpecificPort(int)

getOsDetails

public OsDetails getOsDetails()

Specified by:

getOsDetails in interface MachineLocation

Overrides:

getOsDetails in class AbstractMachineLocation

configure

public LocalhostMachineProvisioningLocation.LocalhostMachine 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 SshMachineLocation

getSubnetHostname

public java.lang.String getSubnetHostname()

Description copied from interface: HasSubnetHostname

returns a hostname for use internally within a subnet / VPC

Specified by:

getSubnetHostname in interface HasSubnetHostname

getSubnetIp

public java.lang.String getSubnetIp()

Description copied from interface: HasSubnetHostname

returns an IP for use internally within a subnet / VPC

Specified by:

getSubnetIp in interface HasSubnetHostname