public class FileUploadInterceptor extends AbstractInterceptor
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 struts-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 method to provide more control over which files are supported and which are not.
Example code:
<action name="doUpload" class="com.example.UploadAction"> <interceptor-ref name="fileUpload"/> <interceptor-ref name="basicStack"/> <result name="success">good_result.jsp</result> </action>
You must set the encoding to multipart/form-data
in the form where the user selects the file to upload.
<s:form action="doUpload" method="post" enctype="multipart/form-data"> <s:file name="upload" label="File"/> <s:submit/> </s: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.
package com.example; import java.io.File; import com.opensymphony.xwork2.ActionSupport; public UploadAction extends ActionSupport { 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; } public String execute() { //... return SUCCESS; } }
Modifier and Type | Field and Description |
---|---|
protected Set<String> |
allowedExtensionsSet |
protected Set<String> |
allowedTypesSet |
protected static org.apache.logging.log4j.Logger |
LOG |
protected Long |
maximumSize |
Constructor and Description |
---|
FileUploadInterceptor() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
acceptFile(Object action,
UploadedFile file,
String filename,
String contentType,
String inputName,
ValidationAware validation)
Override for added functionality.
|
protected String |
getTextMessage(Object action,
String messageKey,
String[] args) |
protected String |
getTextMessage(String messageKey,
String[] args) |
String |
intercept(ActionInvocation invocation)
Override to handle interception
|
void |
setAllowedExtensions(String allowedExtensions)
Sets the allowed extensions
|
void |
setAllowedTypes(String allowedTypes)
Sets the allowed mimetypes
|
void |
setContainer(Container container) |
void |
setMatcher(ContentTypeMatcher matcher) |
void |
setMaximumSize(Long maximumSize)
Sets the maximum size of an uploaded file
|
destroy, init
protected static final org.apache.logging.log4j.Logger LOG
protected Long maximumSize
public void setMatcher(ContentTypeMatcher matcher)
public void setContainer(Container container)
public void setAllowedExtensions(String allowedExtensions)
allowedExtensions
- A comma-delimited list of extensionspublic void setAllowedTypes(String allowedTypes)
allowedTypes
- A comma-delimited list of typespublic void setMaximumSize(Long maximumSize)
maximumSize
- The maximum size in bytespublic String intercept(ActionInvocation invocation) throws Exception
AbstractInterceptor
intercept
in interface Interceptor
intercept
in class AbstractInterceptor
invocation
- the action invocationActionInvocation.invoke()
, or from the interceptor itself.Exception
- any system-level error, as defined in Action.execute()
.protected boolean acceptFile(Object action, UploadedFile file, String filename, String contentType, String inputName, ValidationAware validation)
action
- - uploading action for message retrieval.file
- - proposed upload file.filename
- - name of the file.contentType
- - contentType of the file.inputName
- - inputName of the file.validation
- - Non-null ValidationAware if the action implements ValidationAware, allowing for better
logging.Copyright © 2000–2020 Apache Software Foundation. All rights reserved.