1 /*
2 * $Source$
3 * $Revision$
4 *
5 * Copyright (C) 2000 Myles Chippendale
6 *
7 * Part of Melati (http://melati.org), a framework for the rapid
8 * development of clean, maintainable web applications.
9 *
10 * Melati is free software; Permission is granted to copy, distribute
11 * and/or modify this software under the terms either:
12 *
13 * a) the GNU General Public License as published by the Free Software
14 * Foundation; either version 2 of the License, or (at your option)
15 * any later version,
16 *
17 * or
18 *
19 * b) any version of the Melati Software License, as published
20 * at http://melati.org
21 *
22 * You should have received a copy of the GNU General Public License and
23 * the Melati Software License along with this program;
24 * if not, write to the Free Software Foundation, Inc.,
25 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA to obtain the
26 * GNU General Public License and visit http://melati.org to obtain the
27 * Melati Software License.
28 *
29 * Feel free to contact the Developers of Melati (http://melati.org),
30 * if you would like to work out a different arrangement than the options
31 * outlined here. It is our intention to allow Melati to be used by as
32 * wide an audience as possible.
33 *
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
38 *
39 * Contact details for copyright holder:
40 *
41 * Mylesc Chippendale <mylesc@paneris.org>
42 * http://paneris.org/
43 * 29 Stanley Road, Oxford, OX4 1QY, UK
44 */
45
46 package org.melati.servlet;
47
48 import java.io.File;
49 import java.io.IOException;
50 import org.melati.util.DelimitedBufferedInputStream;
51
52 /**
53 * An interface to the data portion of a MultipartFormField.
54 * <p>
55 * This data is read in by <code>readData</code> and stored
56 * somewhere for later access by the other functions.
57 * <p>
58 * A class implementing FormDataAdaptor needs to implement at least
59 * the <code>getData()</code> and <code>getSize()</code> functions
60 * but need not provide a URL or a File for its data.
61 */
62
63 public interface FormDataAdaptor {
64
65 /**
66 * Return the data as a byte array.
67 * @return the <code>byte[]</code>
68 */
69 byte[] getData();
70
71 /**
72 * Return the size of the data.
73 * @return the size as a <code>long</code>
74 */
75 long getSize();
76
77 /**
78 * Return a File object pointing to the saved data or null
79 * if none exists.
80 * @return the <code>File</code>
81 */
82 File getFile();
83
84 /**
85 * Return a url to the object or null if none exists.
86 * @return the url as a <code>String</code> or <code>null</code>
87 */
88 String getURL();
89
90 /**
91 * Read data from <code>in</code> until the delim is found and
92 * save the data so that we can access it again.
93 *
94 * @param field a {@link MultipartFormField} to be read
95 * @param in a {@link DelimitedBufferedInputStream} to read from
96 * @param delim the delimitor to differentiate elements
97 * @throws IOException if there is a problem reading the input
98 */
99 void readData(MultipartFormField field,
100 DelimitedBufferedInputStream in,
101 byte[] delim)
102 throws IOException;
103 }
104
105
106
107
108
109