Package org.apache.accumulo.core.util

Class HostAndPort

  • All Implemented Interfaces:
    Serializable
    public final class HostAndPort
extends Object
implements Serializable
    This class was copied from Guava release 23.0 to replace the older Guava 14 version that had been used in Accumulo. It was annotated as Beta by Google, therefore unstable to use in a core Accumulo library. We learned this the hard way when Guava version 20 deprecated the getHostText method and then removed the method all together in version 22. See ACCUMULO-4702 Unused methods and annotations were removed to reduce maintenance costs. Javadoc from Guava 23.0 release: An immutable representation of a host and port.

    Example usage: 

     HostAndPort hp =
     HostAndPort.fromString("[2001:db8::1]").withDefaultPort(80).requireBracketsForIPv6();
 hp.getHost(); // returns "2001:db8::1"
 hp.getPort(); // returns 80
 hp.toString(); // returns "[2001:db8::1]:80"

    Here are some examples of recognized formats:

    • example.com
    • example.com:80
    • 192.0.2.1
    • 192.0.2.1:80
    • [2001:db8::1] - getHost() omits brackets
    • [2001:db8::1]:80 - getHost() omits brackets
    • 2001:db8::1 - Use requireBracketsForIPv6() to prohibit this

    Note that this is not an exhaustive list, because these methods are only concerned with brackets, colons, and port numbers. Full validation of the host field (if desired) is the caller's responsibility.

    See Also:
    Serialized Form

    • Method Detail

      • getHost

        public String getHost()
        Returns the portion of this HostAndPort instance that should represent the hostname or IPv4/IPv6 literal.

        A successful parse does not imply any degree of sanity in this field. For additional validation, see the HostSpecifier class.

        Since:
        20.0 (since 10.0 as getHostText)

      • hasPort

        public boolean hasPort()
        Return true if this instance has a defined port.

      • getPort

        public int getPort()
        Get the current port number, failing if no port is defined.
        Returns:
        a validated port number, in the range [0..65535]
        Throws:
        IllegalStateException - if no port is defined. You can use withDefaultPort(int) to prevent this from occurring.

      • fromParts

        public static HostAndPort fromParts​(String host,
                                    int port)
        Build a HostAndPort instance from separate host and port values.

        Note: Non-bracketed IPv6 literals are allowed. Use #requireBracketsForIPv6() to prohibit these.

        Parameters:
        host - the host string to parse. Must not contain a port number.
        port - a port number from [0..65535]
        Returns:
        if parsing was successful, a populated HostAndPort object.
        Throws:
        IllegalArgumentException - if host contains a port number, or port is out of range.

      • fromString

        public static HostAndPort fromString​(String hostPortString)
        Split a freeform string into a host and port, without strict validation. Note that the host-only formats will leave the port field undefined. You can use withDefaultPort(int) to patch in a default value.
        Parameters:
        hostPortString - the input string to parse.
        Returns:
        if parsing was successful, a populated HostAndPort object.
        Throws:
        IllegalArgumentException - if nothing meaningful could be parsed.

      • withDefaultPort

        public HostAndPort withDefaultPort​(int defaultPort)
        Provide a default port if the parsed string contained only a host. You can chain this after fromString(String) to include a port in case the port was omitted from the input string. If a port was already provided, then this method is a no-op.
        Parameters:
        defaultPort - a port number, from [0..65535]
        Returns:
        a HostAndPort instance, guaranteed to have a defined port.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Rebuild the host:port string, including brackets if necessary.
        Overrides:
        toString in class Object

      • getPortOrDefault

        public int getPortOrDefault​(int defaultPort)
        Returns the current port number, with a default if no port is defined.