1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/params/HttpProtocolParams.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 576089 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2007-09-16 05:39:56 -0700 (Sun, 16 Sep 2007) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.params; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.HttpVersion; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.ProtocolVersion; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.protocol.HTTP; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This class implements an adaptor around the {@link HttpParams} interface 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to simplify manipulation of the HTTP protocol specific parameters. 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <br/> 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Note that the <i>implements</i> relation to {@link CoreProtocolPNames} 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * is for compatibility with existing application code only. References to 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the parameter names should use the interface, not this class. 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 576089 $ 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see CoreProtocolPNames 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic final class HttpProtocolParams implements CoreProtocolPNames { 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private HttpProtocolParams() { 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project super(); 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the charset to be used for writing HTTP headers. 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The charset 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getHttpElementCharset(final HttpParams params) { 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String charset = (String) params.getParameter 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project (CoreProtocolPNames.HTTP_ELEMENT_CHARSET); 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (charset == null) { 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project charset = HTTP.DEFAULT_PROTOCOL_CHARSET; 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return charset; 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the charset to be used for writing HTTP headers. 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset The charset 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static void setHttpElementCharset(final HttpParams params, final String charset) { 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project params.setParameter(CoreProtocolPNames.HTTP_ELEMENT_CHARSET, charset); 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns the default charset to be used for writing content body, 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * when no charset explicitly specified. 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return The charset 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getContentCharset(final HttpParams params) { 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project String charset = (String) params.getParameter 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project (CoreProtocolPNames.HTTP_CONTENT_CHARSET); 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (charset == null) { 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project charset = HTTP.DEFAULT_CONTENT_CHARSET; 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return charset; 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Sets the default charset to be used for writing content body, 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * when no charset explicitly specified. 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param charset The charset 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static void setContentCharset(final HttpParams params, final String charset) { 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project params.setParameter(CoreProtocolPNames.HTTP_CONTENT_CHARSET, charset); 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns {@link ProtocolVersion protocol version} to be used per default. 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return {@link ProtocolVersion protocol version} 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static ProtocolVersion getVersion(final HttpParams params) { 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Object param = params.getParameter 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project (CoreProtocolPNames.PROTOCOL_VERSION); 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (param == null) { 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return HttpVersion.HTTP_1_1; 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return (ProtocolVersion)param; 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Assigns the {@link ProtocolVersion protocol version} to be used by the 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * HTTP methods that this collection of parameters applies to. 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param version the {@link ProtocolVersion protocol version} 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static void setVersion(final HttpParams params, final ProtocolVersion version) { 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 145069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project params.setParameter(CoreProtocolPNames.PROTOCOL_VERSION, version); 146069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 147069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 148069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static String getUserAgent(final HttpParams params) { 149069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 150069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 151069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 152069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return (String) params.getParameter(CoreProtocolPNames.USER_AGENT); 153069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 154069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 155069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static void setUserAgent(final HttpParams params, final String useragent) { 156069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 157069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 158069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 159069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project params.setParameter(CoreProtocolPNames.USER_AGENT, useragent); 160069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 161069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 162069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static boolean useExpectContinue(final HttpParams params) { 163069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 164069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 165069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 166069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return params.getBooleanParameter 167069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project (CoreProtocolPNames.USE_EXPECT_CONTINUE, false); 168069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 169069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 170069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public static void setUseExpectContinue(final HttpParams params, boolean b) { 171069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (params == null) { 172069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("HTTP parameters may not be null"); 173069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 174069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project params.setBooleanParameter(CoreProtocolPNames.USE_EXPECT_CONTINUE, b); 175069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 176069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 177