KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > multipart > MultipartDecoder


1 // Copyright 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.tapestry.multipart;
16
17 import javax.servlet.http.HttpServletRequest JavaDoc;
18
19 import org.apache.tapestry.request.IUploadFile;
20
21 /**
22  * Responsible for detecting and processing file upload requests, using Jakarta Commons FileUpload.
23  * Implementations of this service typically use the threaded service lifecycle model.
24  *
25  * @author Howard M. Lewis Ship
26  * @since 4.0
27  */
28 public interface MultipartDecoder
29 {
30     /**
31      * Decodes the request, returning a new {@link javax.servlet.http.HttpServletRequest}
32      * implementation that will allow access to the form fields submitted in the request (but omits
33      * uploaded files.
34      */
35
36     public HttpServletRequest JavaDoc decode(HttpServletRequest JavaDoc request);
37
38     /**
39      * Gets a file upload with the given name, or returns null if no such file upload was in the
40      * request.
41      */
42
43     public IUploadFile getFileUpload(String JavaDoc parameterName);
44
45     /**
46      * Cleans up any temporary resources created during the request processing. This typically
47      * includes temporary files used to contain uploaded file content.
48      */
49
50     public void cleanup();
51 }
Popular Tags