001// Copyright 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.multipart;
016
017import org.apache.tapestry.request.IUploadFile;
018
019/**
020 * Responsible for detecting and processing file upload requests, using Jakarta
021 * Commons FileUpload. Implementations of this service typically use the
022 * threaded service lifecycle model.
023 * 
024 * @author Howard M. Lewis Ship
025 * @since 4.0
026 */
027public interface MultipartDecoder {
028        
029        /**
030         * Gets a file upload with the given name, or returns null if no such file
031         * upload was in the request.
032         */
033
034        public IUploadFile getFileUpload(String parameterName);
035    
036        /**
037         * Cleans up any temporary resources created during the request processing.
038         * This typically includes temporary files used to contain uploaded file
039         * content.
040         */
041
042        void cleanup();
043}