001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.cocoon.servlet.multipart;
018:
019: import java.io.FileOutputStream;
020: import java.io.IOException;
021: import java.io.InputStream;
022: import java.io.OutputStream;
023: import java.util.Map;
024:
025: import org.apache.avalon.framework.activity.Disposable;
026: import org.apache.commons.io.IOUtils;
027: import org.apache.excalibur.source.ModifiableSource;
028:
029: /**
030: * This abstract class represents a file part parsed from a http post stream. The concrete
031: * class, {@link PartOnDisk} or {@link PartInMemory} that is used depends on the upload configuration
032: * in <code>web.xml</code>.
033: * <p>
034: * If uploaded data size exceeds the maximum allowed upload size (also specified in <code>web.xml</code>),
035: * then an {@link RejectedPart} is used, from which no data can be obtained, but which gives some
036: * information on the rejected uploads.
037: *
038: * @author <a href="mailto:j.tervoorde@home.nl">Jeroen ter Voorde</a>
039: * @version $Id: Part.java 433543 2006-08-22 06:22:54Z crossley $
040: */
041: public abstract class Part implements Disposable {
042:
043: private boolean disposeWithRequest = true;
044:
045: /** Field headers */
046: protected Map headers;
047:
048: protected Part(Map headers) {
049: this .headers = headers;
050: }
051:
052: /**
053: * Returns the part headers
054: */
055: public Map getHeaders() {
056: return headers;
057: }
058:
059: /**
060: * Returns the filename
061: */
062: public abstract String getFileName();
063:
064: /**
065: * Returns the original filename
066: */
067: public String getUploadName() {
068: return (String) headers.get("filename");
069: }
070:
071: /**
072: * Returns the length of the file content
073: */
074: public abstract int getSize();
075:
076: /**
077: * Is this part a rejected part? Provided as an alternative to <code>instanceof RejectedPart</code>
078: * in places where it's not convenient such as flowscript.
079: *
080: * @return <code>true</code> if this part was rejected
081: */
082: public boolean isRejected() {
083: return false;
084: }
085:
086: /**
087: * Returns the mime type (or null if unknown)
088: */
089: public String getMimeType() {
090: return (String) headers.get("content-type");
091: }
092:
093: /**
094: * Do we want any temporary resource held by this part to be cleaned up when processing of
095: * the request that created it is finished? Default is <code>true</code>.
096: *
097: * @return <code>true</code> if the part should be disposed with the request.
098: */
099: public boolean disposeWithRequest() {
100: return this .disposeWithRequest;
101: }
102:
103: /**
104: * Set the value of the <code>disposeWithRequest</code> flag (default is <code>true</code>).
105: *
106: * @param dispose <code>true</code> if the part should be disposed after request processing
107: */
108: public void setDisposeWithRequest(boolean dispose) {
109: this .disposeWithRequest = dispose;
110: }
111:
112: /**
113: * Returns an InputStream containing the file data
114: * @throws IOException
115: */
116: public abstract InputStream getInputStream() throws IOException;
117:
118: /**
119: * Convenience method to copy a part to a modifiable source.
120: *
121: * @param source the modifiable source to write to
122: * @throws IOException
123: * @since 2.1.8
124: */
125: public void copyToSource(ModifiableSource source)
126: throws IOException {
127: InputStream is = getInputStream();
128: OutputStream os = source.getOutputStream();
129: IOUtils.copy(is, os);
130: is.close();
131: os.close();
132: }
133:
134: /**
135: * Convenience method to copy a part to a file.
136: *
137: * @param filename name of the file to write to
138: * @throws IOException
139: * @since 2.1.8
140: */
141: public void copyToFile(String filename) throws IOException {
142: InputStream is = getInputStream();
143: OutputStream os = new FileOutputStream(filename);
144: IOUtils.copy(is, os);
145: is.close();
146: os.close();
147: }
148:
149: /**
150: * Dispose any resources held by this part, such as a file or memory buffer.
151: * <p>
152: * Disposal occurs in all cases when the part is garbage collected, but calling it explicitely
153: * allows to cleanup resources more quickly.
154: */
155: public abstract void dispose();
156: }
|