com.opensymphony.webwork.interceptor
Class FileUploadInterceptor

java.lang.Object
  extended by com.opensymphony.webwork.interceptor.FileUploadInterceptor
All Implemented Interfaces:
Interceptor, Serializable

public class FileUploadInterceptor
extends Object
implements Interceptor

Interceptor that is based off of MultiPartRequestWrapper, which is automatically applied for any request that includes a file. It adds the following parameters, where [File Name] is the name given to the file uploaded by the HTML form:

You can get access to these files by merely providing setters in your action that correspond to any of the three patterns above, such as setDocument(File document), setDocumentContentType(String contentType), etc.
See the example code section.

This interceptor will add several field errors, assuming that the action implements ValidationAware. These error messages are based on several i18n values stored in webwork-messages.properties, a default i18n file processed for all i18n requests. You can override the text of these messages by providing text for the following keys:

Interceptor parameters:

Extending the interceptor:

You can extend this interceptor and override the acceptFile(java.io.File, java.lang.String, java.lang.String, com.opensymphony.xwork.ValidationAware, java.util.Locale) method to provide more control over which files are supported and which are not.

Example code:

 
 <action name="doUpload" class="com.examples.UploadAction">
     <interceptor-ref name="fileUpload"/>
     <interceptor-ref name="basicStack"/>
     <result name="success">good_result.ftl</result>
 </action>
 
And then you need to set encoding multipart/form-data in the form where the user selects the file to upload.
   <ww:form action="doUpload" method="post" enctype="multipart/form-data">
       <ww:file name="upload" label="File"/>
       <ww:submit/>
   </ww:form>
 
And then in your action code you'll have access to the File object if you provide setters according to the naming convention documented in the start.
    public com.examples.UploadAction implemements Action {
       private File file;
       private String contentType;
       private String filename;

       public void setUpload(File file) {
          this.file = file;
       }

       public void setUploadContentType(String contentType) {
          this.contentType = contentType;
       }

       public void setUploadFileName(String filename) {
          this.filename = filename;
       }

       ...
  }
 

See Also:
Serialized Form

Field Summary
protected  String allowedTypes
           
protected  Set allowedTypesSet
           
protected static org.apache.commons.logging.Log log
           
protected  Long maximumSize
           
 
Constructor Summary
FileUploadInterceptor()
           
 
Method Summary
protected  boolean acceptFile(File file, String contentType, String inputName, ValidationAware validation, Locale locale)
          Override for added functionality.
protected  boolean containsItem(Collection itemCollection, String key)
           
 void destroy()
          Called to let an interceptor clean up any resources it has allocated.
protected  Set getDelimitedValues(String delimitedString)
           
protected  String getTextMessage(String messageKey, Object[] args, Locale locale)
           
 void init()
          Called after an interceptor is created, but before any requests are processed using intercept , giving the Interceptor a chance to initialize any needed resources.
 String intercept(ActionInvocation invocation)
          Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the ActionInvocation or to short-circuit the processing and just return a String return code.
protected  boolean isNonEmpty(Object[] objArray)
           
 void setAllowedTypes(String allowedTypes)
           
 void setMaximumSize(Long maximumSize)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static final org.apache.commons.logging.Log log

maximumSize

protected Long maximumSize

allowedTypes

protected String allowedTypes

allowedTypesSet

protected Set allowedTypesSet
Constructor Detail

FileUploadInterceptor

public FileUploadInterceptor()
Method Detail

setAllowedTypes

public void setAllowedTypes(String allowedTypes)

setMaximumSize

public void setMaximumSize(Long maximumSize)

destroy

public void destroy()
Description copied from interface: Interceptor
Called to let an interceptor clean up any resources it has allocated.

Specified by:
destroy in interface Interceptor

init

public void init()
Description copied from interface: Interceptor
Called after an interceptor is created, but before any requests are processed using intercept , giving the Interceptor a chance to initialize any needed resources.

Specified by:
init in interface Interceptor

intercept

public String intercept(ActionInvocation invocation)
                 throws Exception
Description copied from interface: Interceptor
Allows the Interceptor to do some processing on the request before and/or after the rest of the processing of the request by the ActionInvocation or to short-circuit the processing and just return a String return code.

Specified by:
intercept in interface Interceptor
Returns:
the return code, either returned from ActionInvocation.invoke(), or from the interceptor itself.
Throws:
Exception - any system-level error, as defined in Action.execute().

acceptFile

protected boolean acceptFile(File file,
                             String contentType,
                             String inputName,
                             ValidationAware validation,
                             Locale locale)
Override for added functionality. Checks if the proposed file is acceptable based on contentType and size.

Parameters:
file - - proposed upload file.
contentType - - contentType of the file.
inputName - - inputName of the file.
validation - - Non-null ValidationAware if the action implements ValidationAware, allowing for better logging.
locale -
Returns:
true if the proposed file is acceptable by contentType and size.

containsItem

protected boolean containsItem(Collection itemCollection,
                               String key)
Parameters:
itemCollection - - Collection of string items (all lowercase).
key - - Key to search for.
Returns:
true if itemCollection contains the key, false otherwise.

getDelimitedValues

protected Set getDelimitedValues(String delimitedString)

isNonEmpty

protected boolean isNonEmpty(Object[] objArray)

getTextMessage

protected String getTextMessage(String messageKey,
                                Object[] args,
                                Locale locale)

WebWork Project Page