Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker.machine

Class DockerMachinePlatform

java.lang.Object

com.oracle.bedrock.extensible.AbstractExtensible

com.oracle.bedrock.runtime.AbstractPlatform

com.oracle.bedrock.runtime.docker.DockerPlatform

com.oracle.bedrock.runtime.docker.machine.DockerMachinePlatform

All Implemented Interfaces:

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

public class DockerMachinePlatform
extends DockerPlatform
implements Closeable

An implementation of a RemotePlatform that is associated with a Docker Machine VM.

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
DockerMachinePlatform(DockerMachine machine, String name, com.oracle.bedrock.Option... options)	Create a DockerMachinePlatform.

Method Summary

Modifier and Type	Method	Description
void	close()
void	close(com.oracle.bedrock.Option... options)	Close this DockerMachinePlatform performing any MachineCloseBehaviour present in the Options.
DockerMachine	getDockerMachine()	Obtain the DockerMachine environment used by this platform.
RemotePlatform	getRemotePlatform()	Obtain a RemotePlatform on the Docker machine instance.
RemotePlatform	getRemotePlatform(com.oracle.bedrock.Option... options)	Obtain a RemotePlatform on the Docker machine instance.
String	status()	Obtain the status of this Docker Machine instance.

Methods inherited from class com.oracle.bedrock.runtime.docker.DockerPlatform

clientAt, getAddress, getApplicationLauncher, getClientPlatform, getDocker, getOperatingSystem, launch, localClient, localClient

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

DockerMachinePlatform

public DockerMachinePlatform(DockerMachine machine,
                             String name,
                             com.oracle.bedrock.Option... options)

Create a DockerMachinePlatform.

Parameters:

machine - the DockerMachine instance to use to obtain the Docker Machine environment

name - the name of the Docker Machine VM instance

options - any Options to apply to the platform

Method Detail

getDockerMachine

public DockerMachine getDockerMachine()

Obtain the DockerMachine environment used by this platform.

Returns:

the DockerMachine environment used by this platform

getRemotePlatform

public RemotePlatform getRemotePlatform()

Obtain a RemotePlatform on the Docker machine instance.

Returns:

a RemotePlatform on the Docker machine instance

getRemotePlatform

public RemotePlatform getRemotePlatform(com.oracle.bedrock.Option... options)

Obtain a RemotePlatform on the Docker machine instance.

Parameters:

options - the Options

Returns:

a RemotePlatform on the Docker machine instance

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

close

public void close(com.oracle.bedrock.Option... options)

Close this DockerMachinePlatform performing any MachineCloseBehaviour present in the Options.

If no MachineCloseBehaviour is present in the options the default MachineCloseBehaviour will be used.

Parameters:

options - the Options to use

See Also:

MachineCloseBehaviour

status

public String status()

Obtain the status of this Docker Machine instance.

Returns:

the status of this Docker Machine instance