org.springframework.web.portlet.multipart

Class DefaultMultipartActionRequest

java.lang.Object

javax.portlet.filter.PortletRequestWrapper

javax.portlet.filter.ActionRequestWrapper

org.springframework.web.portlet.multipart.DefaultMultipartActionRequest

All Implemented Interfaces:

ActionRequest, ClientDataRequest, PortletRequest, org.springframework.web.multipart.MultipartRequest, MultipartActionRequest

public class DefaultMultipartActionRequest
extends ActionRequestWrapper
implements MultipartActionRequest

Default implementation of the MultipartActionRequest interface. Provides management of pre-generated parameter values.

Since:

2.0

Author:

Juergen Hoeller, Arjen Poutsma

See Also:

PortletMultipartResolver

Nested Class Summary

Nested classes/interfaces inherited from interface javax.portlet.PortletRequest

PortletRequest.P3PUserInfos

Field Summary

Fields inherited from interface javax.portlet.ActionRequest

ACTION_NAME

Fields inherited from interface javax.portlet.PortletRequest

ACTION_PHASE, ACTION_SCOPE_ID, BASIC_AUTH, CCPP_PROFILE, CLIENT_CERT_AUTH, DIGEST_AUTH, EVENT_PHASE, FORM_AUTH, LIFECYCLE_PHASE, RENDER_HEADERS, RENDER_MARKUP, RENDER_PART, RENDER_PHASE, RESOURCE_PHASE, USER_INFO

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultMultipartActionRequest(ActionRequest request) Wrap the given Portlet ActionRequest in a MultipartActionRequest.
	DefaultMultipartActionRequest(ActionRequest request, org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> mpFiles, Map<String,String[]> mpParams, Map<String,String> mpParamContentTypes) Wrap the given Portlet ActionRequest in a MultipartActionRequest.

Method Summary

Modifier and Type	Method and Description
org.springframework.web.multipart.MultipartFile	getFile(String name)
Map<String,org.springframework.web.multipart.MultipartFile>	getFileMap()
Iterator<String>	getFileNames()
List<org.springframework.web.multipart.MultipartFile>	getFiles(String name)
org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile>	getMultiFileMap()
String	getMultipartContentType(String paramOrFileName)
protected org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile>	getMultipartFiles() Obtain the MultipartFile Map for retrieval, lazily initializing it if necessary.
protected Map<String,String>	getMultipartParameterContentTypes() Obtain the multipart parameter content type Map for retrieval, lazily initializing it if necessary.
protected Map<String,String[]>	getMultipartParameters() Obtain the multipart parameter Map for retrieval, lazily initializing it if necessary.
String	getParameter(String name)
Map<String,String[]>	getParameterMap()
Enumeration<String>	getParameterNames()
String[]	getParameterValues(String name)
protected void	initializeMultipart() Lazily initialize the multipart request, if possible.
protected void	setMultipartFiles(org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> multipartFiles) Set a Map with parameter names as keys and list of MultipartFile objects as values.
protected void	setMultipartParameterContentTypes(Map<String,String> multipartParameterContentTypes) Set a Map with parameter names as keys and content type Strings as values.
protected void	setMultipartParameters(Map<String,String[]> multipartParameters) Set a Map with parameter names as keys and String array objects as values.

Methods inherited from class javax.portlet.filter.ActionRequestWrapper

getCharacterEncoding, getContentLength, getContentType, getMethod, getPortletInputStream, getReader, getRequest, setCharacterEncoding, setRequest

Methods inherited from class javax.portlet.filter.PortletRequestWrapper

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute, setRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.portlet.ClientDataRequest

getCharacterEncoding, getContentLength, getContentType, getMethod, getPortletInputStream, getReader, setCharacterEncoding

Methods inherited from interface javax.portlet.PortletRequest

