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 String IPV4_BASIC_PATTERN_STRING =
46              "(([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){1}" + // initial first field, 1-255
47              "(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){2}" + // following 2 fields, 0-255 followed by .
48               "([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])"; // final field, 0-255
49  
50      private static final Pattern IPV4_PATTERN =
51          Pattern.compile("^" + IPV4_BASIC_PATTERN_STRING + "$");
52  
53      private static final Pattern IPV4_MAPPED_IPV6_PATTERN = // TODO does not allow for redundant leading zeros
54              Pattern.compile("^::[fF]{4}:" + IPV4_BASIC_PATTERN_STRING + "$");
55  
56      private static final Pattern IPV6_STD_PATTERN =
57          Pattern.compile(
58                  "^[0-9a-fA-F]{1,4}(:[0-9a-fA-F]{1,4}){7}$");
59  
60      private static final Pattern IPV6_HEX_COMPRESSED_PATTERN =
61          Pattern.compile(
62                  "^(([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?)" + // 0-6 hex fields
63                   "::" +
64                   "(([0-9A-Fa-f]{1,4}(:[0-9A-Fa-f]{1,4}){0,5})?)$"); // 0-6 hex fields
65  
66      /*
67       *  The above pattern is not totally rigorous as it allows for more than 7 hex fields in total
68       */
69      private static final char COLON_CHAR = ':';
70  
71      // Must not have more than 7 colons (i.e. 8 fields)
72      private static final int MAX_COLON_COUNT = 7;
73  
74      /**
75       * Checks whether the parameter is a valid IPv4 address
76       *
77       * @param input the address string to check for validity
78       * @return true if the input parameter is a valid IPv4 address
79       */
80      public static boolean isIPv4Address(final String input) {
81          return IPV4_PATTERN.matcher(input).matches();
82      }
83  
84      public static boolean isIPv4MappedIPv64Address(final String input) {
85          return IPV4_MAPPED_IPV6_PATTERN.matcher(input).matches();
86      }
87  
88      /**
89       * Checks whether the parameter is a valid standard (non-compressed) IPv6 address
90       *
91       * @param input the address string to check for validity
92       * @return true if the input parameter is a valid standard (non-compressed) IPv6 address
93       */
94      public static boolean isIPv6StdAddress(final String input) {
95          return IPV6_STD_PATTERN.matcher(input).matches();
96      }
97  
98      /**
99       * Checks whether the parameter is a valid compressed IPv6 address
100      *
101      * @param input the address string to check for validity
102      * @return true if the input parameter is a valid compressed IPv6 address
103      */
104     public static boolean isIPv6HexCompressedAddress(final String input) {
105         int colonCount = 0;
106         for(int i = 0; i < input.length(); i++) {
107             if (input.charAt(i) == COLON_CHAR) {
108                 colonCount++;
109             }
110         }
111         return  colonCount <= MAX_COLON_COUNT && IPV6_HEX_COMPRESSED_PATTERN.matcher(input).matches();
112     }
113 
114     /**
115      * Checks whether the parameter is a valid IPv6 address (including compressed).
116      *
117      * @param input the address string to check for validity
118      * @return true if the input parameter is a valid standard or compressed IPv6 address
119      */
120     public static boolean isIPv6Address(final String input) {
121         return isIPv6StdAddress(input) || isIPv6HexCompressedAddress(input);
122     }
123 
124 }