stringList

Type for list of string.

intList

Type for list of integers.

errorType

Standard Docker error info.

graphDriverType

Container for graphDriverDataType

Implemented as a map, see Bindings section below.

graphDriverDataType

Docker Graph driver configuration (Output from inspecting an image or container).

Partial output from the Inspect a container (v1.28) operation.

Defined Docker type: GraphDriverData

weightDeviceType

Partial output from the Inspect a container (v1.28) operation.

Defined Docker type: WeightDevice

throttleDeviceType

Partial output from the Inspect a container (v1.28) operation.

Defined Docker type: ThrottleDevice

MountType

Partial output from the Inspect a container (v1.28) operation.

Used by the schema types

• containerJsonType
• hostConfigType
• listedContainerType

Defined Docker type: Mount

EndpointSettings

Partial output from the Inspect a container (v1.28) operation.

EndpointSettings stores the network endpoint details.

Network output from the List containers (v1.37) operation.

Value in map. Used by the schema type inspectedContainerNetworkSettingsNetworkType.

jsonProgressType

JSONProgress describes a Progress.

Detailed info about progress during image creation. Partial output from image creation.

Used by the schema type jsonMessageType.

Defined Docker type: JSONProgress

jsonErrorType

JSONError wraps a concrete Code and Message, Code is is an integer error code, Message is the error message

Used by the schema type jsonMessageType.

Defined Docker type: JSONError

jsonRawMessageType

Corresponds to json.RawMessage which is a standard in the GO package encoding/json.

Used by the schema type jsonMessageType.

Defined Go type: json.RawMessage

portSetType

PortSet is a collection of structs indexed by Port.

Used by the schema type containerConfigurationType.

• inspectedContainerNetworkSettingsType.

  Defined Docker type: PortSet

portSetElementNullValueType

Null value for port in port set.

Used by the schema type portSetElementType.

Defined Docker type: struct

portMapType

Element in port set. The value isn't used by Docker, but a null value (an object) must be defined.

Used by the schema types:

• hostConfigType.
• inspectedContainerNetworkSettingsType.

Defined Docker type: PortMap

portMapElementType

Port map element. The value is a port binding.

The JSON marshalled from this type when the Docker REST API is invoked requires a map with values with the format: { "22/tcp": [{ "HostPort": "11022" }] } . To support this requirement the binding type defines a key (XML element named port) and value (XML element named binding). The value is of the type portBindingType.

Used by the schema type portMapType.

No corresponding Docker type.

portBindingType

PortBinding represents a binding between a Host IP address and a Host Port.

Used by the schema type portMapElementType.

Defined Docker type: PortBinding

stringMapType

Map with string keys and string value.

Used by the schema types:

• TODO.

Defined Docker type: map[string]string.

stringMapElementType

String map element. The value is a string.

Used by the schema type stringMapType.

No corresponding Docker type.

imageMetadataType

ImageMetadata contains engine-local data about the image.

Used by the schema type imageInspectType.

Defined Docker type: ImageMetadata

deviceMappingType

DeviceMapping represents the device mapping between the host and the container.

Used by the schema type hostConfigType.

Defined Docker type: DeviceMapping

listedImageType

Info about a listed Docker image.

Output from the Inspect an image (v1.28) operation.

ImageInspectType

Info about an inspected Docker image.

Output from the Inspect an image (v1.28) operation.

Defined Docker type: ImageInspect

jsonMessageType

Info about Docker image creation progress.

Defined Docker type: JSONMessage

imageDeletionType

Info about Docker image deletion progress.

listedContainerType

Info about a listed Docker container.

Output from listing containers.

Defined Docker type: Container

containerConfigurationType

Info about Docker container configuration.

Input to container creation and output from container and image inspection. Used by these schema types:

• imageInspectType

Defined Docker type: container.Config

containerJson

Info about an inspected Docker container.

Partial output from the Inspect a container (v1.28) operation.

Defined Docker type: ContainerJSON

containerConfigurationType

Docker container and image configuration.

Partial output from the Inspect a container (v1.28) and Inspect an image (v1.28) operations.

Defined Docker type: HostConfig

Used by these schema types:

