brooklyn.location.docker

Class DockerContainerLocation

java.lang.Object

brooklyn.basic.AbstractBrooklynObject

brooklyn.location.basic.AbstractLocation

brooklyn.location.basic.SshMachineLocation

brooklyn.location.docker.DockerContainerLocation

All Implemented Interfaces:

brooklyn.basic.BrooklynObject, brooklyn.basic.BrooklynObjectInternal, brooklyn.entity.rebind.Rebindable, brooklyn.entity.trait.Configurable, brooklyn.entity.trait.Identifiable, brooklyn.location.AddressableLocation, brooklyn.location.basic.HasSubnetHostname, brooklyn.location.basic.LocationInternal, brooklyn.location.basic.SupportsPortForwarding, brooklyn.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>, brooklyn.location.geo.HasHostGeoInfo, brooklyn.location.Location, brooklyn.location.MachineLocation, brooklyn.location.PortSupplier, brooklyn.util.mutex.WithMutexes, brooklyn.util.net.HasNetworkAddresses, Closeable, Serializable, AutoCloseable

public class DockerContainerLocation
extends brooklyn.location.basic.SshMachineLocation
implements brooklyn.location.basic.SupportsPortForwarding, brooklyn.location.basic.HasSubnetHostname, brooklyn.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>

A Location that wraps a Docker container.

The underlying container is presented as an SshMachineLocation obtained using the jclouds Docker driver.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class brooklyn.basic.AbstractBrooklynObject

brooklyn.basic.AbstractBrooklynObject.BasicTagSupport

Nested classes/interfaces inherited from interface brooklyn.location.basic.SupportsPortForwarding

brooklyn.location.basic.SupportsPortForwarding.RequiresPortForwarding

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

brooklyn.basic.BrooklynObject.TagSupport

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

brooklyn.entity.trait.Configurable.ConfigurationSupport

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

brooklyn.basic.BrooklynObjectInternal.ConfigurationSupportInternal

Field Summary

Fields inherited from class brooklyn.location.basic.SshMachineLocation

address, ALL_SSH_CONFIG_KEY_NAMES, ALL_SSH_CONFIG_KEYS, ALLOCATE_PTY, CLOSE_CONNECTION, DETECT_MACHINE_DETAILS, LOCAL_TEMP_DIR, LOG_PREFIX, logSsh, MACHINE_DETAILS, NO_STDERR_LOGGING, NO_STDOUT_LOGGING, PASSWORD, previouslyConnected, 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, STDERR, STDOUT, UNIQUE_ID, user

Fields inherited from class brooklyn.location.basic.AbstractLocation

PARENT_LOCATION

Fields inherited from interface brooklyn.location.dynamic.DynamicLocation

MAX_SUB_LOCATIONS, OWNER

Fields inherited from interface brooklyn.location.basic.LocationInternal

FINAL_SPEC, NAMED_SPEC_NAME, ORIGINAL_SPEC

Constructor Summary

Constructors

Constructor and Description
DockerContainerLocation()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
int	execCommands(Map<String,?> props, String summaryForLogging, List<String> commands, Map<String,?> env)
int	execScript(Map<String,?> props, String summaryForLogging, List<String> commands, Map<String,?> env)
InetAddress	getAddress()
brooklyn.location.jclouds.JcloudsSshMachineLocation	getMachine()
int	getMappedPort(int portNumber)
DockerContainer	getOwner()
com.google.common.net.HostAndPort	getSocketEndpointFor(brooklyn.util.net.Cidr accessor, int privatePort)
String	getSubnetHostname()
String	getSubnetIp()
void	init()
int	obtainPort(brooklyn.location.PortRange range)
boolean	obtainSpecificPort(int portNumber)
void	releasePort(int portNumber)
com.google.common.base.Objects.ToStringHelper	string()

Methods inherited from class brooklyn.location.basic.SshMachineLocation

