clocker.docker.entity.container

Interface DockerContainer

All Superinterfaces:

org.apache.brooklyn.entity.stock.BasicStartable, org.apache.brooklyn.api.objs.BrooklynObject, org.apache.brooklyn.api.objs.Configurable, org.apache.brooklyn.api.entity.Entity, org.apache.brooklyn.util.net.HasNetworkAddresses, org.apache.brooklyn.api.objs.HasShortName, org.apache.brooklyn.api.objs.Identifiable, org.apache.brooklyn.core.location.dynamic.LocationOwner<DockerContainerLocation,DockerContainer>, org.apache.brooklyn.core.entity.trait.Startable

All Known Implementing Classes:

DockerContainerImpl

public interface DockerContainer
extends org.apache.brooklyn.entity.stock.BasicStartable, org.apache.brooklyn.util.net.HasNetworkAddresses, org.apache.brooklyn.api.objs.HasShortName, org.apache.brooklyn.core.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 org.apache.brooklyn.entity.stock.BasicStartable

org.apache.brooklyn.entity.stock.BasicStartable.LocationsFilter

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

org.apache.brooklyn.api.entity.Entity.AdjunctSupport<T extends org.apache.brooklyn.api.objs.EntityAdjunct>, org.apache.brooklyn.api.entity.Entity.EnricherSupport, org.apache.brooklyn.api.entity.Entity.GroupSupport, org.apache.brooklyn.api.entity.Entity.PolicySupport, org.apache.brooklyn.api.entity.Entity.SensorSupport

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

org.apache.brooklyn.core.entity.trait.Startable.RestartEffectorBody, org.apache.brooklyn.core.entity.trait.Startable.StartEffectorBody, org.apache.brooklyn.core.entity.trait.Startable.StopEffectorBody

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.api.entity.Entity>	CONTAINER
static org.apache.brooklyn.api.sensor.AttributeSensor<Set<String>>	CONTAINER_ADDRESSES
static org.apache.brooklyn.api.sensor.AttributeSensor<Boolean>	CONTAINER_PAUSED
static org.apache.brooklyn.api.sensor.AttributeSensor<Boolean>	CONTAINER_RUNNING
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<Map<String,Object>,Map<String,Object>>	DOCKER_CONTAINER_ENVIRONMENT
static org.apache.brooklyn.api.sensor.AttributeSensor<String>	DOCKER_CONTAINER_ID
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_CONTAINER_NAME
static org.apache.brooklyn.config.ConfigKey<List<String>>	DOCKER_CONTAINER_VOLUME_EXPORT
static org.apache.brooklyn.config.ConfigKey<List<String>>	DOCKER_CONTAINER_VOLUMES_FROM
static org.apache.brooklyn.config.ConfigKey<Integer>	DOCKER_CPU_SHARES
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_HARDWARE_ID
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	DOCKER_HOST
static org.apache.brooklyn.config.ConfigKey<List<String>>	DOCKER_IMAGE_COMMANDS
static org.apache.brooklyn.config.ConfigKey<List<String>>	DOCKER_IMAGE_ENTRYPOINT
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_IMAGE_ID
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_IMAGE_NAME
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String>	DOCKER_IMAGE_TAG
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	DOCKER_INFRASTRUCTURE
static org.apache.brooklyn.config.ConfigKey<String>	DOCKER_LOGIN_PASSWORD
static org.apache.brooklyn.config.ConfigKey<Integer>	DOCKER_MEMORY
static org.apache.brooklyn.config.ConfigKey<Boolean>	DOCKER_USE_HOST_DNS_NAME
static org.apache.brooklyn.config.ConfigKey<Boolean>	DOCKER_USE_SSH
static org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	ENTITY
static org.apache.brooklyn.config.ConfigKey<Boolean>	INTERACTIVE
static org.apache.brooklyn.config.ConfigKey<Boolean>	MANAGED
static org.apache.brooklyn.core.effector.MethodEffector<Void>	PAUSE
static org.apache.brooklyn.config.ConfigKey<Boolean>	PRIVILEGED
static org.apache.brooklyn.core.effector.MethodEffector<Void>	RESUME
static org.apache.brooklyn.api.relations.RelationshipType<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity>	RUNNING
static org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.core.entity.lifecycle.Lifecycle>	SERVICE_STATE_ACTUAL
static org.apache.brooklyn.core.effector.MethodEffector<Void>	SHUT_DOWN
static org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.location.ssh.SshMachineLocation>	SSH_MACHINE_LOCATION

Fields inherited from interface org.apache.brooklyn.entity.stock.BasicStartable

LOCATIONS_FILTER, START_LATCH

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

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

