ClientPNames.java revision d42abb2fd917184764daf22f5f299e848b8701d7
10529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch/* 20529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/client/params/ClientPNames.java $ 30529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * $Revision: 659595 $ 40529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * $Date: 2008-05-23 09:47:14 -0700 (Fri, 23 May 2008) $ 50529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 60529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * ==================================================================== 70529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 80529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Licensed to the Apache Software Foundation (ASF) under one or more 90529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * contributor license agreements. See the NOTICE file distributed with 100529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * this work for additional information regarding copyright ownership. 110529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * The ASF licenses this file to You under the Apache License, Version 2.0 120529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * (the "License"); you may not use this file except in compliance with 130529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * the License. You may obtain a copy of the License at 140529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 150529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * http://www.apache.org/licenses/LICENSE-2.0 160529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 170529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Unless required by applicable law or agreed to in writing, software 180529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * distributed under the License is distributed on an "AS IS" BASIS, 190529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * See the License for the specific language governing permissions and 210529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * limitations under the License. 220529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * ==================================================================== 230529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 240529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This software consists of voluntary contributions made by many 250529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * individuals on behalf of the Apache Software Foundation. For more 26010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * information on the Apache Software Foundation, please see 270529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <http://www.apache.org/>. 280529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * 29010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) */ 300529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 31010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles)package org.apache.http.client.params; 32010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 33010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 34010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles)/** 35010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * Parameter names for the HttpClient module. 360529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This does not include parameters for informational units 370529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * HttpAuth, HttpCookie, or HttpConn. 38010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * 390529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * @version $Revision: 659595 $ 40010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * 41010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * @since 4.0 42010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * 43010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * @deprecated Please use {@link java.net.URL#openConnection} instead. 44010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 45010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) * for further details. 46010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) */ 47010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles)@Deprecated 48010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles)public interface ClientPNames { 490529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 500529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 510529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the class name of the default {@link org.apache.http.conn.ClientConnectionManager} 520529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 530529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link String}. 540529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 550529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 560529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name"; 570529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 580529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 590529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the factory to create a default {@link org.apache.http.conn.ClientConnectionManager}. 600529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 610529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameters expects a value of type {@link org.apache.http.conn.ClientConnectionManagerFactory}. 620529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 630529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 640529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object"; 650529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 660529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 670529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines whether redirects should be handled automatically 680529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 690529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link Boolean}. 700529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 710529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 720529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects"; 730529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 740529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 750529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines whether relative redirects should be rejected. 760529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 770529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link Boolean}. 780529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 790529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 800529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect"; 810529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 820529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 830529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the maximum number of redirects to be followed. 840529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * The limit on number of redirects is intended to prevent infinite loops. 850529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 860529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link Integer}. 870529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 880529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 890529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String MAX_REDIRECTS = "http.protocol.max-redirects"; 900529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 910529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 920529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines whether circular redirects (redirects to the same location) should be allowed. 930529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * The HTTP spec is not sufficiently clear whether circular redirects are permitted, 940529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * therefore optionally they can be enabled 950529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 960529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link Boolean}. 970529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 980529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 990529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects"; 1000529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1010529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 1020529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines whether authentication should be handled automatically. 1030529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 1040529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link Boolean}. 1050529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 1060529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 1070529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication"; 1080529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1090529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 1100529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the name of the cookie specification to be used for HTTP state management. 1110529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 1120529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link String}. 1130529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 1140529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 1150529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String COOKIE_POLICY = "http.protocol.cookie-policy"; 1160529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1170529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 1180529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the virtual host name. 1190529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 1200529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link org.apache.http.HttpHost}. 1210529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 1220529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 1230529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String VIRTUAL_HOST = "http.virtual-host"; 1240529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1250529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 1260529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the request headers to be sent per default with each request. 1270529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 1280529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link java.util.Collection}. The 1290529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * collection is expected to contain {@link org.apache.http.Header}s. 1300529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 1310529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 1320529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String DEFAULT_HEADERS = "http.default-headers"; 1330529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1340529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch /** 1350529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * Defines the default host. The default value will be used if the target host is 1360529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * not explicitly specified in the request URI. 1370529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * <p> 1380529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * This parameter expects a value of type {@link org.apache.http.HttpHost}. 1390529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch * </p> 1400529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch */ 1410529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch public static final String DEFAULT_HOST = "http.default-host"; 1420529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch 1430529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch} 144010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles) 145010d83a9304c5a91596085d917d248abff47903aTorne (Richard Coles)