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.hc.client5.http.psl;
28
29 import java.util.Collections;
30 import java.util.List;
31
32 import org.apache.hc.core5.annotation.Contract;
33 import org.apache.hc.core5.annotation.ThreadingBehavior;
34 import org.apache.hc.core5.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 * </p>
43 *
44 * @since 4.4
45 */
46 @Contract(threading = ThreadingBehavior.IMMUTABLE)
47 public final class PublicSuffixList {
48
49 private final DomainType type;
50 private final List<String> rules;
51 private final List<String> exceptions;
52
53 /**
54 * @since 4.5
55 */
56 public PublicSuffixList(final DomainType type, final List<String> rules, final List<String> exceptions) {
57 this.type = Args.notNull(type, "Domain type");
58 this.rules = Collections.unmodifiableList(Args.notNull(rules, "Domain suffix rules"));
59 this.exceptions = Collections.unmodifiableList(exceptions != null ? exceptions : Collections.emptyList());
60 }
61
62 public PublicSuffixList(final List<String> rules, final List<String> exceptions) {
63 this(DomainType.UNKNOWN, rules, exceptions);
64 }
65
66 /**
67 * @since 4.5
68 */
69 public DomainType getType() {
70 return type;
71 }
72
73 public List<String> getRules() {
74 return rules;
75 }
76
77 public List<String> getExceptions() {
78 return exceptions;
79 }
80
81 }