• containerJsonType (TODO: refactoring still pending, issue #112)
• imageInspectType

HealthConfigType

Configuration settings for the healthcheck feature for a Docker container.

Partial output from the Inspect a container (v1.28) operation.

Defined Docker type: HostConfig

Used by these schema types:

• containerConfigurationType

hostConfigType

Info about the host configuration of a Docker container.

Partial output from the Inspect a container (v1.37) operation.

Defined Docker type: HostConfig

Used by these schema types:

• containerConfigurationType
• containerJsonType
• listedContainerType

logConfigType

LogConfig represents the logging configuration of the container.

Partial output from the Inspect a container (v1.37) operation.

Defined Docker type: LogConfig

Used by these schema types:

• hostConfigType

restartPolicyType

RestartPolicy represents the restart policies of the container.

Partial output from the Inspect a container (v1.37) operation.

Defined Docker type: RestartPolicy

Used by these schema types:

• hostConfigType

TODO: rewrite from here:

The schema contains these types for handling container:

• containerConfigurationLabelType - Docker container configuration of a label (Input to container creation, output from container inspection and listing of containers). The JSON marshalled from this type when the Docker REST API is invoked requires a map with values with the format: { string : string }. To support this requirement the label type defines a key and value
• containerConfigurationLabelsType - Docker container configuration of a map of labels (Input to container creation, output from container inspection and listing of containers). Each label is defined using the containerConfigurationLabelType. During marshalling the type is bound to the map ContainerConfigurationLabelsMap using the ContainerConfigurationLabelsMapAdapter.
• containerConfigurationVolumeType - Docker container configuration of a mounted volume (Input to container creation and output from container inspection). The JSON marshalled from this type when the Docker REST API is invoked requires a map with where string keys defined a mount points with null object values. To support this requirement the exposed port type defines a volume key and a null value . To generate the null object for the value the containerConfigurationVolumeNullValueType is used.
• containerConfigurationVolumeNullValueType - Null value for volume (Input to container creation and output from container inspection).
• containerConfigurationVolumesType - Docker container configuration of a map of volumes (Input to container creation and output from container inspection). Each volume is defined using the containerConfigurationVolumeType. During marshalling the type is bound to the map ContainerConfigurationVolumesMap using the ContainerConfigurationVolumesMapAdapter.
• createdContainerType - Info about created Docker container (Output from container creation).
• listedContainerType - Info about a listed Docker container (Output from listing containers).
• listedContainerPortType - Info about a port from a container info (Partial output from listing a container).
• inspectedContainerStateType - Info about the state of a Docker container (Partial output from inspecting a containers).
• inspectedContainerNetworkSettingsType - Info about the network configuration of a Docker container (Partial output from inspecting a containers).
• inspectedContainerNetworkSettingsNetworkType - Info about a Docker container network from a container inspection info. The JSON marshalled from this type when the Docker REST API is invoked requires a map with where string keys defines the driver with network object values. To support this requirement the networks type defines a driver key and a network value
• inspectedContainerNetworkSettingsNetworkType - Docker container configuration of a map of container networks from container inspection. Each volume is defined using the inspectedContainerNetworkSettingsNetworkType. During marshalling the type is bound to the map InspectedContainerNetworkSettingsNetworksMap using the InspectedContainerNetworkSettingsNetworksMapAdapter.

  TODO: inspectedContainerNetworkSettingsType

Exposed ports

To support binding of schema element containerConfigurationType.exposedPorts to a map, the binding is customised to bind to the custom map PortSetMap using the custom JABX adaptor PortSetMapAdapter.

Labels

To support binding of schema element containerConfigurationType.labels to a map, the binding is customised to bind to the custom map ContainerConfigurationLabelsMap using the custom JABX adaptor ContainerConfigurationLabelsMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

To support binding of schema element listedContainerType.labels to a map, the binding is customised to bind to the custom map ContainerConfigurationLabelsMap using the custom JABX adaptor ContainerConfigurationLabelsMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

To support binding of schema element inspectedImageContainerType.labels to a map, the binding is customised to bind to the custom map ContainerConfigurationLabelsMap using the custom JABX adaptor ContainerConfigurationLabelsMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

To support binding of schema element listedImageType.labels to a map, the binding is customised to bind to the custom map ContainerConfigurationLabelsMap using the custom JABX adaptor ContainerConfigurationLabelsMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

To support binding of schema element InspectedContainerNetworkSettingsNetworkValue.driverOpts to a map, the binding is customised to bind to the custom map StringMapMap using the custom JABX adaptor StringMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

To support binding of schema element logConfigType.config to a map, the binding is customised to bind to the custom map StringMapMap using the custom JABX adaptor StringMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

Port binding

To support binding of schema element hostConfigType.portBindings to a map, the binding is customised to bind to the custom map PortMapMap using the custom JABX adaptor PortMapMapAdapter.

To support binding of schema element inspectedContainerNetworkSettingsType.ports to a map, the binding is customised to bind to the custom map PortMapMap using the custom JABX adaptor PortMapMapAdapter.

Restart policy

TODO:..

Volumes

To support binding of containerConfigurationType.volumes to a map, the binding is customised to bind to the custom map ContainerConfigurationVolumesMap>> using the custom JABX adaptor <<<ContainerConfigurationVolumesMapAdapter.

Network

To support binding of schema element inspectedContainerNetworkSettingsType.networks to a map, the binding is customised to bind to the custom map InspectedContainerNetworkSettingsNetworksMap using the custom JABX adaptor InspectedContainerNetworkSettingsNetworksMapAdapter.

GraphDriver Data

To support binding of schema element inspectedImageGraphDriverType.data to a map, the binding is customised to bind to the custom map GraphDriverDataMap using the custom JABX adaptor GraphDriverDataMapAdapter. The map and JAXB adaptor is shared with the other bindings in the section.

Minimal JSON marshalling

The Docker remote API favors invocation only with fields which are changed or defined with meaningful information. The Jackson marshaller used by the Spring REST template to marshall JSON is configured only to serialize non-null and non-default values when invoking a Docker host, using the serializationInclusion property:

<bean id="jacksonObjectMapper" class="com.fasterxml.jackson.databind.ObjectMapper">
        <property name="propertyNamingStrategy">                        
                <bean class="com.alpha.pineapple.docker.utils.UpperCaseStyleStrategy" />
        </property>
        <property name="serializationInclusion">
        <value type="com.fasterxml.jackson.annotation.JsonInclude.Include">NON_DEFAULT</value>
        </property>
</bean> 

Handling multiple JSON responses during creation of a Docker image

The method httpPostForObjectWithMultipleRootElements(..) is used to create a Docker image from the CreateImageCommand. The Docker REST API doesn't returns a valid JSON but a string containing multiple JSON responses.

RestTemplate configured with a Jackson message converter ins't able to parse the string. To parse the set of JSON responses in the string, the string is first transformed into a JSON array by:

• The string is decorated with JSON array delimiters
• All carriage returns and new line chars are removed.
• A comma is add between every array entry.

The created JSON array is then marshalled by the Jackson JSON object mapper (the Spring bean is named jacksonObjectMapperForRestTemplateWithoutMessageConverters) into objects and returned.

Error Handling

The package com.alpha.pineapple.docker.utils contains classes to improve the error handling from for RestTemlpate:

• RestResponseErrorHandler which implements the ResponseErrorHandler interface to provide a customised error handler for exceptions returned by RestTemplate. The error handle captures the exception from RestTemplate and information from the HTTP response. The handler then throws a RestResponseException with all the collected data.
• RestResponseException used to signal an error invoking REST request or received a response.

JSON marshalling

The package com.alpha.pineapple.docker.utils also contains helper classes used during marshalling JSON to objects:

• CapitaliseStyleStrategy implements the Jackson PropertyNamingStrategy interface to provide a customised property naming strategy during marshalling. The strategy generates capitalised target attribute names in objects for for JSON attribute to be mapped to. The class is used by the RestTemplate> use to invoke the Docker API. Special cases:
  • If the target object attribute is ListedImage.id then the received JSON property Id is mapped to to the target attribute id.
  • If the target object attribute is CreatedContainer.id then the received JSON property Id is mapped to to the target attribute id.
  • If the target object attribute is HostConfig.utsMode then the received JSON property UTSMode is mapped to to the target attribute utsMode.
  • If the target object attribute is HostConfig.ioMaximumBandwidth then the received JSON property IOMaximumBandwidth is mapped to to the target attribute ioMaximumBandwidth.
  • If the target object attribute is HostConfig.ioMaximumIOps then the received JSON property IOMaximumIOps is mapped to to the target attribute ioMaximumIOps.
  • If the target object attribute is InspectedContainerNetworkSettings.ipAddress then the received JSON property IPAddress is mapped to to the target attribute ipAddress.
  • If the target object attribute is InspectedContainerNetworkSettings.ipPrefixLen then the received JSON property IPPrefixLen is mapped to to the target attribute ipPrefixLen.
  • If the target object attribute is InspectedContainerNetworkSettings.ipv6Gateway then the received JSON property IPv6Gateway is mapped to to the target attribute ipv6Gateway.
  • If the target object attribute is InspectedContainerNetworkSettings.endpointId then the received JSON property EndpointID is mapped to to the target attribute endpointId.
  • If the target object attribute is InspectedContainerNetworkSettings.networkId then the received JSON property NetworkID is mapped to to the target attribute networkId.
  • If the target object attribute is InspectedContainerNetworkSettings.sandboxId then the received JSON property SandboxID is mapped to to the target attribute sandboxId.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.ipAddress then the received JSON property IPAddress is mapped to to the target attribute ipAddress.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.ipPrefixLen then the received JSON property IPPrefixLen is mapped to to the target attribute ipPrefixLen.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.ipv6Gateway then the received JSON property IPv6Gateway is mapped to to the target attribute ipv6Gateway.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.endpointId then the received JSON property EndpointID is mapped to to the target attribute endpointId.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.globalIpv6Address then the received JSON property GlobalIPv6Address is mapped to to the target attribute globalIpv6Address.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.globalIpv6PrefixLen then the received JSON property GlobalIPv6PrefixLen is mapped to to the target attribute globalIpv6PrefixLen.
  • If the target object attribute is InspectedContainerNetworkSettingsNetworkValue.ipamConfig then the received JSON property IPAMConfig is mapped to to the target attribute ipamConfig.
  • If the target object attribute is *.ip then the received JSON property IP is mapped to to the target attribute ip.
  • If the target object attribute is InspectedContainerState.oomKilled then the received JSON property OOMKilled is mapped to to the target attribute oomKilled.
  • If the target object attribute is ListedContainer.imageId then the received JSON property ImageID is mapped to to the target attribute imageId.
  • If the target object attribute is Mount.rw then the received JSON property RW is mapped to to the target attribute rw.
• MultipleRootElementsStyleStrategy implements the Jackson PropertyNamingStrategy interface to provide a customised property naming strategy during marshalling. The strategy DON'T capitalised target attribute names in objects for for JSON attribute to be mapped to. Instead it lets the property names be lower case since that is required to map JSON received by the Docker API. The class is used by the DockertSessionImpl.httpPostForObjectWithMultipleRootElements(..) to parse responses from Docker which doesn't contains a valid JSON but a string containing multiple JSON responses.

  Special cases:

  • If the target object attribute is JsonRawMessage.id then the received JSON property ID is mapped to to the target attribute id.

BuildImageCommand

Command which can create a Docker image, from TAR archive which contains a DockerFile.

The command is invoked with a TAR archive (which must contain a Dockerfile in a root directory) and a ImageInfo object which is used to tag the image created from the Dockerfile.

CreateImageCommand

Command which can create a Docker image, either by pulling it from the registry or by importing it.

The command is invoked with a ImageInfo object which defines an image through a Docker repository and image tag.

Example of official repository name is ubuntu which holds Ubuntu images.

Example of user repository (which has the name format user/repo) is mrpono/pineapple.

Example of image tags are: latest and 12.10.

CreateTaggedImageCommand

Command which can create a Docker image from an existing image.

The command is invoked with:

• Source ImageInfo object which defines an image through a Docker repository and image tag.
• Target ImageInfo object which defines an image through a Docker repository and image tag. The value of the image tag is current ignored, since the created image will be created with the latest tag.

When the command is executes a Docker image is created in the repository named by the repository value in the target image info object. The image is created with the latest tag. The image is a tagged copy of the image defined in the source image object. The two images shares the same image ID.

DockerHelper

When the createDefaultSession() method is invoked then a session to a Docker daemon at 192.168.99.11:8082 is created. For more details, see the Pineapple Test Infrastructure.