com.manydesigns.elements.servlet

Class MutableHttpServletRequest

java.lang.Object

com.manydesigns.elements.servlet.MutableHttpServletRequest

All Implemented Interfaces:

MultipartWrapper, HttpServletRequest, ServletRequest

public class MutableHttpServletRequest
extends Object
implements HttpServletRequest, MultipartWrapper

Field Summary

Fields

Modifier and Type	Field and Description
Map<String,Object>	attributeMap
static String	copyright
Map<String,org.apache.commons.fileupload.FileItem>	fileItemMap
Map<String,String[]>	headerMap
List<Locale>	locales
Map<String,String[]>	parameterMap

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors

Constructor and Description
MutableHttpServletRequest()
MutableHttpServletRequest(MutableServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
boolean	addFileItem(String name, org.apache.commons.fileupload.FileItem item)
void	addParameter(String name, String value)
boolean	authenticate(HttpServletResponse response)
void	build(HttpServletRequest request, File tempDir, long maxPostSize) Pseudo-constructor that allows the class to perform any initialization necessary.
String	changeSessionId()
AsyncContext	getAsyncContext()
Object	getAttribute(String s)
Enumeration	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
long	getContentLengthLong()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String s)
DispatcherType	getDispatcherType()
org.apache.commons.fileupload.FileItem	getFileItem(String name)
Enumeration<String>	getFileParameterNames() Fetches the names of all file parameters in the request.
FileBean	getFileParameterValue(String name) Responsible for constructing a FileBean object for the named file parameter.
String	getHeader(String s)
Enumeration<String>	getHeaderNames()
Enumeration<String>	getHeaders(String s)
ServletInputStream	getInputStream()
int	getIntHeader(String s)
String	getLocalAddr()
Locale	getLocale()
Enumeration<Locale>	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String name)
Map	getParameterMap()
Enumeration	getParameterNames() Fetches the names of all non-file parameters in the request.
String[]	getParameterValues(String name) Fetches all values of a specific parameter in the request.
Part	getPart(String s)
Collection<Part>	getParts()
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String s) Deprecated.
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String s)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
MutableServletContext	getServletContext()
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isAsyncStarted()
boolean	isAsyncSupported()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl() Deprecated.
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String s)
void	login(String s, String s1)
void	logout()
void	makeMultipart()
void	removeAttribute(String s)
void	setAttribute(String s, Object o)
void	setCharacterEncoding(String s)
void	setContentType(String contentType)
void	setContextPath(String context)
void	setFileItem(String key, org.apache.commons.fileupload.FileItem value)
void	setMethod(String method)
void	setParameter(String key, String... values)
void	setRequestURI(String requestURI)
void	setScheme(String scheme)
void	setServerName(String serverName)
void	setServerPort(int serverPort)
void	setServletPath(String servletPath)
AsyncContext	startAsync()
AsyncContext	startAsync(ServletRequest request, ServletResponse response)
<T extends HttpUpgradeHandler> T	upgrade(Class<T> httpUpgradeHandlerClass)
HttpServletRequestWrapper	wrapRequest(HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.http.HttpServletRequest

getHttpServletMapping, getTrailerFields, isTrailerFieldsReady, newPushBuilder

Field Detail

copyright

public static final String copyright

See Also:

Constant Field Values

attributeMap

public final Map<String,Object> attributeMap

parameterMap

public final Map<String,String[]> parameterMap

headerMap

public final Map<String,String[]> headerMap

fileItemMap

public final Map<String,org.apache.commons.fileupload.FileItem> fileItemMap

locales

public final List<Locale> locales

Constructor Detail

MutableHttpServletRequest

public MutableHttpServletRequest()

MutableHttpServletRequest

public MutableHttpServletRequest(MutableServletContext servletContext)

Method Detail

addParameter

public void addParameter(String name,
                         String value)

setParameter

public void setParameter(String key,
                         String... values)

addFileItem

public boolean addFileItem(String name,
                           org.apache.commons.fileupload.FileItem item)

getFileItem

public org.apache.commons.fileupload.FileItem getFileItem(String name)

setFileItem

public void setFileItem(String key,
                        org.apache.commons.fileupload.FileItem value)

setMethod

public void setMethod(String method)

setContextPath

public void setContextPath(String context)

setServletPath

public void setServletPath(String servletPath)

makeMultipart

public void makeMultipart()

setScheme

public void setScheme(String scheme)

setServerName

public void setServerName(String serverName)

setServerPort

public void setServerPort(int serverPort)

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

build

public void build(HttpServletRequest request,
                  File tempDir,
                  long maxPostSize)

Description copied from interface: MultipartWrapper

Pseudo-constructor that allows the class to perform any initialization necessary.

Specified by:

build in interface MultipartWrapper

Parameters:

request - an HttpServletRequest that has a content-type of multipart.

tempDir - a File representing the temporary directory that can be used to store file parts as they are uploaded if this is desirable

maxPostSize - the size in bytes beyond which the request should not be read, and a FileUploadLimitExceeded exception should be thrown

getParameterNames

public Enumeration getParameterNames()

Description copied from interface: MultipartWrapper

Fetches the names of all non-file parameters in the request. Directly analogous to the method of the same name in HttpServletRequest when the request is non-multipart.

Specified by:

getParameterNames in interface MultipartWrapper

Specified by:

getParameterNames in interface ServletRequest

Returns:

an Enumeration of all non-file parameter names in the request

getParameterValues

public String[] getParameterValues(String name)

Description copied from interface: MultipartWrapper

Fetches all values of a specific parameter in the request. To simulate the HTTP request style, the array should be null for non-present parameters, and values in the array should never be null - the empty String should be used when there is value.

Specified by:

getParameterValues in interface MultipartWrapper

Specified by:

getParameterValues in interface ServletRequest

Parameters:

name - the name of the request parameter

Returns:

an array of non-null parameters or null

getFileParameterNames

public Enumeration<String> getFileParameterNames()

Description copied from interface: MultipartWrapper

Fetches the names of all file parameters in the request. Note that these are not the file names, but the names given to the form fields in which the files are specified.

Specified by:

getFileParameterNames in interface MultipartWrapper

Returns:

the names of all file parameters in the request.

getFileParameterValue

public FileBean getFileParameterValue(String name)

Description copied from interface: MultipartWrapper

Responsible for constructing a FileBean object for the named file parameter. If there is no file parameter with the specified name this method should return null.

Specified by:

getFileParameterValue in interface MultipartWrapper

Parameters:

name - the name of the file parameter

Returns:

a FileBean object wrapping the uploaded file

wrapRequest

public HttpServletRequestWrapper wrapRequest(HttpServletRequest request)

Specified by:

wrapRequest in interface MultipartWrapper

getParameterMap

public Map getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getAttribute

public Object getAttribute(String s)

Specified by:

getAttribute in interface ServletRequest

setAttribute

public void setAttribute(String s,
                         Object o)

Specified by:

setAttribute in interface ServletRequest

removeAttribute

public void removeAttribute(String s)

Specified by:

removeAttribute in interface ServletRequest

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(String s)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

public String getHeader(String s)

Specified by:

getHeader in interface HttpServletRequest

getHeaders

public Enumeration<String> getHeaders(String s)

Specified by:

getHeaders in interface HttpServletRequest

getHeaderNames

public Enumeration<String> getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getIntHeader

public int getIntHeader(String s)

Specified by:

getIntHeader in interface HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(String s)

Specified by:

isUserInRole in interface HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

setRequestURI

public void setRequestURI(String requestURI)

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

changeSessionId

public String changeSessionId()

Specified by:

changeSessionId in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdFromUrl

@Deprecated
public boolean isRequestedSessionIdFromUrl()

Deprecated.

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

getAttributeNames

public Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String s)

