com.spotify.helios.common.descriptors.PortMapping.java Source code

Introduction

Here is the source code for com.spotify.helios.common.descriptors.PortMapping.java

Source

/*
 * Copyright (c) 2014 Spotify AB.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package com.spotify.helios.common.descriptors;

import com.google.common.base.Optional;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

import org.jetbrains.annotations.Nullable;

/**
 * Represents a mapping from a port inside the container to be exposed on the agent.
 *
 * A typical JSON representation might be:
 * <pre>
 * {
 *   "externalPort" : 8061,
 *   "internalPort" : 8081,
 *   "protocol" : "tcp"
 * }
 * </pre>
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class PortMapping extends Descriptor {

    public static final String TCP = "tcp";
    public static final String UDP = "udp";

    private final int internalPort;
    private final Integer externalPort;
    private final String protocol;

    public PortMapping(@JsonProperty("internalPort") final int internalPort,
            @JsonProperty("externalPort") final Integer externalPort,
            @JsonProperty("protocol") final String protocol) {
        this.internalPort = internalPort;
        this.externalPort = externalPort;
        this.protocol = Optional.fromNullable(protocol).or(TCP);
    }

    public PortMapping(final int internalPort, final Integer externalPort) {
        this.internalPort = internalPort;
        this.externalPort = externalPort;
        this.protocol = TCP;
    }

    public PortMapping(final int internalPort) {
        this.internalPort = internalPort;
        this.externalPort = null;
        this.protocol = TCP;
    }

    public int getInternalPort() {
        return internalPort;
    }

    public boolean hasExternalPort() {
        return externalPort != null;
    }

    @Nullable
    public Integer getExternalPort() {
        return externalPort;
    }

    public String getProtocol() {
        return protocol;
    }

    public PortMapping withExternalPort(final Integer externalPort) {
        return PortMapping.of(internalPort, externalPort, protocol);
    }

    public static PortMapping of(final int internalPort) {
        return new PortMapping(internalPort);
    }

    public static PortMapping of(final int internalPort, final Integer externalPort) {
        return new PortMapping(internalPort, externalPort);
    }

    public static PortMapping of(final int internalPort, final Integer externalPort, final String protocol) {
        return new PortMapping(internalPort, externalPort, protocol);
    }

    public static PortMapping of(final int internalPort, final String protocol) {
        return new PortMapping(internalPort, null, protocol);
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        final PortMapping that = (PortMapping) o;

        if (internalPort != that.internalPort) {
            return false;
        }
        if (externalPort != null ? !externalPort.equals(that.externalPort) : that.externalPort != null) {
            return false;
        }
        if (protocol != null ? !protocol.equals(that.protocol) : that.protocol != null) {
            return false;
        }

        return true;
    }

    @Override
    public int hashCode() {
        int result = internalPort;
        result = 31 * result + (externalPort != null ? externalPort.hashCode() : 0);
        result = 31 * result + (protocol != null ? protocol.hashCode() : 0);
        return result;
    }

    @Override
    public String toString() {
        return "PortMapping{" + "internalPort=" + internalPort + ", externalPort=" + externalPort + ", protocol='"
                + protocol + '\'' + '}';
    }
}