001: /*
002: * $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 $
003: * $Revision: 480424 $
004: * $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
005: *
006: * ====================================================================
007: *
008: * Licensed to the Apache Software Foundation (ASF) under one or more
009: * contributor license agreements. See the NOTICE file distributed with
010: * this work for additional information regarding copyright ownership.
011: * The ASF licenses this file to You under the Apache License, Version 2.0
012: * (the "License"); you may not use this file except in compliance with
013: * the License. You may obtain a copy of the License at
014: *
015: * http://www.apache.org/licenses/LICENSE-2.0
016: *
017: * Unless required by applicable law or agreed to in writing, software
018: * distributed under the License is distributed on an "AS IS" BASIS,
019: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
020: * See the License for the specific language governing permissions and
021: * limitations under the License.
022: * ====================================================================
023: *
024: * This software consists of voluntary contributions made by many
025: * individuals on behalf of the Apache Software Foundation. For more
026: * information on the Apache Software Foundation, please see
027: * <http://www.apache.org/>.
028: *
029: */
030:
031: package org.apache.commons.httpclient.methods.multipart;
032:
033: import java.io.OutputStream;
034: import java.io.IOException;
035:
036: import org.apache.commons.httpclient.util.EncodingUtil;
037: import org.apache.commons.logging.Log;
038: import org.apache.commons.logging.LogFactory;
039:
040: /**
041: * Simple string parameter for a multipart post
042: *
043: * @author <a href="mailto:mattalbright@yahoo.com">Matthew Albright</a>
044: * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
045: * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
046: * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
047: *
048: * @since 2.0
049: */
050: public class StringPart extends PartBase {
051:
052: /** Log object for this class. */
053: private static final Log LOG = LogFactory.getLog(StringPart.class);
054:
055: /** Default content encoding of string parameters. */
056: public static final String DEFAULT_CONTENT_TYPE = "text/plain";
057:
058: /** Default charset of string parameters*/
059: public static final String DEFAULT_CHARSET = "US-ASCII";
060:
061: /** Default transfer encoding of string parameters*/
062: public static final String DEFAULT_TRANSFER_ENCODING = "8bit";
063:
064: /** Contents of this StringPart. */
065: private byte[] content;
066:
067: /** The String value of this part. */
068: private String value;
069:
070: /**
071: * Constructor.
072: *
073: * @param name The name of the part
074: * @param value the string to post
075: * @param charset the charset to be used to encode the string, if <code>null</code>
076: * the {@link #DEFAULT_CHARSET default} is used
077: */
078: public StringPart(String name, String value, String charset) {
079:
080: super (name, DEFAULT_CONTENT_TYPE,
081: charset == null ? DEFAULT_CHARSET : charset,
082: DEFAULT_TRANSFER_ENCODING);
083: if (value == null) {
084: throw new IllegalArgumentException("Value may not be null");
085: }
086: if (value.indexOf(0) != -1) {
087: // See RFC 2048, 2.8. "8bit Data"
088: throw new IllegalArgumentException(
089: "NULs may not be present in string parts");
090: }
091: this .value = value;
092: }
093:
094: /**
095: * Constructor.
096: *
097: * @param name The name of the part
098: * @param value the string to post
099: */
100: public StringPart(String name, String value) {
101: this (name, value, null);
102: }
103:
104: /**
105: * Gets the content in bytes. Bytes are lazily created to allow the charset to be changed
106: * after the part is created.
107: *
108: * @return the content in bytes
109: */
110: private byte[] getContent() {
111: if (content == null) {
112: content = EncodingUtil.getBytes(value, getCharSet());
113: }
114: return content;
115: }
116:
117: /**
118: * Writes the data to the given OutputStream.
119: * @param out the OutputStream to write to
120: * @throws IOException if there is a write error
121: */
122: protected void sendData(OutputStream out) throws IOException {
123: LOG.trace("enter sendData(OutputStream)");
124: out.write(getContent());
125: }
126:
127: /**
128: * Return the length of the data.
129: * @return The length of the data.
130: * @throws IOException If an IO problem occurs
131: * @see org.apache.commons.httpclient.methods.multipart.Part#lengthOfData()
132: */
133: protected long lengthOfData() throws IOException {
134: LOG.trace("enter lengthOfData()");
135: return getContent().length;
136: }
137:
138: /* (non-Javadoc)
139: * @see org.apache.commons.httpclient.methods.multipart.BasePart#setCharSet(java.lang.String)
140: */
141: public void setCharSet(String charSet) {
142: super.setCharSet(charSet);
143: this.content = null;
144: }
145:
146: }
|