michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * A handler for determining if the given execution context is user specific
michael@0:  * or not. The token object returned by this handler is expected to uniquely
michael@0:  * identify the current user if the context is user specific or to be
michael@0:  * <code>null</code> if the context does not contain any resources or details
michael@0:  * specific to the current user.
michael@0:  * <p/>
michael@0:  * The user token will be used to ensure that user specific resources will not
michael@0:  * be shared with or reused by other users.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface UserTokenHandler {
michael@0: 
michael@0:     /**
michael@0:      * The token object returned by this method is expected to uniquely
michael@0:      * identify the current user if the context is user specific or to be
michael@0:      * <code>null</code> if it is not.
michael@0:      *
michael@0:      * @param context the execution context
michael@0:      *
michael@0:      * @return user token that uniquely identifies the user or
michael@0:      * <code>null</null> if the context is not user specific.
michael@0:      */
michael@0:     Object getUserToken(HttpContext context);
michael@0: 
michael@0: }