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;
29
30 import org.apache.hc.core5.annotation.Contract;
31 import org.apache.hc.core5.annotation.ThreadingBehavior;
32 import org.apache.hc.core5.http.HttpRequest;
33 import org.apache.hc.core5.http.protocol.HttpContext;
34
35 /**
36 * A handler for determining if the given execution context is user specific
37 * or not. The token object returned by this handler is expected to uniquely
38 * identify the current user if the context is user specific or to be
39 * {@code null} if the context does not contain any resources or details
40 * specific to the current user.
41 * <p>
42 * The user token will be used to ensure that user specific resources will not
43 * be shared with or reused by other users.
44 * </p>
45 *
46 * @since 4.0
47 */
48 @Contract(threading = ThreadingBehavior.STATELESS)
49 public interface UserTokenHandler {
50
51 /**
52 * The token object returned by this method is expected to uniquely
53 * identify the current user if the context is user specific or to be
54 * {@code null} if it is not.
55 *
56 * @param route HTTP route
57 * @param context the execution context
58 *
59 * @return user token that uniquely identifies the user or
60 * {@code null} if the context is not user specific.
61 */
62 Object getUserToken(HttpRoute route, HttpContext context);
63
64 /**
65 * The token object returned by this method is expected to uniquely
66 * identify the current user if the context is user specific or to be
67 * {@code null} if it is not.
68 *
69 * @param route HTTP route
70 * @param request HTTP request
71 * @param context the execution context
72 *
73 * @return user token that uniquely identifies the user or
74 * {@code null} if the context is not user specific.
75 *
76 * @since 5.2
77 */
78 default Object getUserToken(HttpRoute route, HttpRequest request, HttpContext context) {
79 return getUserToken(route, context);
80 }
81
82 }