View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.conn.util;
29  
30  import java.util.regex.Pattern;
31  
32  import org.apache.http.annotation.Immutable;
33  
34  /**
35   * A collection of utilities relating to InetAddresses.
36   *
37   * @since 4.0
38   */
39  @Immutable
40  public class InetAddressUtils {
41  
42      private InetAddressUtils() {
43      }
44  
45      private static final Pattern IPV4_PATTERN =
46          Pattern.compile(
47                  "^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$");
48  
49      private static final Pattern IPV6_STD_PATTERN =
50          Pattern.compile(
51                  "^(?:[0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$");
52  
53      private static final Pattern IPV6_HEX_COMPRESSED_PATTERN =
54          Pattern.compile(
55                  "^((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)::((?:[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{1,4})*)?)$");
56  
57      /*
58       *  The above pattern is not totally rigorous as it allows for more than 7 hex fields in total
59       */
60      private static final char COLON_CHAR = ':';
61  
62      // Must not have more than 7 colons (i.e. 8 fields)
63      private static final int MAX_COLON_COUNT = 7;
64  
65      /**
66       * Checks whether the parameter is a valid IPv4 address
67       *
68       * @param input the address string to check for validity
69       * @return true if the input parameter is a valid IPv4 address
70       */
71      public static boolean isIPv4Address(final String input) {
72          return IPV4_PATTERN.matcher(input).matches();
73      }
74  
75      /**
76       * Checks whether the parameter is a valid standard (non-compressed) IPv6 address
77       *
78       * @param input the address string to check for validity
79       * @return true if the input parameter is a valid standard (non-compressed) IPv6 address
80       */
81      public static boolean isIPv6StdAddress(final String input) {
82          return IPV6_STD_PATTERN.matcher(input).matches();
83      }
84  
85      /**
86       * Checks whether the parameter is a valid compressed IPv6 address
87       *
88       * @param input the address string to check for validity
89       * @return true if the input parameter is a valid compressed IPv6 address
90       */
91      public static boolean isIPv6HexCompressedAddress(final String input) {
92          int colonCount = 0;
93          for(int i = 0; i < input.length(); i++) {
94              if (input.charAt(i) == COLON_CHAR) {
95                  colonCount++;
96              }
97          }
98          return  colonCount <= MAX_COLON_COUNT && IPV6_HEX_COMPRESSED_PATTERN.matcher(input).matches();
99      }
100 
101     /**
102      * Checks whether the parameter is a valid IPv6 address (including compressed).
103      *
104      * @param input the address string to check for validity
105      * @return true if the input parameter is a valid standard or compressed IPv6 address
106      */
107     public static boolean isIPv6Address(final String input) {
108         return isIPv6StdAddress(input) || isIPv6HexCompressedAddress(input);
109     }
110 
111 }