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.hc.client5.http.impl;
29  
30  import org.apache.hc.client5.http.cookie.StandardCookieSpec;
31  import org.apache.hc.client5.http.cookie.CookieSpecFactory;
32  import org.apache.hc.client5.http.impl.cookie.IgnoreCookieSpecFactory;
33  import org.apache.hc.client5.http.impl.cookie.RFC6265CookieSpecFactory;
34  import org.apache.hc.client5.http.psl.PublicSuffixMatcher;
35  import org.apache.hc.client5.http.psl.PublicSuffixMatcherLoader;
36  import org.apache.hc.core5.annotation.Internal;
37  import org.apache.hc.core5.http.config.Lookup;
38  import org.apache.hc.core5.http.config.RegistryBuilder;
39  
40  /**
41   * Cookie support methods.
42   *
43   * @since 5.0
44   */
45  @Internal
46  public final class CookieSpecSupport {
47  
48      /**
49       * Creates a builder containing the default registry entries, using the provided public suffix matcher.
50       */
51      public static RegistryBuilder<CookieSpecFactory> createDefaultBuilder(final PublicSuffixMatcher publicSuffixMatcher) {
52          return RegistryBuilder.<CookieSpecFactory>create()
53                  .register(StandardCookieSpec.RELAXED, new RFC6265CookieSpecFactory(
54                          RFC6265CookieSpecFactory.CompatibilityLevel.RELAXED, publicSuffixMatcher))
55                  .register(StandardCookieSpec.STRICT, new RFC6265CookieSpecFactory(
56                          RFC6265CookieSpecFactory.CompatibilityLevel.STRICT, publicSuffixMatcher))
57                  .register(StandardCookieSpec.IGNORE, new IgnoreCookieSpecFactory());
58      }
59  
60      /**
61       * Creates a builder containing the default registry entries with the default public suffix matcher.
62       */
63      public static RegistryBuilder<CookieSpecFactory> createDefaultBuilder() {
64          return createDefaultBuilder(PublicSuffixMatcherLoader.getDefault());
65      }
66  
67      /**
68       * Creates the default registry, using the default public suffix matcher.
69       */
70      public static Lookup<CookieSpecFactory> createDefault() {
71          return createDefault(PublicSuffixMatcherLoader.getDefault());
72      }
73  
74      /**
75       * Creates the default registry with the provided public suffix matcher
76       */
77      public static Lookup<CookieSpecFactory> createDefault(final PublicSuffixMatcher publicSuffixMatcher) {
78          return createDefaultBuilder(publicSuffixMatcher).build();
79      }
80  
81      private CookieSpecSupport() {}
82  
83  }