001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.upload;
016    
017    import java.io.File;
018    import java.io.IOException;
019    import java.io.InputStream;
020    
021    import java.util.List;
022    import java.util.Map;
023    
024    import javax.servlet.http.HttpServletRequest;
025    
026    /**
027     * @author Brian Wing Shun Chan
028     * @author Eduardo Lundgren
029     */
030    public interface UploadRequest extends HttpServletRequest {
031    
032            public void cleanUp();
033    
034            public String getContentType(String name);
035    
036            public File getFile(String name);
037    
038            public File getFile(String name, boolean forceCreate);
039    
040            public InputStream getFileAsStream(String name) throws IOException;
041    
042            public InputStream getFileAsStream(String name, boolean deleteOnClose)
043                    throws IOException;
044    
045            public String getFileName(String name);
046    
047            public String[] getFileNames(String name);
048    
049            public File[] getFiles(String name);
050    
051            public InputStream[] getFilesAsStream(String name) throws IOException;
052    
053            public InputStream[] getFilesAsStream(String name, boolean deleteOnClose)
054                    throws IOException;
055    
056            public String getFullFileName(String name);
057    
058            public Map<String, FileItem[]> getMultipartParameterMap();
059    
060            public Map<String, List<String>> getRegularParameterMap();
061    
062            public Long getSize(String name);
063    
064            public Boolean isFormField(String name);
065    
066    }