com.github.dockerjava.api.model

Class Link

java.lang.Object

com.github.dockerjava.api.model.Link

All Implemented Interfaces:

java.io.Serializable

public class Link
extends java.lang.Object
implements java.io.Serializable

Represents a network link between two Docker containers. The container with the name getName() is made available in the target container with the aliased name getAlias(). This involves creating an entry in /etc/hosts and some environment variables in the target container as well as creating a network bridge between both containers.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Link(java.lang.String name, java.lang.String alias) Creates a Link for the container with the given name and an aliased name for use in the target container.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAlias()
java.lang.String	getName()
static Link	parse(java.lang.String serialized) Parses a textual link specification (as used by the Docker CLI) to a Link.
java.lang.String	toString() Returns a string representation of this Link suitable for inclusion in a JSON message.

Methods inherited from class java.lang.Object

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

Constructor Detail

Link

public Link(java.lang.String name,
            java.lang.String alias)

Creates a Link for the container with the given name and an aliased name for use in the target container.

Parameters:

name - the name of the container that you want to link into the target container

alias - the aliased name under which the linked container will be available in the target container

Method Detail

getName

public java.lang.String getName()

Returns:

the name of the container that is linked into the target container

getAlias

public java.lang.String getAlias()

Returns:

the aliased name under which the linked container will be available in the target container

parse

public static Link parse(java.lang.String serialized)
                  throws java.lang.IllegalArgumentException

Parses a textual link specification (as used by the Docker CLI) to a Link.

Parameters:

serialized - the specification, e.g. name:alias or /name1:/name2/alias

Returns:

a Link matching the specification

Throws:

java.lang.IllegalArgumentException - if the specification cannot be parsed

toString

public java.lang.String toString()

Returns a string representation of this Link suitable for inclusion in a JSON message. The format is name:alias, like the argument in parse(String).

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this Link