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.auth;
28
29 import java.io.Serializable;
30 import java.security.Principal;
31 import java.util.Objects;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.util.Args;
36
37 /**
38 * Opaque token {@link Credentials} usually representing a set of claims, often encrypted
39 * or signed. The JWT (JSON Web Token) is among most widely used tokens used at the time
40 * of writing.
41 *
42 * @since 5.3
43 */
44 @Contract(threading = ThreadingBehavior.IMMUTABLE)
45 public class BearerToken implements Credentials, Serializable {
46
47 private final String token;
48
49 public BearerToken(final String token) {
50 super();
51 this.token = Args.notBlank(token, "Token");
52 }
53
54 @Override
55 public Principal getUserPrincipal() {
56 return null;
57 }
58
59 /**
60 * @deprecated Do not use.
61 */
62 @Deprecated
63 @Override
64 public char[] getPassword() {
65 return null;
66 }
67
68 public String getToken() {
69 return token;
70 }
71
72 @Override
73 public int hashCode() {
74 return token.hashCode();
75 }
76
77 @Override
78 public boolean equals(final Object o) {
79 if (this == o) {
80 return true;
81 }
82 if (o instanceof BearerToken) {
83 final BearerToken that = (BearerToken) o;
84 return Objects.equals(this.token, that.token);
85 }
86 return false;
87 }
88
89 }
90