Home | History | Annotate | Download | only in params
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/ClientPNames.java $
      3  * $Revision: 659595 $
      4  * $Date: 2008-05-23 09:47:14 -0700 (Fri, 23 May 2008) $
      5  *
      6  * ====================================================================
      7  *
      8  *  Licensed to the Apache Software Foundation (ASF) under one or more
      9  *  contributor license agreements.  See the NOTICE file distributed with
     10  *  this work for additional information regarding copyright ownership.
     11  *  The ASF licenses this file to You under the Apache License, Version 2.0
     12  *  (the "License"); you may not use this file except in compliance with
     13  *  the License.  You may obtain a copy of the License at
     14  *
     15  *      http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  *  Unless required by applicable law or agreed to in writing, software
     18  *  distributed under the License is distributed on an "AS IS" BASIS,
     19  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     20  *  See the License for the specific language governing permissions and
     21  *  limitations under the License.
     22  * ====================================================================
     23  *
     24  * This software consists of voluntary contributions made by many
     25  * individuals on behalf of the Apache Software Foundation.  For more
     26  * information on the Apache Software Foundation, please see
     27  * <http://www.apache.org/>.
     28  *
     29  */
     30 
     31 package org.apache.http.client.params;
     32 
     33 
     34 /**
     35  * Parameter names for the HttpClient module.
     36  * This does not include parameters for informational units
     37  * HttpAuth, HttpCookie, or HttpConn.
     38  *
     39  * @version $Revision: 659595 $
     40  *
     41  * @since 4.0
     42  *
     43  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     44  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     45  *     for further details.
     46  */
     47 @Deprecated
     48 public interface ClientPNames {
     49 
     50     /**
     51      * Defines the class name of the default {@link org.apache.http.conn.ClientConnectionManager}
     52      * <p>
     53      * This parameter expects a value of type {@link String}.
     54      * </p>
     55      */
     56     public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name";
     57 
     58     /**
     59      * Defines the factory to create a default {@link org.apache.http.conn.ClientConnectionManager}.
     60      * <p>
     61      * This parameters expects a value of type {@link org.apache.http.conn.ClientConnectionManagerFactory}.
     62      * </p>
     63      */
     64     public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object";
     65 
     66     /**
     67      * Defines whether redirects should be handled automatically
     68      * <p>
     69      * This parameter expects a value of type {@link Boolean}.
     70      * </p>
     71      */
     72     public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects";
     73 
     74     /**
     75      * Defines whether relative redirects should be rejected.
     76      * <p>
     77      * This parameter expects a value of type {@link Boolean}.
     78      * </p>
     79      */
     80     public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect";
     81 
     82     /**
     83      * Defines the maximum number of redirects to be followed.
     84      * The limit on number of redirects is intended to prevent infinite loops.
     85      * <p>
     86      * This parameter expects a value of type {@link Integer}.
     87      * </p>
     88      */
     89     public static final String MAX_REDIRECTS = "http.protocol.max-redirects";
     90 
     91     /**
     92      * Defines whether circular redirects (redirects to the same location) should be allowed.
     93      * The HTTP spec is not sufficiently clear whether circular redirects are permitted,
     94      * therefore optionally they can be enabled
     95      * <p>
     96      * This parameter expects a value of type {@link Boolean}.
     97      * </p>
     98      */
     99     public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects";
    100 
    101     /**
    102      * Defines whether authentication should be handled automatically.
    103      * <p>
    104      * This parameter expects a value of type {@link Boolean}.
    105      * </p>
    106      */
    107     public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication";
    108 
    109     /**
    110      * Defines the name of the cookie specification to be used for HTTP state management.
    111      * <p>
    112      * This parameter expects a value of type {@link String}.
    113      * </p>
    114      */
    115     public static final String COOKIE_POLICY = "http.protocol.cookie-policy";
    116 
    117     /**
    118      * Defines the virtual host name.
    119      * <p>
    120      * This parameter expects a value of type {@link org.apache.http.HttpHost}.
    121      * </p>
    122      */
    123     public static final String VIRTUAL_HOST = "http.virtual-host";
    124 
    125     /**
    126      * Defines the request headers to be sent per default with each request.
    127      * <p>
    128      * This parameter expects a value of type {@link java.util.Collection}. The
    129      * collection is expected to contain {@link org.apache.http.Header}s.
    130      * </p>
    131      */
    132     public static final String DEFAULT_HEADERS = "http.default-headers";
    133 
    134     /**
    135      * Defines the default host. The default value will be used if the target host is
    136      * not explicitly specified in the request URI.
    137      * <p>
    138      * This parameter expects a value of type {@link org.apache.http.HttpHost}.
    139      * </p>
    140      */
    141     public static final String DEFAULT_HOST = "http.default-host";
    142 
    143 }
    144 
    145