DYNAMIC_LOCATION, DYNAMIC_LOCATION_STATUS, 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()
org.apache.brooklyn.location.ssh.SshMachineLocation	getMachine()
org.apache.brooklyn.api.entity.Entity	getRunningEntity()
void	pause() Pause the Docker container.
void	resume() Resume the Docker container.
void	setRunningEntity(org.apache.brooklyn.api.entity.Entity entity)
void	shutDown() Shut-down the Docker container.

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

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

restart, start, stop

Methods inherited from interface org.apache.brooklyn.util.net.HasNetworkAddresses

getHostname, getPrivateAddresses, getPublicAddresses

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

getShortName

Methods inherited from interface org.apache.brooklyn.core.location.dynamic.LocationOwner

createLocation, deleteLocation, getDynamicLocation, isLocationAvailable

Field Detail

DOCKER_HOST

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> DOCKER_HOST

DOCKER_INFRASTRUCTURE

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> DOCKER_INFRASTRUCTURE

DOCKER_CONTAINER_NAME

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_CONTAINER_NAME

PRIVILEGED

static final org.apache.brooklyn.config.ConfigKey<Boolean> PRIVILEGED

INTERACTIVE

static final org.apache.brooklyn.config.ConfigKey<Boolean> INTERACTIVE

MANAGED

static final org.apache.brooklyn.config.ConfigKey<Boolean> MANAGED

DOCKER_LOGIN_PASSWORD

static final org.apache.brooklyn.config.ConfigKey<String> DOCKER_LOGIN_PASSWORD

DOCKER_IMAGE_ID

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_IMAGE_ID

DOCKER_IMAGE_NAME

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_IMAGE_NAME

DOCKER_IMAGE_TAG

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_IMAGE_TAG

DOCKER_IMAGE_ENTRYPOINT

static final org.apache.brooklyn.config.ConfigKey<List<String>> DOCKER_IMAGE_ENTRYPOINT

DOCKER_IMAGE_COMMANDS

static final org.apache.brooklyn.config.ConfigKey<List<String>> DOCKER_IMAGE_COMMANDS

DOCKER_HARDWARE_ID

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<String,String> DOCKER_HARDWARE_ID

DOCKER_USE_HOST_DNS_NAME

static final org.apache.brooklyn.config.ConfigKey<Boolean> DOCKER_USE_HOST_DNS_NAME

DOCKER_USE_SSH

static final org.apache.brooklyn.config.ConfigKey<Boolean> DOCKER_USE_SSH

DOCKER_CPU_SHARES

static final org.apache.brooklyn.config.ConfigKey<Integer> DOCKER_CPU_SHARES

DOCKER_MEMORY

static final org.apache.brooklyn.config.ConfigKey<Integer> DOCKER_MEMORY

DOCKER_CONTAINER_VOLUME_EXPORT

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

DOCKER_CONTAINER_VOLUMES_FROM

static final org.apache.brooklyn.config.ConfigKey<List<String>> DOCKER_CONTAINER_VOLUMES_FROM

DOCKER_CONTAINER_ENVIRONMENT

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<Map<String,Object>,Map<String,Object>> DOCKER_CONTAINER_ENVIRONMENT

ENTITY

static final org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> ENTITY

DOCKER_CONTAINER_ID

static final org.apache.brooklyn.api.sensor.AttributeSensor<String> DOCKER_CONTAINER_ID

CONTAINER_ADDRESSES

static final org.apache.brooklyn.api.sensor.AttributeSensor<Set<String>> CONTAINER_ADDRESSES

CONTAINER

static final org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.api.entity.Entity> CONTAINER

CONTAINER_RUNNING

static final org.apache.brooklyn.api.sensor.AttributeSensor<Boolean> CONTAINER_RUNNING

CONTAINER_PAUSED

static final org.apache.brooklyn.api.sensor.AttributeSensor<Boolean> CONTAINER_PAUSED

SERVICE_STATE_ACTUAL

static final org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.core.entity.lifecycle.Lifecycle> SERVICE_STATE_ACTUAL

SSH_MACHINE_LOCATION

static final org.apache.brooklyn.api.sensor.AttributeSensor<org.apache.brooklyn.location.ssh.SshMachineLocation> SSH_MACHINE_LOCATION

SHUT_DOWN

static final org.apache.brooklyn.core.effector.MethodEffector<Void> SHUT_DOWN

PAUSE

static final org.apache.brooklyn.core.effector.MethodEffector<Void> PAUSE

RESUME

static final org.apache.brooklyn.core.effector.MethodEffector<Void> RESUME

RUNNING

static final org.apache.brooklyn.api.relations.RelationshipType<org.apache.brooklyn.api.entity.Entity,org.apache.brooklyn.api.entity.Entity> RUNNING

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

org.apache.brooklyn.api.entity.Entity getRunningEntity()

setRunningEntity

void setRunningEntity(org.apache.brooklyn.api.entity.Entity entity)

getDockerHost

DockerHost getDockerHost()

getMachine

org.apache.brooklyn.location.ssh.SshMachineLocation getMachine()