brooklyn.entity.container.docker

Interface DockerContainer

All Superinterfaces:

brooklyn.entity.basic.BasicStartable, brooklyn.basic.BrooklynObject, brooklyn.entity.trait.Configurable, brooklyn.entity.Entity, brooklyn.util.net.HasNetworkAddresses, brooklyn.entity.trait.HasShortName, brooklyn.entity.trait.Identifiable, brooklyn.location.dynamic.LocationOwner<DockerContainerLocation,DockerContainer>, brooklyn.entity.trait.Startable

All Known Implementing Classes:

DockerContainerImpl

public interface DockerContainer
extends brooklyn.entity.basic.BasicStartable, brooklyn.util.net.HasNetworkAddresses, brooklyn.entity.trait.HasShortName, brooklyn.location.dynamic.LocationOwner<DockerContainerLocation,DockerContainer>

A Docker container.

This entity controls the DockerContainerLocation location, and creates and the JcloudsSshMachineLocation that entities communicate with when deployed to the DockerInfrastructure.

Nested Class Summary

Nested classes/interfaces inherited from interface brooklyn.entity.basic.BasicStartable

brooklyn.entity.basic.BasicStartable.LocationsFilter

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.entity.trait.Startable

brooklyn.entity.trait.Startable.RestartEffectorBody, brooklyn.entity.trait.Startable.StartEffectorBody, brooklyn.entity.trait.Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static brooklyn.event.AttributeSensor<brooklyn.entity.Entity>	CONTAINER
static brooklyn.event.AttributeSensor<Set<String>>	CONTAINER_ADDRESSES
static brooklyn.event.AttributeSensor<String>	CONTAINER_ID
static brooklyn.event.AttributeSensor<Boolean>	CONTAINER_PAUSED
static brooklyn.event.AttributeSensor<Boolean>	CONTAINER_RUNNING
static brooklyn.config.ConfigKey<Map<String,Object>>	DOCKER_CONTAINER_ENVIRONMENT
static brooklyn.event.basic.AttributeSensorAndConfigKey<String,String>	DOCKER_CONTAINER_NAME
static brooklyn.config.ConfigKey<String>	DOCKER_CONTAINER_NAME_FORMAT
static brooklyn.config.ConfigKey<List<String>>	DOCKER_CONTAINER_VOLUME_EXPORT
static brooklyn.config.ConfigKey<Integer>	DOCKER_CPU_SHARES
static brooklyn.config.ConfigKey<String>	DOCKER_HARDWARE_ID
static brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity>	DOCKER_HOST
static brooklyn.config.ConfigKey<String>	DOCKER_IMAGE_ID
static brooklyn.config.ConfigKey<String>	DOCKER_IMAGE_NAME
static brooklyn.config.ConfigKey<String>	DOCKER_IMAGE_TAG
static brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity>	DOCKER_INFRASTRUCTURE
static brooklyn.config.ConfigKey<Integer>	DOCKER_MEMORY
static brooklyn.config.ConfigKey<String>	DOCKER_PASSWORD
static brooklyn.config.ConfigKey<Boolean>	DOCKER_USE_HOST_DNS_NAME
static brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity>	ENTITY
static brooklyn.event.AttributeSensor<String>	HARDWARE_ID
static brooklyn.event.AttributeSensor<String>	IMAGE_ID
static brooklyn.event.AttributeSensor<String>	IMAGE_NAME
static brooklyn.config.ConfigKey<Boolean>	MANAGED
static brooklyn.entity.basic.MethodEffector<Void>	PAUSE
static brooklyn.entity.basic.MethodEffector<Void>	RESUME
static brooklyn.event.AttributeSensor<brooklyn.entity.basic.Lifecycle>	SERVICE_STATE_ACTUAL
static brooklyn.entity.basic.MethodEffector<Void>	SHUT_DOWN
static brooklyn.event.AttributeSensor<brooklyn.location.basic.SshMachineLocation>	SSH_MACHINE_LOCATION

Fields inherited from interface brooklyn.entity.basic.BasicStartable

LOCATIONS_FILTER

Fields inherited from interface brooklyn.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Fields inherited from interface brooklyn.location.dynamic.LocationOwner

DYNAMIC_LOCATION, DYNAMIC_LOCATION_STATUS, LOCATION_DEFINITION, LOCATION_FLAGS, LOCATION_NAME, LOCATION_NAME_PREFIX, LOCATION_NAME_SUFFIX, LOCATION_SPEC

Method Summary

Methods

Modifier and Type	Method and Description
String	getContainerId()
String	getDockerContainerName()
DockerHost	getDockerHost()
brooklyn.location.basic.SshMachineLocation	getMachine()
brooklyn.entity.Entity	getRunningEntity()
void	pause() Pause the Docker container.
void	resume() Resume the Docker container.
void	setRunningEntity(brooklyn.entity.Entity entity)
void	shutDown() Shut-down the Docker container.

