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.protocol;
michael@0: 
michael@0: /**
michael@0:  * {@link ch.boye.httpclientandroidlib.protocol.HttpContext} attribute names for
michael@0:  * client side HTTP protocol processing.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ClientContext {
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.conn.scheme.Scheme}
michael@0:      * object that represents the actual protocol scheme registry.
michael@0:      */
michael@0:     public static final String SCHEME_REGISTRY   = "http.scheme-registry";
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.cookie.CookieSpecRegistry}
michael@0:      * object that represents the actual cookie specification registry.
michael@0:      */
michael@0:     public static final String COOKIESPEC_REGISTRY   = "http.cookiespec-registry";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.cookie.CookieSpec}
michael@0:      * object that represents the actual cookie specification.
michael@0:      */
michael@0:     public static final String COOKIE_SPEC           = "http.cookie-spec";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.cookie.CookieOrigin}
michael@0:      * object that represents the actual details of the origin server.
michael@0:      */
michael@0:     public static final String COOKIE_ORIGIN         = "http.cookie-origin";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.client.CookieStore}
michael@0:      * object that represents the actual cookie store.
michael@0:      */
michael@0:     public static final String COOKIE_STORE          = "http.cookie-store";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.auth.AuthSchemeRegistry}
michael@0:      * object that represents the actual authentication scheme registry.
michael@0:      */
michael@0:     public static final String AUTHSCHEME_REGISTRY   = "http.authscheme-registry";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.client.CredentialsProvider}
michael@0:      * object that represents the actual credentials provider.
michael@0:      */
michael@0:     public static final String CREDS_PROVIDER        = "http.auth.credentials-provider";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.client.AuthCache} object
michael@0:      * that represents the auth scheme cache.
michael@0:      */
michael@0:     public static final String AUTH_CACHE            = "http.auth.auth-cache";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.auth.AuthState}
michael@0:      * object that represents the actual target authentication state.
michael@0:      */
michael@0:     public static final String TARGET_AUTH_STATE     = "http.auth.target-scope";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link ch.boye.httpclientandroidlib.auth.AuthState}
michael@0:      * object that represents the actual proxy authentication state.
michael@0:      */
michael@0:     public static final String PROXY_AUTH_STATE      = "http.auth.proxy-scope";
michael@0: 
michael@0:     /**
michael@0:      * @deprecated do not use
michael@0:      */
michael@0:     @Deprecated
michael@0:     public static final String AUTH_SCHEME_PREF      = "http.auth.scheme-pref";
michael@0: 
michael@0:     /**
michael@0:      * Attribute name of a {@link java.lang.Object} object that represents
michael@0:      * the actual user identity such as user {@link java.security.Principal}.
michael@0:      */
michael@0:     public static final String USER_TOKEN            = "http.user-token";
michael@0: 
michael@0: }