clocker.docker.location

Class DockerContainerLocation

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.location.AbstractLocation

org.apache.brooklyn.location.ssh.SshMachineLocation

clocker.docker.location.DockerContainerLocation

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.brooklyn.api.location.AddressableLocation, org.apache.brooklyn.api.location.Location, org.apache.brooklyn.api.location.MachineLocation, org.apache.brooklyn.api.location.PortSupplier, org.apache.brooklyn.api.mgmt.rebind.Rebindable, org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.api.objs.Identifiable, org.apache.brooklyn.core.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>, org.apache.brooklyn.core.location.geo.HasHostGeoInfo, org.apache.brooklyn.core.location.HasSubnetHostname, org.apache.brooklyn.core.location.internal.LocationInternal, org.apache.brooklyn.core.location.SupportsPortForwarding, org.apache.brooklyn.core.objs.BrooklynObjectInternal, org.apache.brooklyn.util.core.mutex.WithMutexes, org.apache.brooklyn.util.net.HasNetworkAddresses

public class DockerContainerLocation
extends org.apache.brooklyn.location.ssh.SshMachineLocation
implements org.apache.brooklyn.core.location.SupportsPortForwarding, org.apache.brooklyn.core.location.HasSubnetHostname, org.apache.brooklyn.core.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.

Nested Class Summary

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

org.apache.brooklyn.core.location.AbstractLocation.BasicSubscriptionSupport

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractBrooklynObject.BasicTagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.location.SupportsPortForwarding

org.apache.brooklyn.core.location.SupportsPortForwarding.RequiresPortForwarding

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

org.apache.brooklyn.api.objs.BrooklynObject.RelationSupport<T extends org.apache.brooklyn.api.objs.BrooklynObject>, org.apache.brooklyn.api.objs.BrooklynObject.SubscriptionSupport, org.apache.brooklyn.api.objs.BrooklynObject.TagSupport

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

org.apache.brooklyn.api.objs.Configurable.ConfigurationSupport

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

org.apache.brooklyn.core.objs.BrooklynObjectInternal.ConfigurationSupportInternal, org.apache.brooklyn.core.objs.BrooklynObjectInternal.RelationSupportInternal<T extends org.apache.brooklyn.api.objs.BrooklynObject>, org.apache.brooklyn.core.objs.BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

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

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

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

_subscriptionTracker, PARENT_LOCATION, TEMPORARY_LOCATION

Fields inherited from interface org.apache.brooklyn.core.location.dynamic.DynamicLocation

MAX_SUB_LOCATIONS, OWNER

Fields inherited from interface org.apache.brooklyn.core.location.internal.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	copyFrom(Map<String,?> props, String remote, String local)
int	copyTo(Map<String,?> props, File src, String destination)
int	copyTo(Map<String,?> props, InputStream src, long filesize, String destination)
int	copyTo(Map<String,?> props, InputStream src, String destination)
void	deregister()
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()
org.apache.brooklyn.location.jclouds.JcloudsSshMachineLocation	getMachine()
int	getMappedPort(int portNumber)
DockerContainer	getOwner()
Set<String>	getPrivateAddresses()
com.google.common.net.HostAndPort	getSocketEndpointFor(org.apache.brooklyn.util.net.Cidr accessor, int privatePort)
String	getSubnetHostname()
String	getSubnetIp()
void	init()
int	obtainPort(org.apache.brooklyn.api.location.PortRange range)
boolean	obtainSpecificPort(int portNumber)
org.apache.brooklyn.api.location.LocationDefinition	register()
void	releasePort(int portNumber)
com.google.common.base.Objects.ToStringHelper	string()

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

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

Methods inherited from class org.apache.brooklyn.core.location.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, relations, removeChild, setConfig, setDisplayName, setHostGeoInfo, setManagementContext, setName, setParent, setParent, subscriptions, toMetadataRecord

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

configure, getCatalogItemId, getId, getManagementContext, 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 org.apache.brooklyn.api.location.Location

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

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