Specified by:

setCharacterEncoding in interface ServletRequest

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getContentLengthLong

public long getContentLengthLong()

Specified by:

getContentLengthLong in interface ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

setContentType

public void setContentType(String contentType)

getInputStream

public ServletInputStream getInputStream()
                                  throws IOException

Specified by:

getInputStream in interface ServletRequest

Throws:

IOException

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

getReader

public BufferedReader getReader()
                         throws IOException

Specified by:

getReader in interface ServletRequest

Throws:

IOException

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

getLocales

public Enumeration<Locale> getLocales()

Specified by:

getLocales in interface ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String s)

Specified by:

getRequestDispatcher in interface ServletRequest

getRealPath

@Deprecated
public String getRealPath(String s)

Deprecated.

Specified by:

getRealPath in interface ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

authenticate

public boolean authenticate(HttpServletResponse response)
                     throws IOException,
                            ServletException

Specified by:

authenticate in interface HttpServletRequest

Throws:

IOException

ServletException

login

public void login(String s,
                  String s1)
           throws ServletException

Specified by:

login in interface HttpServletRequest

Throws:

ServletException

logout

public void logout()
            throws ServletException

Specified by:

logout in interface HttpServletRequest

Throws:

ServletException

getParts

public Collection<Part> getParts()
                          throws IOException,
                                 ServletException

Specified by:

getParts in interface HttpServletRequest

Throws:

IOException

ServletException

getPart

public Part getPart(String s)
             throws IOException,
                    ServletException

Specified by:

getPart in interface HttpServletRequest

Throws:

IOException

ServletException

getServletContext

public MutableServletContext getServletContext()

Specified by:

getServletContext in interface ServletRequest

startAsync

public AsyncContext startAsync()
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

startAsync

public AsyncContext startAsync(ServletRequest request,
                               ServletResponse response)
                        throws IllegalStateException

Specified by:

startAsync in interface ServletRequest

Throws:

IllegalStateException

isAsyncStarted

public boolean isAsyncStarted()

Specified by:

isAsyncStarted in interface ServletRequest

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface ServletRequest

getAsyncContext

public AsyncContext getAsyncContext()

Specified by:

getAsyncContext in interface ServletRequest

getDispatcherType

public DispatcherType getDispatcherType()

Specified by:

getDispatcherType in interface ServletRequest

upgrade

public <T extends HttpUpgradeHandler> T upgrade(Class<T> httpUpgradeHandlerClass)
                                         throws IOException,
                                                ServletException

Specified by:

upgrade in interface HttpServletRequest

Throws:

IOException

ServletException