Home | History | Annotate | Download | only in params 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/params/CoreProtocolPNames.java $
      3  * $Revision: 576077 $
      4  * $Date: 2007-09-16 04:50:22 -0700 (Sun, 16 Sep 2007) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with 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,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.params;
     33 
     34 
     35 /**
     36  * Defines parameter names for protocol execution in HttpCore.
     37  *
     38  * @version $Revision: 576077 $
     39  *
     40  * @since 4.0
     41  */
     42 public interface CoreProtocolPNames {
     43 
     44     /**
     45      * Defines the {@link org.apache.http.ProtocolVersion protocol version}
     46      * used per default.
     47      * <p>
     48      * This parameter expects a value of type
     49      * {@link org.apache.http.ProtocolVersion}.
     50      * </p>
     51      */
     52     public static final String PROTOCOL_VERSION = "http.protocol.version";
     53 
     54     /**
     55      * Defines the charset to be used for encoding HTTP protocol elements.
     56      * <p>
     57      * This parameter expects a value of type {@link String}.
     58      * </p>
     59      */
     60     public static final String HTTP_ELEMENT_CHARSET = "http.protocol.element-charset";
     61 
     62     /**
     63      * Defines the charset to be used per default for encoding content body.
     64      * <p>
     65      * This parameter expects a value of type {@link String}.
     66      * </p>
     67      */
     68     public static final String HTTP_CONTENT_CHARSET = "http.protocol.content-charset";
     69 
     70     /**
     71      * Defines the content of the <tt>User-Agent</tt> header.
     72      * <p>
     73      * This parameter expects a value of type {@link String}.
     74      * </p>
     75      */
     76     public static final String USER_AGENT = "http.useragent";
     77 
     78     /**
     79      * Defines the content of the <tt>Server</tt> header.
     80      * <p>
     81      * This parameter expects a value of type {@link String}.
     82      * </p>
     83      */
     84     public static final String ORIGIN_SERVER = "http.origin-server";
     85 
     86     /**
     87      * Defines whether responses with an invalid <tt>Transfer-Encoding</tt> header should be
     88      * rejected.
     89      * <p>
     90      * This parameter expects a value of type {@link Boolean}.
     91      * </p>
     92      */
     93     public static final String STRICT_TRANSFER_ENCODING = "http.protocol.strict-transfer-encoding";
     94 
     95     /**
     96      * <p>
     97      * Activates 'Expect: 100-continue' handshake for the
     98      * entity enclosing methods. The purpose of the 'Expect: 100-continue'
     99      * handshake to allow a client that is sending a request message with
    100      * a request body to determine if the origin server is willing to
    101      * accept the request (based on the request headers) before the client
    102      * sends the request body.
    103      * </p>
    104      *
    105      * <p>
    106      * The use of the 'Expect: 100-continue' handshake can result in
    107      * noticable peformance improvement for entity enclosing requests
    108      * (such as POST and PUT) that require the target server's
    109      * authentication.
    110      * </p>
    111      *
    112      * <p>
    113      * 'Expect: 100-continue' handshake should be used with
    114      * caution, as it may cause problems with HTTP servers and
    115      * proxies that do not support HTTP/1.1 protocol.
    116      * </p>
    117      *
    118      * This parameter expects a value of type {@link Boolean}.
    119      */
    120     public static final String USE_EXPECT_CONTINUE = "http.protocol.expect-continue";
    121 
    122     /**
    123      * <p>
    124      * Defines the maximum period of time in milliseconds the client should spend
    125      * waiting for a 100-continue response.
    126      * </p>
    127      *
    128      * This parameter expects a value of type {@link Integer}.
    129      */
    130     public static final String WAIT_FOR_CONTINUE = "http.protocol.wait-for-continue";
    131 
    132 }
    133