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.protocol.HttpContext; 33 34 /** 35 * A handler for determining if the given execution context is user specific 36 * or not. The token object returned by this handler is expected to uniquely 37 * identify the current user if the context is user specific or to be 38 * {@code null} if the context does not contain any resources or details 39 * specific to the current user. 40 * <p> 41 * The user token will be used to ensure that user specific resources will not 42 * be shared with or reused by other users. 43 * </p> 44 * 45 * @since 4.0 46 */ 47 @Contract(threading = ThreadingBehavior.STATELESS) 48 public interface UserTokenHandler { 49 50 /** 51 * The token object returned by this method is expected to uniquely 52 * identify the current user if the context is user specific or to be 53 * {@code null} if it is not. 54 * 55 * @param route HTTP route 56 * @param context the execution context 57 * 58 * @return user token that uniquely identifies the user or 59 * {@code null} if the context is not user specific. 60 */ 61 Object getUserToken(HttpRoute route, HttpContext context); 62 63 }