001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package com.sun.rave.web.ui.model;
042:
043: import java.io.File;
044: import java.io.InputStream;
045: import java.io.IOException;
046: import java.io.Serializable;
047:
048: /**
049: *
050: * @author avk
051: */
052: public interface UploadedFile extends Serializable {
053:
054: /**
055: * Returns a {@link java.io.InputStream InputStream} for reading the file.
056: *
057: * @return An {@link java.io.InputStream InputStream} for reading the file.
058: *
059: * @exception IOException if there is a problem while reading the file
060: */
061: public InputStream getInputStream() throws IOException;
062:
063: /**
064: * Get the content-type that the browser communicated with the request
065: * that included the uploaded file. If the browser did not specify a
066: * content-type, this method returns null.
067: *
068: * @return the content-type that the browser communicated with the request
069: * that included the uploaded file
070: */
071: public String getContentType();
072:
073: /**
074: * Use this method to retrieve the name that the file has on the web
075: * application user's local system.
076: *
077: * @return the name of the file on the web app user's system
078: */
079: public String getOriginalName();
080:
081: // ------------------------------------------------------- FileItem methods
082:
083: /**
084: * The size of the file in bytes
085: *
086: * @return The size of the file in bytes.
087: */
088: public long getSize();
089:
090: /**
091: * Use this method to retrieve the contents of the file as an array of bytes.
092: * @return The contents of the file as a byte array
093: */
094: public byte[] getBytes();
095:
096: /**
097: * Use this method to retrieve the contents of the file as a String
098: *
099: * @return the contents of the file as a String
100: */
101: public String getAsString();
102:
103: /**
104: * Write the contents of the uploaded file to a file on the server host.
105: * Note that writing files outside of the web server's tmp directory
106: * must be explicitly permitted through configuration of the server's
107: * security policy.
108: *
109: * This method is not guaranteed to succeed if called more than once for
110: * the same item.
111: * @param file The <code>File</code> where the contents should be written
112: *
113: * @exception Exception the
114: */
115: public void write(File file) throws Exception;
116:
117: /**
118: * Dispose of the resources associated with the file upload (this will
119: * happen automatically when the resource is garbage collected).
120: */
121: public void dispose();
122:
123: }
|