com.github.dockerjava.api.model.ExposedPort Maven / Gradle / Ivy
package com.github.dockerjava.api.model;
import static com.github.dockerjava.api.model.InternetProtocol.TCP;
import static com.github.dockerjava.api.model.InternetProtocol.UDP;
import static com.github.dockerjava.api.model.InternetProtocol.SCTP;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import com.github.dockerjava.api.model.Ports.Binding;
import lombok.EqualsAndHashCode;
/**
* Represents a container port that Docker exposes to external clients. The port is defined by its {@link #getPort() port number} and an
* {@link InternetProtocol}. It can be published by Docker by {@link Ports#bind(ExposedPort, Binding) binding} it to a host port,
* represented by a {@link Binding}.
*/
@EqualsAndHashCode
public class ExposedPort implements Serializable {
private static final long serialVersionUID = 1L;
private final InternetProtocol protocol;
private final int port;
/**
* Creates an {@link ExposedPort} for the given parameters.
*
* @param port
* the {@link #getPort() port number}
* @param protocol
* the {@link InternetProtocol}
*/
public ExposedPort(int port, InternetProtocol protocol) {
this.port = port;
this.protocol = protocol;
}
/**
* Creates an {@link ExposedPort} for the given {@link #getPort() port number} and {@link InternetProtocol#DEFAULT}.
*
* @param port
* the {@link #getPort() port number}
*/
public ExposedPort(int port) {
this(port, InternetProtocol.DEFAULT);
}
/**
* Creates an {@link ExposedPort} for the given parameters.
*
* @param scheme
* the {@link #getScheme() scheme}, tcp, udp or sctp
* @param port
* the {@link #getPort() port number}
* @deprecated use {@link #ExposedPort(int, InternetProtocol)}
*/
@Deprecated
public ExposedPort(String scheme, int port) {
this(port, InternetProtocol.valueOf(scheme));
}
/**
* @return the {@link InternetProtocol} of the {@link #getPort() port} that the container exposes
*/
public InternetProtocol getProtocol() {
return protocol;
}
/**
* @return the scheme (internet protocol), tcp, udp or sctp
* @deprecated use {@link #getProtocol()}
*/
@Deprecated
public String getScheme() {
return protocol.toString();
}
/** @return the port number that the container exposes */
public int getPort() {
return port;
}
/**
* Creates an {@link ExposedPort} for {@link InternetProtocol#TCP}. This is a shortcut for
* new ExposedPort(port, {@link InternetProtocol#TCP})
*/
public static ExposedPort tcp(int port) {
return new ExposedPort(port, TCP);
}
/**
* Creates an {@link ExposedPort} for {@link InternetProtocol#UDP}. This is a shortcut for
* new ExposedPort(port, {@link InternetProtocol#UDP})
*/
public static ExposedPort udp(int port) {
return new ExposedPort(port, UDP);
}
/**
* Creates an {@link ExposedPort} for {@link InternetProtocol#SCTP}. This is a shortcut for
* new ExposedPort(port, {@link InternetProtocol#SCTP})
*/
public static ExposedPort sctp(int port) {
return new ExposedPort(port, SCTP);
}
/**
* Parses a textual port specification (as used by the Docker CLI) to an {@link ExposedPort}.
*
* @param serialized
* the specification, e.g. 80/tcp
* @return an {@link ExposedPort} matching the specification
* @throws IllegalArgumentException
* if the specification cannot be parsed
*/
@JsonCreator
public static ExposedPort parse(String serialized) throws IllegalArgumentException {
try {
String[] parts = serialized.split("/");
switch (parts.length) {
case 1:
return new ExposedPort(Integer.parseInt(parts[0]));
case 2:
return new ExposedPort(Integer.parseInt(parts[0]), InternetProtocol.parse(parts[1]));
default:
throw new IllegalArgumentException();
}
} catch (Exception e) {
throw new IllegalArgumentException("Error parsing ExposedPort '" + serialized + "'");
}
}
/**
* Returns a string representation of this {@link ExposedPort} suitable for inclusion in a JSON message. The format is
* port/protocol, like the argument in {@link #parse(String)}.
*
* @return a string representation of this {@link ExposedPort}
*/
@Override
@JsonValue
public String toString() {
return port + "/" + protocol.toString();
}
}