/*
* $Id: MultiPartRequest.java 651946 2008-04-27 13:41:38Z apetrelli $
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.struts2.dispatcher.multipart;
import java.io.File;
import java.io.IOException;
import java.util.Enumeration;
import java.util.List;
import javax.servlet.http.HttpServletRequest;
/**
* Abstract wrapper class HTTP requests to handle multi-part data. <p>
*
*/
public interface MultiPartRequest {
public void parse(HttpServletRequest request, String saveDir) throws IOException;
/**
* Returns an enumeration of the parameter names for uploaded files
*
* @return an enumeration of the parameter names for uploaded files
*/
public Enumeration<String> getFileParameterNames();
/**
* Returns the content type(s) of the file(s) associated with the specified field name
* (as supplied by the client browser), or <tt>null</tt> if no files are associated with the
* given field name.
*
* @param fieldName input field name
* @return an array of content encoding for the specified input field name or <tt>null</tt> if
* no content type was specified.
*/
public String[] getContentType(String fieldName);
/**
* Returns a {@link java.io.File} object for the filename specified or <tt>null</tt> if no files
* are associated with the given field name.
*
* @param fieldName input field name
* @return a File[] object for files associated with the specified input field name
*/
public File[] getFile(String fieldName);
/**
* Returns a String[] of file names for files associated with the specified input field name
*
* @param fieldName input field name
* @return a String[] of file names for files associated with the specified input field name
*/
public String[] getFileNames(String fieldName);
/**
* Returns the file system name(s) of files associated with the given field name or
* <tt>null</tt> if no files are associated with the given field name.
*
* @param fieldName input field name
* @return the file system name(s) of files associated with the given field name
*/
public String[] getFilesystemName(String fieldName);
/**
* Returns the specified request parameter.
*
* @param name the name of the parameter to get
* @return the parameter or <tt>null</tt> if it was not found.
*/
public String getParameter(String name);
/**
* Returns an enumeration of String parameter names.
*
* @return an enumeration of String parameter names.
*/
public Enumeration<String> getParameterNames();
/**
* Returns a list of all parameter values associated with a parameter name. If there is only
* one parameter value per name the resulting array will be of length 1.
*
* @param name the name of the parameter.
* @return an array of all values associated with the parameter name.
*/
public String[] getParameterValues(String name);
/**
* Returns a list of error messages that may have occurred while processing the request.
* If there are no errors, an empty list is returned. If the underlying implementation
* (ie: pell, cos, jakarta, etc) cannot support providing these errors, an empty list is
* also returned. This list of errors is repoted back to the
* {@link MultiPartRequestWrapper}'s errors field.
*
* @return a list of Strings that represent various errors during parsing
*/
public List getErrors();
}
|