Wed, 31 Dec 2014 07:22:50 +0100
Correct previous dual key logic pending first delivery installment.
1 /*
2 * ====================================================================
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 *
20 * This software consists of voluntary contributions made by many
21 * individuals on behalf of the Apache Software Foundation. For more
22 * information on the Apache Software Foundation, please see
23 * <http://www.apache.org/>.
24 *
25 */
27 package ch.boye.httpclientandroidlib.client.params;
29 /**
30 * Parameter names for HTTP client parameters.
31 *
32 * @since 4.0
33 */
34 public interface ClientPNames {
36 /**
37 * Defines the class name of the default {@link ch.boye.httpclientandroidlib.conn.ClientConnectionManager}
38 * <p>
39 * This parameter expects a value of type {@link String}.
40 * </p>
41 */
42 public static final String CONNECTION_MANAGER_FACTORY_CLASS_NAME = "http.connection-manager.factory-class-name";
44 /**
45 * @deprecated use #CONNECTION_MANAGER_FACTORY_CLASS_NAME
46 */
47 @Deprecated
48 public static final String CONNECTION_MANAGER_FACTORY = "http.connection-manager.factory-object";
50 /**
51 * Defines whether redirects should be handled automatically
52 * <p>
53 * This parameter expects a value of type {@link Boolean}.
54 * </p>
55 */
56 public static final String HANDLE_REDIRECTS = "http.protocol.handle-redirects";
58 /**
59 * Defines whether relative redirects should be rejected. HTTP specification
60 * requires the location value be an absolute URI.
61 * <p>
62 * This parameter expects a value of type {@link Boolean}.
63 * </p>
64 */
65 public static final String REJECT_RELATIVE_REDIRECT = "http.protocol.reject-relative-redirect";
67 /**
68 * Defines the maximum number of redirects to be followed.
69 * The limit on number of redirects is intended to prevent infinite loops.
70 * <p>
71 * This parameter expects a value of type {@link Integer}.
72 * </p>
73 */
74 public static final String MAX_REDIRECTS = "http.protocol.max-redirects";
76 /**
77 * Defines whether circular redirects (redirects to the same location) should be allowed.
78 * The HTTP spec is not sufficiently clear whether circular redirects are permitted,
79 * therefore optionally they can be enabled
80 * <p>
81 * This parameter expects a value of type {@link Boolean}.
82 * </p>
83 */
84 public static final String ALLOW_CIRCULAR_REDIRECTS = "http.protocol.allow-circular-redirects";
86 /**
87 * Defines whether authentication should be handled automatically.
88 * <p>
89 * This parameter expects a value of type {@link Boolean}.
90 * </p>
91 */
92 public static final String HANDLE_AUTHENTICATION = "http.protocol.handle-authentication";
94 /**
95 * Defines the name of the cookie specification to be used for HTTP state management.
96 * <p>
97 * This parameter expects a value of type {@link String}.
98 * </p>
99 */
100 public static final String COOKIE_POLICY = "http.protocol.cookie-policy";
102 /**
103 * Defines the virtual host to be used in the <code>Host</code>
104 * request header instead of the physical host.
105 * <p>
106 * This parameter expects a value of type {@link ch.boye.httpclientandroidlib.HttpHost}.
107 * </p>
108 * If a port is not provided, it will be derived from the request URL.
109 */
110 public static final String VIRTUAL_HOST = "http.virtual-host";
112 /**
113 * Defines the request headers to be sent per default with each request.
114 * <p>
115 * This parameter expects a value of type {@link java.util.Collection}. The
116 * collection is expected to contain {@link ch.boye.httpclientandroidlib.Header}s.
117 * </p>
118 */
119 public static final String DEFAULT_HEADERS = "http.default-headers";
121 /**
122 * Defines the default host. The default value will be used if the target host is
123 * not explicitly specified in the request URI.
124 * <p>
125 * This parameter expects a value of type {@link ch.boye.httpclientandroidlib.HttpHost}.
126 * </p>
127 */
128 public static final String DEFAULT_HOST = "http.default-host";
130 }