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