hbase-common/src/main/java/org/apache/hadoop/hbase/net/Address.java

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 package org.apache.hadoop.hbase.net;
  19
  20 import java.net.InetSocketAddress;
  21
  22 import org.apache.commons.lang3.StringUtils;
  23 import org.apache.yetus.audience.InterfaceAudience;
  24
  25 import org.apache.hbase.thirdparty.com.google.common.net.HostAndPort;
  26
  27 /**
  28  * An immutable type to hold a hostname and port combo, like an Endpoint
  29  * or java.net.InetSocketAddress (but without danger of our calling
  30  * resolve -- we do NOT want a resolve happening every time we want
  31  * to hold a hostname and port combo). This class is also {@link Comparable}
  32  * <p>In implementation this class is a facade over Guava's {@link HostAndPort}.
  33  * We cannot have Guava classes in our API hence this Type.
  34  */
  35 @InterfaceAudience.Public
  36 public class Address implements Comparable<Address> {
  37   private final HostAndPort hostAndPort;
  38
  39   private Address(HostAndPort hostAndPort) {
  40     this.hostAndPort = hostAndPort;
  41   }
  42
  43   public static Address fromParts(String hostname, int port) {
  44     return new Address(HostAndPort.fromParts(hostname, port));
  45   }
  46
  47   public static Address fromString(String hostnameAndPort) {
  48     return new Address(HostAndPort.fromString(hostnameAndPort));
  49   }
  50
  51   public static Address fromSocketAddress(InetSocketAddress addr) {
  52     return Address.fromParts(addr.getHostString(), addr.getPort());
  53   }
  54
  55   public static InetSocketAddress toSocketAddress(Address addr) {
  56     return new InetSocketAddress(addr.getHostName(), addr.getPort());
  57   }
  58
  59   public static InetSocketAddress[] toSocketAddress(Address[] addrs) {
  60     if (addrs == null) {
  61       return null;
  62     }
  63     InetSocketAddress[] result = new InetSocketAddress[addrs.length];
  64     for (int i = 0; i < addrs.length; i++) {
  65       result[i] = toSocketAddress(addrs[i]);
  66     }
  67     return result;
  68   }
  69
  70   public String getHostName() {
  71     return this.hostAndPort.getHost();
  72   }
  73
  74   /**
  75    * @deprecated Use {@link #getHostName()} instead
  76    */
  77   @Deprecated
  78   public String getHostname() {
  79     return this.hostAndPort.getHost();
  80   }
  81
  82   public int getPort() {
  83     return this.hostAndPort.getPort();
  84   }
  85
  86   @Override
  87   public String toString() {
  88     return this.hostAndPort.toString();
  89   }
  90
  91   /**
  92    * If hostname is a.b.c and the port is 123, return a:123 instead of a.b.c:123.
  93    * @return if host looks like it is resolved -- not an IP -- then strip the domain portion
  94    *    otherwise returns same as {@link #toString()}}
  95    */
  96   public String toStringWithoutDomain() {
  97     String hostname = getHostName();
  98     String [] parts = hostname.split("\\.");
  99     if (parts.length > 1) {
 100       for (String part: parts) {
 101         if (!StringUtils.isNumeric(part)) {
 102           return Address.fromParts(parts[0], getPort()).toString();
 103         }
 104       }
 105     }
 106     return toString();
 107   }
 108
 109   @Override
 110   // Don't use HostAndPort equals... It is wonky including
 111   // ipv6 brackets
 112   public boolean equals(Object other) {
 113     if (this == other) {
 114       return true;
 115     }
 116     if (other instanceof Address) {
 117       Address that = (Address)other;
 118       return this.getHostName().equals(that.getHostName()) &&
 119           this.getPort() == that.getPort();
 120     }
 121     return false;
 122   }
 123
 124   @Override
 125   public int hashCode() {
 126     return this.getHostName().hashCode() ^ getPort();
 127   }
 128
 129   @Override
 130   public int compareTo(Address that) {
 131     int compare = this.getHostName().compareTo(that.getHostName());
 132     if (compare != 0) {
 133       return compare;
 134     }
 135
 136     return this.getPort() - that.getPort();
 137   }
 138 }