Package com.aspectran.web.adapter

Class HttpServletRequestAdapter

java.lang.Object

com.aspectran.core.activity.request.AbstractRequest

com.aspectran.core.adapter.AbstractRequestAdapter

com.aspectran.web.adapter.HttpServletRequestAdapter

All Implemented Interfaces:

RequestAdapter

public class HttpServletRequestAdapter
extends AbstractRequestAdapter

Adapt HttpServletRequest to Core RequestAdapter.

Since:

2011. 3. 13.

Field Summary

Fields inherited from class com.aspectran.core.adapter.AbstractRequestAdapter

adaptee

Constructor Summary

Constructors

Constructor	Description
HttpServletRequestAdapter(MethodType requestMethod, jakarta.servlet.http.HttpServletRequest request)	Instantiates a new HttpServletRequestAdapter.

Method Summary

Modifier and Type	Method	Description
String	getBody()
<T extends Parameters> T	getBodyAsParameters(Class<T> requiredType)
String	getEncoding()	Returns the name of the character encoding used in the body of this request.
MultiValueMap<String,String>	getHeaderMap()	Returns a map of the request headers that can be modified.
InputStream	getInputStream()
MediaType	getMediaType()	Gets the media type value included in the Content-Type header.
void	preparse()
void	preparse(HttpServletRequestAdapter requestAdapter)
void	setEncoding(String encoding)	Overrides the name of the character encoding used in the body of this request.

Methods inherited from class com.aspectran.core.adapter.AbstractRequestAdapter

getAdaptee, getRequestScope, getRequestScope

Methods inherited from class com.aspectran.core.activity.request.AbstractRequest

addHeader, containsHeader, extractAttributes, extractParameters, getAllParameters, getAttribute, getAttributeMap, getAttributeNames, getBodyAsParameters, getFileParameter, getFileParameterMap, getFileParameterNames, getFileParameterValues, getHeader, getHeaderNames, getHeaderValues, getLocale, getMaxRequestSize, getParameter, getParameterMap, getParameterNames, getParameters, getParameters, getParameterValues, getRequestMethod, getTimeZone, hasAttributes, hasFileParameters, hasHeaders, hasParameters, putAllAttributes, putAllFileParameters, putAllParameters, putAllParameters, removeAttribute, removeFileParameter, setAttribute, setAttributeMap, setBody, setFileParameter, setFileParameter, setHeader, setHeaderMap, setLocale, setMaxRequestSize, setParameter, setParameter, setParameterMap, setTimeZone

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspectran.core.adapter.RequestAdapter

addHeader, containsHeader, extractAttributes, extractParameters, getAllParameters, getAttribute, getAttributeMap, getAttributeNames, getBodyAsParameters, getFileParameter, getFileParameterNames, getFileParameterValues, getHeader, getHeaderNames, getHeaderValues, getLocale, getMaxRequestSize, getParameter, getParameterMap, getParameterNames, getParameters, getParameters, getParameterValues, getRequestMethod, getTimeZone, hasAttributes, hasFileParameters, hasHeaders, hasParameters, putAllAttributes, putAllFileParameters, putAllParameters, putAllParameters, removeAttribute, removeFileParameter, setAttribute, setBody, setFileParameter, setFileParameter, setHeader, setLocale, setMaxRequestSize, setParameter, setParameter, setTimeZone

Constructor Details

HttpServletRequestAdapter

public HttpServletRequestAdapter(MethodType requestMethod,
 jakarta.servlet.http.HttpServletRequest request)

Instantiates a new HttpServletRequestAdapter.

Parameters:

requestMethod - the request method

request - the activity request wrapper

Method Details

getHeaderMap

public MultiValueMap<String,String> getHeaderMap()

Description copied from class: AbstractRequest

Returns a map of the request headers that can be modified. If not yet instantiated then create a new one.

Specified by:

getHeaderMap in interface RequestAdapter

Overrides:

getHeaderMap in class AbstractRequest

Returns:

an MultiValueMap object, may not be null

getEncoding

public String getEncoding()

Description copied from interface: RequestAdapter

Returns the name of the character encoding used in the body of this request.

Specified by:

getEncoding in interface RequestAdapter

Overrides:

getEncoding in class AbstractRequest

Returns:

a String containing the name of the character encoding, or null if the request does not specify a character encoding

setEncoding

public void setEncoding(String encoding)
                 throws UnsupportedEncodingException

Description copied from interface: RequestAdapter

Overrides the name of the character encoding used in the body of this request. This method must be called prior to reading request parameters or reading input using getReader(). Otherwise, it has no effect.

Specified by:

setEncoding in interface RequestAdapter

Overrides:

setEncoding in class AbstractRequest

Parameters:

encoding - a String containing the name of the character encoding.

Throws:

UnsupportedEncodingException - if the specified encoding is invalid

getInputStream

public InputStream getInputStream()
                           throws IOException

Specified by:

getInputStream in interface RequestAdapter

Overrides:

getInputStream in class AbstractRequest

Throws:

IOException

getBody

public String getBody()

Specified by:

getBody in interface RequestAdapter

Overrides:

getBody in class AbstractRequest

getBodyAsParameters

public <T extends Parameters> T getBodyAsParameters(Class<T> requiredType)
                                             throws RequestParseException

Specified by:

getBodyAsParameters in interface RequestAdapter

Overrides:

getBodyAsParameters in class AbstractRequest

Throws:

RequestParseException

getMediaType

public MediaType getMediaType()

Gets the media type value included in the Content-Type header.

preparse

public void preparse()

preparse

public void preparse(HttpServletRequestAdapter requestAdapter)