com.fasterxml.storemate.shared.IpAndPort Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of storemate-shared Show documentation
Utility stuff shared by client and server modules
There is a newer version: 1.1.4
package com.fasterxml.storemate.shared;

import java.net.InetAddress;
import java.net.UnknownHostException;

/**
 * Simple value type used for basic "IP:PORT" style Strings extracted
 * from configuration file.
 */
public final class IpAndPort implements Comparable
{
    public final static String DEFAULT_PROTOCOL = "http";
    
    protected final String _protocol;
    
    protected final String _ipName;

    protected final int _port;

    protected final int _hashCode;
    
    // lazily resolved actual address
    protected volatile InetAddress _ipAddress;

    // lazily constructed end point 
    protected volatile String _endpoint;
    
    // note: could add @JsonCreator, but not required:
    public IpAndPort(final String origStr)
    {
        String str = (origStr == null) ? "" : origStr;
        int ix;

        // First: do we have a protocol?
        if ((ix = str.indexOf("://")) < 0) {
            _protocol = DEFAULT_PROTOCOL;
        } else {
            _protocol = str.substring(0, ix);
            str = str.substring(ix+3);
        }

        // Let's allow trailing slash as well
        if (str.endsWith("/")) {
            str = str.substring(0, str.length()-1);
        }
        
        if ((ix = str.indexOf(':')) < 0) {
            throw new IllegalArgumentException("Can not decode IP address and port number from String '"
                    +origStr+"'");
        }
        String portStr = str.substring(ix+1).trim();
        try {
            _port = Integer.parseInt(portStr);
        } catch (IllegalArgumentException e) {
            throw new IllegalArgumentException("Invalid port number '"+portStr+"' (String '"+origStr+"'); not a valid int");
        }
        if (_port < 0 || _port >= 0x10000) {
            throw new IllegalArgumentException("Invalid port number ("+_port+"): (String '"+origStr+"') must be [0, 65535]");
        }
        // can assume, for now, that IP part is ok, as long as it's not empty
        _ipName = str.substring(0, ix).trim();
        if (_ipName.isEmpty()) {
            throw new IllegalArgumentException("Missing IP name (String '"+origStr+"')");
        }
        _hashCode = _ipName.hashCode() ^ _port;
    }

    @Deprecated
    public IpAndPort(String ipName, int port)
    {
        this(DEFAULT_PROTOCOL, ipName, port);
    }
    
    public IpAndPort(String protocol, String ipName, int port)
    {
        _protocol = protocol;
        _ipName = ipName;
        _port = port;
        _hashCode = _protocol.hashCode() ^ _ipName.hashCode() ^ _port;
    }
    
    public IpAndPort withPort(int port)
    {
        if (_port == port) {
            return this;
        }
        return new IpAndPort(_protocol, _ipName, port);
    }
    
    @Override
    public boolean equals(Object o)
    {
        if (o == this) return true;
        if (o == null) return false;
        if (o.getClass() != getClass()) return false;
        IpAndPort other = (IpAndPort) o;
        return (other._port == _port)
                && _ipName.equals(other._ipName)
                && _protocol.equals(other._protocol)
                ;
    }
    
    @Override
    public int hashCode() { return _hashCode; }

    @Override
    public String toString() {
        return getEndpoint();
    }

    public String getProcol() { return _protocol; }
    public int getPort() { return _port; }

    /**
     * Simple accessor for checking whether this endpoint refers to
     * local host using either "localhost" or "127.0.0.1" references;
     * note, though, that it does not check to see if it might be
     * referring to local instance via real IP number.
     */
    public boolean isLocalReference() {
        return "localhost".equals(_ipName) || "127.0.0.1".equals(_ipName);
    }
    
    /**
     * Accessor for getting URL end point like "http://somehost.com:8080/".
     * Note that no address resolution is performed; this to allow dynamic
     * resolution depending on DNS-caching settings.
     */
    public String getEndpoint()
    {
        String str = _endpoint;
        if (str == null) {
            str = _protocol + "://"+_ipName+":"+_port+"/";
            _endpoint = str;
        }
        return str;
    }

    public String getEndpoint(String path)
    {
        String base = getEndpoint();
        StringBuilder sb = new StringBuilder(base.length() + path.length());
        sb.append(base);
        sb.append(path);
        return sb.toString();
    }

    public String getHostName() {
        return _ipName;
    }
    
    public InetAddress getIP() throws UnknownHostException
    {
        InetAddress addr = _ipAddress;
        if (addr == null) {
            _ipAddress = addr = InetAddress.getByName(_ipName);
        }
        return addr;
    }

    @Override
    public int compareTo(IpAndPort other) {
        // Simple lexicographic (~= alphabetic) ordering:
        return getEndpoint().compareTo(other.getEndpoint());
    }
}