1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/UserTokenHandler.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,58 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.client;
1.32 +
1.33 +import ch.boye.httpclientandroidlib.protocol.HttpContext;
1.34 +
1.35 +/**
1.36 + * A handler for determining if the given execution context is user specific
1.37 + * or not. The token object returned by this handler is expected to uniquely
1.38 + * identify the current user if the context is user specific or to be
1.39 + * <code>null</code> if the context does not contain any resources or details
1.40 + * specific to the current user.
1.41 + * <p/>
1.42 + * The user token will be used to ensure that user specific resources will not
1.43 + * be shared with or reused by other users.
1.44 + *
1.45 + * @since 4.0
1.46 + */
1.47 +public interface UserTokenHandler {
1.48 +
1.49 + /**
1.50 + * The token object returned by this method is expected to uniquely
1.51 + * identify the current user if the context is user specific or to be
1.52 + * <code>null</code> if it is not.
1.53 + *
1.54 + * @param context the execution context
1.55 + *
1.56 + * @return user token that uniquely identifies the user or
1.57 + * <code>null</null> if the context is not user specific.
1.58 + */
1.59 + Object getUserToken(HttpContext context);
1.60 +
1.61 +}
