Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker

Class DockerPlatform

java.lang.Object

com.oracle.bedrock.extensible.AbstractExtensible

com.oracle.bedrock.runtime.AbstractPlatform

com.oracle.bedrock.runtime.docker.DockerPlatform

All Implemented Interfaces:

com.oracle.bedrock.extensible.Extensible, com.oracle.bedrock.runtime.Infrastructure, com.oracle.bedrock.runtime.Platform

Direct Known Subclasses:

DockerMachinePlatform

public class DockerPlatform
extends com.oracle.bedrock.runtime.AbstractPlatform

A Platform that can execute Docker commands using a specific Docker environment.

Copyright (c) 2016. All Rights Reserved. Oracle Corporation.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

Author:

Jonathan Knight

Constructor Summary

Constructors

Constructor	Description
DockerPlatform(com.oracle.bedrock.runtime.Platform clientPlatform, Docker docker, com.oracle.bedrock.Option... options)	Constructs a DockerPlatform.
DockerPlatform(String name, com.oracle.bedrock.runtime.Platform clientPlatform, Docker docker, com.oracle.bedrock.Option... options)	Constructs a DockerPlatform with a specific name.

Method Summary

Modifier and Type	Method	Description
static DockerPlatform	clientAt(com.oracle.bedrock.runtime.Platform platform, Docker environment)	Obtain a DockerPlatform using the specified client Platform and Docker environment.
InetAddress	getAddress()	Obtain the InetAddress of the Docker daemon.
protected <A extends com.oracle.bedrock.runtime.Application,B extends com.oracle.bedrock.runtime.ApplicationLauncher<A>> B	getApplicationLauncher(com.oracle.bedrock.runtime.MetaClass<A> metaClass, com.oracle.bedrock.OptionsByType optionsByType)
com.oracle.bedrock.runtime.Platform	getClientPlatform()	Obtain the Platform that is used to run Docker client commands.
Docker	getDocker()	Obtain the Docker environment being used by this DockerPlatform.
com.oracle.bedrock.runtime.OperatingSystem	getOperatingSystem()
<A extends com.oracle.bedrock.runtime.Application> A	launch(com.oracle.bedrock.runtime.MetaClass<A> metaClass, com.oracle.bedrock.Option... options)
static DockerPlatform	localClient()	Obtain a DockerPlatform using the LocalPlatform as the client Platform and automatically configuring the Docker environment.
static DockerPlatform	localClient(Docker environment)	Obtain a DockerPlatform using the LocalPlatform as the client Platform and using the specified Docker environment.

Methods inherited from class com.oracle.bedrock.runtime.AbstractPlatform

getName, getOptions

Methods inherited from class com.oracle.bedrock.extensible.AbstractExtensible

add, add, get, getInstancesOf, has, remove, removeAllFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bedrock.runtime.Platform

getPlatform, launch, launch

Constructor Detail

DockerPlatform

public DockerPlatform(com.oracle.bedrock.runtime.Platform clientPlatform,
                      Docker docker,
                      com.oracle.bedrock.Option... options)

Constructs a DockerPlatform.

Parameters:

clientPlatform - the client Platform

docker - the Docker

options - the Options

DockerPlatform

public DockerPlatform(String name,
                      com.oracle.bedrock.runtime.Platform clientPlatform,
                      Docker docker,
                      com.oracle.bedrock.Option... options)

Constructs a DockerPlatform with a specific name.

Parameters:

name - the name

clientPlatform - the client Platform

docker - the Docker

options - the Options

Method Detail

getClientPlatform

public com.oracle.bedrock.runtime.Platform getClientPlatform()

Obtain the Platform that is used to run Docker client commands.

Returns:

the Platform that is used to run Docker client commands

getDocker

public Docker getDocker()

Obtain the Docker environment being used by this DockerPlatform.

Returns:

the Docker environment being used by this DockerPlatform

getOperatingSystem

public com.oracle.bedrock.runtime.OperatingSystem getOperatingSystem()

getAddress

public InetAddress getAddress()

Obtain the InetAddress of the Docker daemon.

Returns:

the InetAddress of the Docker daemon.

launch

public <A extends com.oracle.bedrock.runtime.Application> A launch(com.oracle.bedrock.runtime.MetaClass<A> metaClass,
                                                                   com.oracle.bedrock.Option... options)

Specified by:

launch in interface com.oracle.bedrock.runtime.Platform

Overrides:

launch in class com.oracle.bedrock.runtime.AbstractPlatform

getApplicationLauncher

protected <A extends com.oracle.bedrock.runtime.Application,B extends com.oracle.bedrock.runtime.ApplicationLauncher<A>> B getApplicationLauncher(com.oracle.bedrock.runtime.MetaClass<A> metaClass,
                                                                                                                                                        com.oracle.bedrock.OptionsByType optionsByType)
                                                                                                                                                 throws UnsupportedOperationException

Specified by:

getApplicationLauncher in class com.oracle.bedrock.runtime.AbstractPlatform

Throws:

UnsupportedOperationException

localClient

public static DockerPlatform localClient()

Obtain a DockerPlatform using the LocalPlatform as the client Platform and automatically configuring the Docker environment.

Returns:

a DockerPlatform using the LocalPlatform as the client Platform

localClient

public static DockerPlatform localClient(Docker environment)

Obtain a DockerPlatform using the LocalPlatform as the client Platform and using the specified Docker environment.

Parameters:

environment - the Docker environment to use when executing Docker commands

Returns:

a DockerPlatform using the LocalPlatform as the client Platform and the specified Docker environment

clientAt

public static DockerPlatform clientAt(com.oracle.bedrock.runtime.Platform platform,
                                      Docker environment)

Obtain a DockerPlatform using the specified client Platform and Docker environment.

Parameters:

platform - the Platform to execute Docker client commands on

environment - the Docker environment to use when executing Docker commands

Returns:

a DockerPlatform using the specified client Platform and Docker environment