getCatalogItemId, subscriptions, tags

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

config, getConfig, setConfig

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

getManagementContext

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

setCatalogItemId

Constructor Detail

DockerContainerLocation

public DockerContainerLocation()

Method Detail

init

public void init()

Overrides:

init in class org.apache.brooklyn.location.ssh.SshMachineLocation

register

public org.apache.brooklyn.api.location.LocationDefinition register()

Specified by:

register in interface org.apache.brooklyn.core.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>

deregister

public void deregister()

Specified by:

deregister in interface org.apache.brooklyn.core.location.dynamic.DynamicLocation<DockerContainer,DockerContainerLocation>

getOwner

public DockerContainer getOwner()

Specified by:

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

getMachine

public org.apache.brooklyn.location.jclouds.JcloudsSshMachineLocation getMachine()

getMappedPort

public int getMappedPort(int portNumber)

obtainSpecificPort

public boolean obtainSpecificPort(int portNumber)

Specified by:

obtainSpecificPort in interface org.apache.brooklyn.api.location.PortSupplier

Overrides:

obtainSpecificPort in class org.apache.brooklyn.location.ssh.SshMachineLocation

obtainPort

public int obtainPort(org.apache.brooklyn.api.location.PortRange range)

Specified by:

obtainPort in interface org.apache.brooklyn.api.location.PortSupplier

Overrides:

obtainPort in class org.apache.brooklyn.location.ssh.SshMachineLocation

getSocketEndpointFor

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

Specified by:

getSocketEndpointFor in interface org.apache.brooklyn.core.location.SupportsPortForwarding

execScript

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

Overrides:

execScript in class org.apache.brooklyn.location.ssh.SshMachineLocation

execCommands

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

Overrides:

execCommands in class org.apache.brooklyn.location.ssh.SshMachineLocation

copyTo

public int copyTo(Map<String,?> props,
         InputStream src,
         long filesize,
         String destination)

Overrides:

copyTo in class org.apache.brooklyn.location.ssh.SshMachineLocation

copyTo

public int copyTo(Map<String,?> props,
         InputStream src,
         String destination)

Overrides:

copyTo in class org.apache.brooklyn.location.ssh.SshMachineLocation

copyTo

public int copyTo(Map<String,?> props,
         File src,
         String destination)

Overrides:

copyTo in class org.apache.brooklyn.location.ssh.SshMachineLocation

copyFrom

public int copyFrom(Map<String,?> props,
           String remote,
           String local)

Overrides:

copyFrom in class org.apache.brooklyn.location.ssh.SshMachineLocation

releasePort

public void releasePort(int portNumber)

Specified by:

releasePort in interface org.apache.brooklyn.api.location.PortSupplier

Overrides:

releasePort in class org.apache.brooklyn.location.ssh.SshMachineLocation

getAddress

public InetAddress getAddress()

Specified by:

getAddress in interface org.apache.brooklyn.api.location.AddressableLocation

Specified by:

getAddress in interface org.apache.brooklyn.api.location.MachineLocation

Overrides:

getAddress in class org.apache.brooklyn.location.ssh.SshMachineLocation

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.brooklyn.location.ssh.SshMachineLocation

Throws:

IOException

string

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

Overrides:

string in class org.apache.brooklyn.core.location.AbstractLocation

getSubnetHostname

public String getSubnetHostname()

Specified by:

getSubnetHostname in interface org.apache.brooklyn.core.location.HasSubnetHostname

getPrivateAddresses

public Set<String> getPrivateAddresses()

Specified by:

getPrivateAddresses in interface org.apache.brooklyn.util.net.HasNetworkAddresses

Overrides:

getPrivateAddresses in class org.apache.brooklyn.location.ssh.SshMachineLocation

getSubnetIp

public String getSubnetIp()

Specified by:

getSubnetIp in interface org.apache.brooklyn.core.location.HasSubnetHostname