19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/multipart/StringPart.java,v 1.11 2004/04/18 23:51:37 jsdever Exp $ 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * $Revision: 480424 $ 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $ 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ==================================================================== 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this work for additional information regarding copyright ownership. 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * (the "License"); you may not use this file except in compliance with 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the License. You may obtain a copy of the License at 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * ==================================================================== 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This software consists of voluntary contributions made by many 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information on the Apache Software Foundation, please see 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <http://www.apache.org/>. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage com.android.internal.http.multipart; 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.OutputStream; 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport java.io.IOException; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.apache.http.util.EncodingUtils; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.apache.commons.logging.Log; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport org.apache.commons.logging.LogFactory; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Simple string parameter for a multipart post 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @author <a href="mailto:mattalbright@yahoo.com">Matthew Albright</a> 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a> 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a> 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @since 2.0 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class StringPart extends PartBase { 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Log object for this class. */ 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private static final Log LOG = LogFactory.getLog(StringPart.class); 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Default content encoding of string parameters. */ 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final String DEFAULT_CONTENT_TYPE = "text/plain"; 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Default charset of string parameters*/ 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final String DEFAULT_CHARSET = "US-ASCII"; 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Default transfer encoding of string parameters*/ 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static final String DEFAULT_TRANSFER_ENCODING = "8bit"; 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** Contents of this StringPart. */ 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private byte[] content; 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** The String value of this part. */ 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private String value; 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructor. 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param name The name of the part 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value the string to post 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param charset the charset to be used to encode the string, if <code>null</code> 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the {@link #DEFAULT_CHARSET default} is used 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public StringPart(String name, String value, String charset) { 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super( 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project name, 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT_CONTENT_TYPE, 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project charset == null ? DEFAULT_CHARSET : charset, 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project DEFAULT_TRANSFER_ENCODING 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ); 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value == null) { 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("Value may not be null"); 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (value.indexOf(0) != -1) { 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // See RFC 2048, 2.8. "8bit Data" 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project throw new IllegalArgumentException("NULs may not be present in string parts"); 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.value = value; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Constructor. 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param name The name of the part 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param value the string to post 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public StringPart(String name, String value) { 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this(name, value, null); 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the content in bytes. Bytes are lazily created to allow the charset to be changed 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the part is created. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return the content in bytes 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private byte[] getContent() { 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (content == null) { 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project content = EncodingUtils.getBytes(value, getCharSet()); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return content; 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Writes the data to the given OutputStream. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param out the OutputStream to write to 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @throws IOException if there is a write error 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void sendData(OutputStream out) throws IOException { 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project LOG.trace("enter sendData(OutputStream)"); 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project out.write(getContent()); 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the length of the data. 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The length of the data. 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Part#lengthOfData() 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected long lengthOfData() { 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project LOG.trace("enter lengthOfData()"); 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getContent().length; 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /* (non-Javadoc) 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see org.apache.commons.httpclient.methods.multipart.BasePart#setCharSet(java.lang.String) 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setCharSet(String charSet) { 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.setCharSet(charSet); 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.content = null; 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 151