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 public interface ClientPNames { 44 45 /** 46 * Defines the class name of the default {@link org.apache.http.conn.ClientConnectionManager} 47 * <p> 48 * This parameter expects a value of type {@link String}. 49 * </p> 50 */ 51 public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name"; 52 53 /** 54 * Defines the factory to create a default {@link org.apache.http.conn.ClientConnectionManager}. 55 * <p> 56 * This parameters expects a value of type {@link org.apache.http.conn.ClientConnectionManagerFactory}. 57 * </p> 58 */ 59 public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object"; 60 61 /** 62 * Defines whether redirects should be handled automatically 63 * <p> 64 * This parameter expects a value of type {@link Boolean}. 65 * </p> 66 */ 67 public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects"; 68 69 /** 70 * Defines whether relative redirects should be rejected. 71 * <p> 72 * This parameter expects a value of type {@link Boolean}. 73 * </p> 74 */ 75 public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect"; 76 77 /** 78 * Defines the maximum number of redirects to be followed. 79 * The limit on number of redirects is intended to prevent infinite loops. 80 * <p> 81 * This parameter expects a value of type {@link Integer}. 82 * </p> 83 */ 84 public static final String MAX_REDIRECTS = "http.protocol.max-redirects"; 85 86 /** 87 * Defines whether circular redirects (redirects to the same location) should be allowed. 88 * The HTTP spec is not sufficiently clear whether circular redirects are permitted, 89 * therefore optionally they can be enabled 90 * <p> 91 * This parameter expects a value of type {@link Boolean}. 92 * </p> 93 */ 94 public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects"; 95 96 /** 97 * Defines whether authentication should be handled automatically. 98 * <p> 99 * This parameter expects a value of type {@link Boolean}. 100 * </p> 101 */ 102 public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication"; 103 104 /** 105 * Defines the name of the cookie specification to be used for HTTP state management. 106 * <p> 107 * This parameter expects a value of type {@link String}. 108 * </p> 109 */ 110 public static final String COOKIE_POLICY = "http.protocol.cookie-policy"; 111 112 /** 113 * Defines the virtual host name. 114 * <p> 115 * This parameter expects a value of type {@link org.apache.http.HttpHost}. 116 * </p> 117 */ 118 public static final String VIRTUAL_HOST = "http.virtual-host"; 119 120 /** 121 * Defines the request headers to be sent per default with each request. 122 * <p> 123 * This parameter expects a value of type {@link java.util.Collection}. The 124 * collection is expected to contain {@link org.apache.http.Header}s. 125 * </p> 126 */ 127 public static final String DEFAULT_HEADERS = "http.default-headers"; 128 129 /** 130 * Defines the default host. The default value will be used if the target host is 131 * not explicitly specified in the request URI. 132 * <p> 133 * This parameter expects a value of type {@link org.apache.http.HttpHost}. 134 * </p> 135 */ 136 public static final String DEFAULT_HOST = "http.default-host"; 137 138 } 139 140
