001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.params;
029
030/**
031 * Defines parameter names for protocol execution in HttpCore.
032 *
033 * @since 4.0
034 *
035 * @deprecated (4.3) use configuration classes provided 'org.apache.http.config'
036 *  and 'org.apache.http.client.config'
037 */
038@Deprecated
039public interface CoreProtocolPNames {
040
041    /**
042     * Defines the {@link org.apache.http.ProtocolVersion} used per default.
043     * <p>
044     * This parameter expects a value of type {@link org.apache.http.ProtocolVersion}.
045     * </p>
046     */
047    public static final String PROTOCOL_VERSION = "http.protocol.version";
048
049    /**
050     * Defines the charset to be used for encoding HTTP protocol elements.
051     * <p>
052     * This parameter expects a value of type {@link String}.
053     * </p>
054     */
055    public static final String HTTP_ELEMENT_CHARSET = "http.protocol.element-charset";
056
057    /**
058     * Defines the charset to be used per default for encoding content body.
059     * <p>
060     * This parameter expects a value of type {@link String}.
061     * </p>
062     */
063    public static final String HTTP_CONTENT_CHARSET = "http.protocol.content-charset";
064
065    /**
066     * Defines the content of the {@code User-Agent} header.
067     * <p>
068     * This parameter expects a value of type {@link String}.
069     * </p>
070     */
071    public static final String USER_AGENT = "http.useragent";
072
073    /**
074     * Defines the content of the {@code Server} header.
075     * <p>
076     * This parameter expects a value of type {@link String}.
077     * </p>
078     */
079    public static final String ORIGIN_SERVER = "http.origin-server";
080
081    /**
082     * Defines whether responses with an invalid {@code Transfer-Encoding}
083     * header should be rejected.
084     * <p>
085     * This parameter expects a value of type {@link Boolean}.
086     * </p>
087     */
088    public static final String STRICT_TRANSFER_ENCODING = "http.protocol.strict-transfer-encoding";
089
090    /**
091     * <p>
092     * Activates 'Expect: 100-Continue' handshake for the
093     * entity enclosing methods. The purpose of the 'Expect: 100-Continue'
094     * handshake is to allow a client that is sending a request message with
095     * a request body to determine if the origin server is willing to
096     * accept the request (based on the request headers) before the client
097     * sends the request body.
098     * </p>
099     *
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}