getAttribute, getAttributeNames, getAuthType, getContextPath, getCookies, getLocale, getLocales, getPortalContext, getPortletMode, getPortletSession, getPortletSession, getPreferences, getPrivateParameterMap, getProperties, getProperty, getPropertyNames, getPublicParameterMap, getRemoteUser, getRequestedSessionId, getResponseContentType, getResponseContentTypes, getScheme, getServerName, getServerPort, getUserPrincipal, getWindowID, getWindowState, isPortletModeAllowed, isRequestedSessionIdValid, isSecure, isUserInRole, isWindowStateAllowed, removeAttribute, setAttribute

Constructor Detail

DefaultMultipartActionRequest

public DefaultMultipartActionRequest(ActionRequest request,
                                     org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> mpFiles,
                                     Map<String,String[]> mpParams,
                                     Map<String,String> mpParamContentTypes)

Wrap the given Portlet ActionRequest in a MultipartActionRequest.

Parameters:

request - the request to wrap

mpFiles - a map of the multipart files

mpParams - a map of the parameters to expose, with Strings as keys and String arrays as values

DefaultMultipartActionRequest

protected DefaultMultipartActionRequest(ActionRequest request)

Wrap the given Portlet ActionRequest in a MultipartActionRequest.

Parameters:

request - the request to wrap

Method Detail

getFileNames

public Iterator<String> getFileNames()

Specified by:

getFileNames in interface org.springframework.web.multipart.MultipartRequest

getFile

public org.springframework.web.multipart.MultipartFile getFile(String name)

Specified by:

getFile in interface org.springframework.web.multipart.MultipartRequest

getFiles

public List<org.springframework.web.multipart.MultipartFile> getFiles(String name)

Specified by:

getFiles in interface org.springframework.web.multipart.MultipartRequest

getFileMap

public Map<String,org.springframework.web.multipart.MultipartFile> getFileMap()

Specified by:

getFileMap in interface org.springframework.web.multipart.MultipartRequest

getMultiFileMap

public org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> getMultiFileMap()

Specified by:

getMultiFileMap in interface org.springframework.web.multipart.MultipartRequest

getParameterNames

public Enumeration<String> getParameterNames()

Specified by:

getParameterNames in interface PortletRequest

Overrides:

getParameterNames in class PortletRequestWrapper

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface PortletRequest

Overrides:

getParameter in class PortletRequestWrapper

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface PortletRequest

Overrides:

getParameterValues in class PortletRequestWrapper

getParameterMap

public Map<String,String[]> getParameterMap()

Specified by:

getParameterMap in interface PortletRequest

Overrides:

getParameterMap in class PortletRequestWrapper

getMultipartContentType

public String getMultipartContentType(String paramOrFileName)

Specified by:

getMultipartContentType in interface org.springframework.web.multipart.MultipartRequest

setMultipartFiles

protected final void setMultipartFiles(org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> multipartFiles)

Set a Map with parameter names as keys and list of MultipartFile objects as values. To be invoked by subclasses on initialization.

getMultipartFiles

protected org.springframework.util.MultiValueMap<String,org.springframework.web.multipart.MultipartFile> getMultipartFiles()

Obtain the MultipartFile Map for retrieval, lazily initializing it if necessary.

See Also:

initializeMultipart()

setMultipartParameters

protected final void setMultipartParameters(Map<String,String[]> multipartParameters)

Set a Map with parameter names as keys and String array objects as values. To be invoked by subclasses on initialization.

getMultipartParameters

protected Map<String,String[]> getMultipartParameters()

Obtain the multipart parameter Map for retrieval, lazily initializing it if necessary.

See Also:

initializeMultipart()

setMultipartParameterContentTypes

protected final void setMultipartParameterContentTypes(Map<String,String> multipartParameterContentTypes)

Set a Map with parameter names as keys and content type Strings as values. To be invoked by subclasses on initialization.

getMultipartParameterContentTypes

protected Map<String,String> getMultipartParameterContentTypes()

Obtain the multipart parameter content type Map for retrieval, lazily initializing it if necessary.

See Also:

initializeMultipart()

initializeMultipart

protected void initializeMultipart()

Lazily initialize the multipart request, if possible. Only called if not already eagerly initialized.