View Javadoc

1   /*
2    * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/ByteArrayPartSource.java,v 1.5.2.1 2004/02/22 18:21:15 olegk Exp $
3    * $Revision: 1.5.2.1 $
4    * $Date: 2004/02/22 18:21:15 $
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   * [Additional notices, if required by prior licensing conditions]
29   *
30   */
31  
32  package org.apache.commons.httpclient.methods.multipart;
33  
34  import java.io.ByteArrayInputStream;
35  import java.io.IOException;
36  import java.io.InputStream;
37  
38  /***
39   * A PartSource that reads from a byte array.  This class should be used when
40   * the data to post is already loaded into memory.
41   * 
42   * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
43   *   
44   * @since 2.0 
45   */
46  public class ByteArrayPartSource implements PartSource {
47  
48      /*** Name of the source file. */
49      private String fileName;
50  
51      /*** Byte array of the source file. */
52      private byte[] bytes;
53  
54      /***
55       * Constructor for ByteArrayPartSource.
56       * 
57       * @param fileName the name of the file these bytes represent
58       * @param bytes the content of this part
59       */
60      public ByteArrayPartSource(String fileName, byte[] bytes) {
61  
62          this.fileName = fileName;
63          this.bytes = bytes;
64  
65      }
66  
67      /***
68       * @see PartSource#getLength()
69       */
70      public long getLength() {
71          return bytes.length;
72      }
73  
74      /***
75       * @see PartSource#getFileName()
76       */
77      public String getFileName() {
78          return fileName;
79      }
80  
81      /***
82       * @see PartSource#createInputStream()
83       */
84      public InputStream createInputStream() throws IOException {
85          return new ByteArrayInputStream(bytes);
86      }
87  
88  }