View Javadoc

1   /*
2    * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/multipart/ByteArrayPartSource.java,v 1.7 2004/04/18 23:51:37 jsdever Exp $
3    * $Revision: 155418 $
4    * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
5    *
6    * ====================================================================
7    *
8    *  Copyright 2002-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  
30  package org.apache.commons.httpclient.methods.multipart;
31  
32  import java.io.ByteArrayInputStream;
33  import java.io.IOException;
34  import java.io.InputStream;
35  
36  /***
37   * A PartSource that reads from a byte array.  This class should be used when
38   * the data to post is already loaded into memory.
39   * 
40   * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
41   *   
42   * @since 2.0 
43   */
44  public class ByteArrayPartSource implements PartSource {
45  
46      /*** Name of the source file. */
47      private String fileName;
48  
49      /*** Byte array of the source file. */
50      private byte[] bytes;
51  
52      /***
53       * Constructor for ByteArrayPartSource.
54       * 
55       * @param fileName the name of the file these bytes represent
56       * @param bytes the content of this part
57       */
58      public ByteArrayPartSource(String fileName, byte[] bytes) {
59  
60          this.fileName = fileName;
61          this.bytes = bytes;
62  
63      }
64  
65      /***
66       * @see PartSource#getLength()
67       */
68      public long getLength() {
69          return bytes.length;
70      }
71  
72      /***
73       * @see PartSource#getFileName()
74       */
75      public String getFileName() {
76          return fileName;
77      }
78  
79      /***
80       * @see PartSource#createInputStream()
81       */
82      public InputStream createInputStream() throws IOException {
83          return new ByteArrayInputStream(bytes);
84      }
85  
86  }