acquireMutex, addSshPoolCacheCleanupTask, configure, connectSsh, connectSsh, copyFrom, copyFrom, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, copyTo, execCommands, execCommands, execCommands, execScript, execScript, execScript, execSsh, execWithLogging, findKeyPair, findPassword, getHostname, getMachineDetails, getMutexSupport, getOsDetails, getPort, getPrivateAddresses, getPublicAddresses, getSshHostAndPort, getUser, hasMutex, inferMachineDetails, installTo, installTo, installTo, installTo, isSshable, newExecWithLoggingHelpers, releaseMutex, toString, toVerboseString, tryAcquireMutex

Methods inherited from class brooklyn.location.basic.AbstractLocation

addChild, addChild, addExtension, assertNotYetManaged, config, containsLocation, equals, getAllConfig, getAllConfigBag, getChildren, getConfig, getConfig, getDisplayName, getExtension, getHostGeoInfo, getLocalConfigBag, getParent, getRawLocalConfigBag, getRebindSupport, hasConfig, hasExtension, hashCode, isDisplayNameAutoGenerated, isManaged, onChanged, onManagementStarted, onManagementStopped, removeChild, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, toMetadataRecord

Methods inherited from class brooklyn.basic.AbstractBrooklynObject

configure, getCatalogItemId, getId, getManagementContext, getTagSupport, isLegacyConstruction, isRebinding, onTagsChanged, rebind, requestPersist, setCatalogItemId, tags

Methods inherited from class java.lang.Object

clone, finalize, 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

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

Constructor Detail

DockerContainerLocation

public DockerContainerLocation()

Method Detail

init

public void init()

Overrides:

init in class brooklyn.basic.AbstractBrooklynObject

getOwner

public DockerContainer getOwner()

Specified by:

getOwner in interface brooklyn.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>

getMachine

public brooklyn.location.jclouds.JcloudsSshMachineLocation getMachine()

getMappedPort

public int getMappedPort(int portNumber)

obtainSpecificPort

public boolean obtainSpecificPort(int portNumber)

Specified by:

obtainSpecificPort in interface brooklyn.location.PortSupplier

Overrides:

obtainSpecificPort in class brooklyn.location.basic.SshMachineLocation

obtainPort

public int obtainPort(brooklyn.location.PortRange range)

Specified by:

obtainPort in interface brooklyn.location.PortSupplier

Overrides:

obtainPort in class brooklyn.location.basic.SshMachineLocation

getSocketEndpointFor

public com.google.common.net.HostAndPort getSocketEndpointFor(brooklyn.util.net.Cidr accessor,
                                                     int privatePort)

Specified by:

getSocketEndpointFor in interface brooklyn.location.basic.SupportsPortForwarding

execScript

public int execScript(Map<String,?> props,
             String summaryForLogging,
             List<String> commands,
             Map<String,?> env)

Overrides:

execScript in class brooklyn.location.basic.SshMachineLocation

execCommands

public int execCommands(Map<String,?> props,
               String summaryForLogging,
               List<String> commands,
               Map<String,?> env)

Overrides:

execCommands in class brooklyn.location.basic.SshMachineLocation

releasePort

public void releasePort(int portNumber)

Specified by:

releasePort in interface brooklyn.location.PortSupplier

Overrides:

releasePort in class brooklyn.location.basic.SshMachineLocation

getAddress

public InetAddress getAddress()

Specified by:

getAddress in interface brooklyn.location.AddressableLocation

Specified by:

getAddress in interface brooklyn.location.MachineLocation

Overrides:

getAddress in class brooklyn.location.basic.SshMachineLocation

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class brooklyn.location.basic.SshMachineLocation

Throws:

IOException

string

public com.google.common.base.Objects.ToStringHelper string()

Overrides:

string in class brooklyn.location.basic.AbstractLocation

getSubnetHostname

public String getSubnetHostname()

Specified by:

getSubnetHostname in interface brooklyn.location.basic.HasSubnetHostname

getSubnetIp

public String getSubnetIp()

Specified by:

getSubnetIp in interface brooklyn.location.basic.HasSubnetHostname