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.auth;
29
30 import java.nio.charset.Charset;
31 import java.nio.charset.StandardCharsets;
32
33 import org.apache.hc.client5.http.auth.AuthScheme;
34 import org.apache.hc.client5.http.auth.AuthSchemeFactory;
35 import org.apache.hc.core5.annotation.Contract;
36 import org.apache.hc.core5.annotation.ThreadingBehavior;
37 import org.apache.hc.core5.http.protocol.HttpContext;
38
39 /**
40 * {@link AuthSchemeFactory} implementation that creates and initializes
41 * {@link BasicScheme} instances.
42 *
43 * @since 4.0
44 */
45 @Contract(threading = ThreadingBehavior.STATELESS)
46 public class BasicSchemeFactory implements AuthSchemeFactory {
47
48 /**
49 * Default instance of {@link BasicSchemeFactory with a null Charset}.
50 */
51 public static final BasicSchemeFactory INSTANCE = new BasicSchemeFactory();
52
53 private final Charset charset;
54
55 /**
56 * @deprecated This constructor is deprecated to enforce the use of {@link StandardCharsets#UTF_8} encoding
57 * in compliance with RFC 7617 for HTTP Basic Authentication. Use the default constructor {@link #BasicSchemeFactory()} instead.
58 *
59 * @param charset the {@link Charset} set to be used for encoding credentials. This parameter is ignored as UTF-8 is always used.
60 */
61 @Deprecated
62 public BasicSchemeFactory(final Charset charset) {
63 super();
64 this.charset = StandardCharsets.UTF_8; // Always use UTF-8
65 }
66
67 /**
68 * Constructs a new {@link BasicSchemeFactory} with {@link StandardCharsets#UTF_8} as the charset.
69 * This default setting aligns with standard practices for encoding credentials in Basic Authentication.
70 */
71 public BasicSchemeFactory() {
72 this.charset = StandardCharsets.UTF_8;
73 }
74
75 @Override
76 public AuthScheme create(final HttpContext context) {
77 return new BasicScheme();
78 }
79
80 }