1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/multipart/FilePartSource.java,v 1.8 2003/03/11 19:54:48 olegk Exp $
3 * $Revision: 1.8 $
4 * $Date: 2003/03/11 19:54:48 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient.methods.multipart;
65
66 import java.io.ByteArrayInputStream;
67 import java.io.File;
68 import java.io.FileInputStream;
69 import java.io.FileNotFoundException;
70 import java.io.IOException;
71 import java.io.InputStream;
72
73 /***
74 * A PartSource that reads from a File.
75 *
76 * @author <a href="mailto:becke@u.washington.edu">Michael Becke</a>
77 * @author <a href="mailto:mdiggory@latte.harvard.edu">Mark Diggory</a>
78 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
79 *
80 * @since 2.0
81 */
82 public class FilePartSource implements PartSource {
83
84 /*** File part file. */
85 private File file = null;
86
87 /*** File part file name. */
88 private String fileName = null;
89
90 /***
91 * Constructor for FilePartSource.
92 *
93 * @param file the FilePart source File.
94 *
95 * @throws FileNotFoundException if the file does not exist or
96 * cannot be read
97 */
98 public FilePartSource(File file) throws FileNotFoundException {
99 this.file = file;
100 if (file != null) {
101 if (!file.isFile()) {
102 throw new FileNotFoundException("File is not a normal file.");
103 }
104 if (!file.canRead()) {
105 throw new FileNotFoundException("File is not readable.");
106 }
107 this.fileName = file.getName();
108 }
109 }
110
111 /***
112 * Constructor for FilePartSource.
113 *
114 * @param fileName the file name of the FilePart
115 * @param file the source File for the FilePart
116 *
117 * @throws FileNotFoundException if the file does not exist or
118 * cannot be read
119 */
120 public FilePartSource(String fileName, File file)
121 throws FileNotFoundException {
122 this(file);
123 if (fileName != null) {
124 this.fileName = fileName;
125 }
126 }
127
128 /***
129 * Return the length of the file
130 * @return the length of the file.
131 * @see PartSource#getLength()
132 */
133 public long getLength() {
134 if (this.file != null) {
135 return this.file.length();
136 } else {
137 return 0;
138 }
139 }
140
141 /***
142 * Return the current filename
143 * @return the filename.
144 * @see PartSource#getFileName()
145 */
146 public String getFileName() {
147 return (fileName == null) ? "noname" : fileName;
148 }
149
150 /***
151 * Return a new {@link FileInputStream} for the current filename.
152 * @return the new input stream.
153 * @throws IOException If an IO problem occurs.
154 * @see PartSource#createInputStream()
155 */
156 public InputStream createInputStream() throws IOException {
157 if (this.file != null) {
158 return new FileInputStream(this.file);
159 } else {
160 return new ByteArrayInputStream(new byte[] {});
161 }
162 }
163
164 }
This page was automatically generated by Maven