Methods inherited from interface brooklyn.entity.Entity

addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, addTag, clearParent, containsTag, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getTags, invoke, removeChild, removeEnricher, removeGroup, removePolicy, removeTag, 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.entity.trait.Startable

restart, start, stop

Methods inherited from interface brooklyn.util.net.HasNetworkAddresses

getHostname, getPrivateAddresses, getPublicAddresses

Methods inherited from interface brooklyn.entity.trait.HasShortName

getShortName

Methods inherited from interface brooklyn.location.dynamic.LocationOwner

createLocation, deleteLocation, getDynamicLocation, isLocationAvailable

Field Detail

DOCKER_HOST

static final brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity> DOCKER_HOST

DOCKER_INFRASTRUCTURE

static final brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity> DOCKER_INFRASTRUCTURE

DOCKER_CONTAINER_NAME

static final brooklyn.event.basic.AttributeSensorAndConfigKey<String,String> DOCKER_CONTAINER_NAME

MANAGED

static final brooklyn.config.ConfigKey<Boolean> MANAGED

DOCKER_PASSWORD

static final brooklyn.config.ConfigKey<String> DOCKER_PASSWORD

DOCKER_IMAGE_ID

static final brooklyn.config.ConfigKey<String> DOCKER_IMAGE_ID

DOCKER_IMAGE_NAME

static final brooklyn.config.ConfigKey<String> DOCKER_IMAGE_NAME

DOCKER_IMAGE_TAG

static final brooklyn.config.ConfigKey<String> DOCKER_IMAGE_TAG

DOCKER_HARDWARE_ID

static final brooklyn.config.ConfigKey<String> DOCKER_HARDWARE_ID

DOCKER_USE_HOST_DNS_NAME

static final brooklyn.config.ConfigKey<Boolean> DOCKER_USE_HOST_DNS_NAME

DOCKER_CPU_SHARES

static final brooklyn.config.ConfigKey<Integer> DOCKER_CPU_SHARES

DOCKER_MEMORY

static final brooklyn.config.ConfigKey<Integer> DOCKER_MEMORY

DOCKER_CONTAINER_VOLUME_EXPORT

static final brooklyn.config.ConfigKey<List<String>> DOCKER_CONTAINER_VOLUME_EXPORT

DOCKER_CONTAINER_ENVIRONMENT

static final brooklyn.config.ConfigKey<Map<String,Object>> DOCKER_CONTAINER_ENVIRONMENT

ENTITY

static final brooklyn.event.basic.AttributeSensorAndConfigKey<brooklyn.entity.Entity,brooklyn.entity.Entity> ENTITY

DOCKER_CONTAINER_NAME_FORMAT

static final brooklyn.config.ConfigKey<String> DOCKER_CONTAINER_NAME_FORMAT

IMAGE_ID

static final brooklyn.event.AttributeSensor<String> IMAGE_ID

IMAGE_NAME

static final brooklyn.event.AttributeSensor<String> IMAGE_NAME

HARDWARE_ID

static final brooklyn.event.AttributeSensor<String> HARDWARE_ID

CONTAINER_ID

static final brooklyn.event.AttributeSensor<String> CONTAINER_ID

CONTAINER_ADDRESSES

static final brooklyn.event.AttributeSensor<Set<String>> CONTAINER_ADDRESSES

CONTAINER

static final brooklyn.event.AttributeSensor<brooklyn.entity.Entity> CONTAINER

CONTAINER_RUNNING

static final brooklyn.event.AttributeSensor<Boolean> CONTAINER_RUNNING

CONTAINER_PAUSED

static final brooklyn.event.AttributeSensor<Boolean> CONTAINER_PAUSED

SERVICE_STATE_ACTUAL

static final brooklyn.event.AttributeSensor<brooklyn.entity.basic.Lifecycle> SERVICE_STATE_ACTUAL

SSH_MACHINE_LOCATION

static final brooklyn.event.AttributeSensor<brooklyn.location.basic.SshMachineLocation> SSH_MACHINE_LOCATION

SHUT_DOWN

static final brooklyn.entity.basic.MethodEffector<Void> SHUT_DOWN

PAUSE

static final brooklyn.entity.basic.MethodEffector<Void> PAUSE

RESUME

static final brooklyn.entity.basic.MethodEffector<Void> RESUME

Method Detail

shutDown

void shutDown()

Shut-down the Docker container.

pause

void pause()

Pause the Docker container.

resume

void resume()

Resume the Docker container.

getDockerContainerName

String getDockerContainerName()

getContainerId

String getContainerId()

getRunningEntity

brooklyn.entity.Entity getRunningEntity()

setRunningEntity

void setRunningEntity(brooklyn.entity.Entity entity)

getDockerHost

DockerHost getDockerHost()

getMachine

brooklyn.location.basic.SshMachineLocation getMachine()