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  package org.apache.http.conn.util;
28  
29  import java.util.Collections;
30  import java.util.List;
31  
32  import org.apache.http.annotation.Contract;
33  import org.apache.http.annotation.ThreadingBehavior;
34  import org.apache.http.util.Args;
35  
36  /**
37   * Public suffix is a set of DNS names or wildcards concatenated with dots. It represents
38   * the part of a domain name which is not under the control of the individual registrant
39   * <p>
40   * An up-to-date list of suffixes can be obtained from
41   * <a href="http://publicsuffix.org/">publicsuffix.org</a>
42   *
43   * @since 4.4
44   */
45  @Contract(threading = ThreadingBehavior.IMMUTABLE)
46  public final class PublicSuffixList {
47  
48      private final DomainType type;
49      private final List<String> rules;
50      private final List<String> exceptions;
51  
52      /**
53       * @since 4.5
54       */
55      public PublicSuffixList(final DomainType type, final List<String> rules, final List<String> exceptions) {
56          this.type = Args.notNull(type, "Domain type");
57          this.rules = Collections.unmodifiableList(Args.notNull(rules, "Domain suffix rules"));
58          this.exceptions = Collections.unmodifiableList(exceptions != null ? exceptions : Collections.<String>emptyList());
59      }
60  
61      public PublicSuffixList(final List<String> rules, final List<String> exceptions) {
62          this(DomainType.UNKNOWN, rules, exceptions);
63      }
64  
65      /**
66       * @since 4.5
67       */
68      public DomainType getType() {
69          return type;
70      }
71  
72      public List<String> getRules() {
73          return rules;
74      }
75  
76      public List<String> getExceptions() {
77          return exceptions;
78      }
79  
80  }