Module com.oracle.bedrock.runtime.docker

Package com.oracle.bedrock.runtime.docker.commands

Class Network<C extends CommandWithArgumentList>

java.lang.Object

com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand<C>

com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList<C>

com.oracle.bedrock.runtime.docker.commands.Network<C>

All Implemented Interfaces:

com.oracle.bedrock.runtime.MetaClass<com.oracle.bedrock.runtime.Application>

Direct Known Subclasses:

Network.Connect, Network.Create, Network.Disconnect, Network.Inspect, Network.LS, Network.Remove

public abstract class Network<C extends CommandWithArgumentList>
extends CommandWithArgumentList<C>

A representation of the Docker Network commands.

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

Author:

Jonathan Knight

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Network.Connect	A representation of the Docker Network Connect command.
static class	Network.Create	A representation of the Docker Network Create command.
static class	Network.Disconnect	A representation of the Docker Network Disconnect command.
static class	Network.Inspect	A representation of the Docker Network Inspect command.
static class	Network.LS	A representation of the Docker Network LS command.
static class	Network.Remove	A representation of the Docker Network rm command.

Method Summary

Modifier and Type	Method	Description
static Network.Connect	connect(String network, String container)	Connect a container to a Docker network.
static Network.Create	create(String name, String driver)	Create a Docker network using the specified driver.
static Network.Create	createBridge(String name)	Create a Docker network using the bridge driver.
static Network.Create	createOverlay(String name)	Create a Docker network using the overlay driver.
static Network.Disconnect	disconnect(String network, String container)	Connect a container to a Docker network.
static javax.json.JsonValue	inspect(com.oracle.bedrock.runtime.Platform platform, Docker environment, String... networks)	Execute an Network.Inspect command on the specified Platform using the specified Docker environment.
static Network.Inspect	inspect(String... names)	Inspect the specified networks.
static Network.Inspect	inspect(List<String> names)	Inspect the specified networks.
static Network.LS	list()	List the available Docker networks,
static Network.Remove	remove(String... names)	Remove one or more Docker networks.
static Network.Remove	remove(List<String> names)	Remove one or more Docker networks.

Methods inherited from class com.oracle.bedrock.runtime.docker.commands.CommandWithArgumentList

onLaunch, withCommandArguments, withCommandArguments, withoutCommandArguments, withoutCommandArguments

Methods inherited from class com.oracle.bedrock.runtime.docker.commands.AbstractDockerCommand

getCommandArguments, getImplementationClass, getTimeout, onLaunched, onLaunching, timeoutAfter, timeoutAfter

Methods inherited from class java.lang.Object

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

Method Detail

createBridge

public static Network.Create createBridge(String name)

Create a Docker network using the bridge driver.

Parameters:

name - the name of the network to create

Returns:

a new Network.Create command.

createOverlay

public static Network.Create createOverlay(String name)

Create a Docker network using the overlay driver.

Parameters:

name - the name of the network to create

Returns:

a new Network.Create command.

create

public static Network.Create create(String name,
                                    String driver)

Create a Docker network using the specified driver.

Parameters:

name - the name of the network to create

driver - the name of the network driver to use

Returns:

a new Network.Create command.

connect

public static Network.Connect connect(String network,
                                      String container)

Connect a container to a Docker network.

Parameters:

network - the name of the network to connect to

container - the name of the container to connect to the network

Returns:

a new Network.Connect command.

disconnect

public static Network.Disconnect disconnect(String network,
                                            String container)

Connect a container to a Docker network.

Parameters:

network - the name of the network to connect to

container - the name of the container to connect to the network

Returns:

a new Network.Connect command.

inspect

public static Network.Inspect inspect(String... names)

Inspect the specified networks.

Parameters:

names - the names of the networks to inspect

Returns:

a new Network.Inspect

inspect

public static Network.Inspect inspect(List<String> names)

Inspect the specified networks.

Parameters:

names - the names of the networks to inspect

Returns:

a new Network.Inspect

inspect

public static javax.json.JsonValue inspect(com.oracle.bedrock.runtime.Platform platform,
                                           Docker environment,
                                           String... networks)

Execute an Network.Inspect command on the specified Platform using the specified Docker environment.

Parameters:

platform - the Platform to use to execute the command

environment - the Docker environment to use

networks - the names of the networks to inspect

Returns:

a JsonArray containing the results of the inspect command

list

public static Network.LS list()

List the available Docker networks,

Returns:

a new Network.LS command.

remove

public static Network.Remove remove(String... names)

Remove one or more Docker networks.

Parameters:

names - the names of the network to remove

Returns:

a new Network.Remove command.

remove

public static Network.Remove remove(List<String> names)

Remove one or more Docker networks.

Parameters:

names - the names of the network to remove

Returns:

a new Network.Remove command.