View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with 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,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.params;
29  
30  /**
31   * Defines parameter names for protocol execution in HttpCore.
32   *
33   * @since 4.0
34   *
35   * @deprecated (4.3) use configuration classes provided 'org.apache.http.config'
36   *  and 'org.apache.http.client.config'
37   */
38  @Deprecated
39  public interface CoreProtocolPNames {
40  
41      /**
42       * Defines the {@link org.apache.http.ProtocolVersion} used per default.
43       * <p>
44       * This parameter expects a value of type {@link org.apache.http.ProtocolVersion}.
45       * </p>
46       */
47      public static final String PROTOCOL_VERSION = "http.protocol.version";
48  
49      /**
50       * Defines the charset to be used for encoding HTTP protocol elements.
51       * <p>
52       * This parameter expects a value of type {@link String}.
53       * </p>
54       */
55      public static final String HTTP_ELEMENT_CHARSET = "http.protocol.element-charset";
56  
57      /**
58       * Defines the charset to be used per default for encoding content body.
59       * <p>
60       * This parameter expects a value of type {@link String}.
61       * </p>
62       */
63      public static final String HTTP_CONTENT_CHARSET = "http.protocol.content-charset";
64  
65      /**
66       * Defines the content of the <code>User-Agent</code> header.
67       * <p>
68       * This parameter expects a value of type {@link String}.
69       * </p>
70       */
71      public static final String USER_AGENT = "http.useragent";
72  
73      /**
74       * Defines the content of the <code>Server</code> header.
75       * <p>
76       * This parameter expects a value of type {@link String}.
77       * </p>
78       */
79      public static final String ORIGIN_SERVER = "http.origin-server";
80  
81      /**
82       * Defines whether responses with an invalid <code>Transfer-Encoding</code>
83       * header should be rejected.
84       * <p>
85       * This parameter expects a value of type {@link Boolean}.
86       * </p>
87       */
88      public static final String STRICT_TRANSFER_ENCODING = "http.protocol.strict-transfer-encoding";
89  
90      /**
91       * <p>
92       * Activates 'Expect: 100-Continue' handshake for the
93       * entity enclosing methods. The purpose of the 'Expect: 100-Continue'
94       * handshake is to allow a client that is sending a request message with
95       * a request body to determine if the origin server is willing to
96       * accept the request (based on the request headers) before the client
97       * sends the request body.
98       * </p>
99       *
100      * <p>
101      * The use of the 'Expect: 100-continue' handshake can result in
102      * a noticeable performance improvement for entity enclosing requests
103      * (such as POST and PUT) that require the target server's
104      * authentication.
105      * </p>
106      *
107      * <p>
108      * 'Expect: 100-continue' handshake should be used with
109      * caution, as it may cause problems with HTTP servers and
110      * proxies that do not support HTTP/1.1 protocol.
111      * </p>
112      *
113      * This parameter expects a value of type {@link Boolean}.
114      */
115     public static final String USE_EXPECT_CONTINUE = "http.protocol.expect-continue";
116 
117     /**
118      * <p>
119      * Defines the maximum period of time in milliseconds the client should spend
120      * waiting for a 100-continue response.
121      * </p>
122      *
123      * This parameter expects a value of type {@link Integer}.
124      */
125     public static final String WAIT_FOR_CONTINUE = "http.protocol.wait-for-continue";
126 
127     /**
128      * <p>
129      * Defines the action to perform upon receiving a malformed input. If the input byte sequence
130      * is not legal for this charset then the input is said to be malformed
131      * </p>
132      *
133      * This parameter expects a value of type {@link java.nio.charset.CodingErrorAction}
134      *
135      * @since 4.2
136      */
137     public static final String HTTP_MALFORMED_INPUT_ACTION = "http.malformed.input.action";
138 
139     /**
140      * <p>
141      * Defines the action to perform upon receiving an unmappable input. If the input byte sequence
142      * is legal but cannot be mapped to a valid Unicode character then the input is said to be
143      * unmappable
144      * </p>
145      *
146      * This parameter expects a value of type {@link java.nio.charset.CodingErrorAction}
147      *
148      * @since 4.2
149      */
150     public static final String HTTP_UNMAPPABLE_INPUT_ACTION = "http.unmappable.input.action";
151 
152 }