com.aspectran.web.adapter

Class HttpServletRequestAdapter

java.lang.Object

com.aspectran.core.activity.request.AbstractAdaptiveRequest

com.aspectran.core.adapter.AbstractRequestAdapter

com.aspectran.web.adapter.HttpServletRequestAdapter

All Implemented Interfaces:

RequestAdapter

public class HttpServletRequestAdapter
extends AbstractRequestAdapter

The Class HttpServletRequestAdapter.

Since:

2011. 3. 13.

Field Summary

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

adaptee

Constructor Summary

Constructors

Constructor and Description
HttpServletRequestAdapter(javax.servlet.http.HttpServletRequest request) Instantiates a new HttpServletRequestAdapter.

Method Summary

Modifier and Type	Method and Description
<T> T	getAttribute(String name) Returns the value of the named attribute as a given type, or null if no attribute of the given name exists.
Enumeration<String>	getAttributeNames() Returns an Enumeration containing the names of the attributes available to this request.
String	getCharacterEncoding() Returns the name of the character encoding used in the body of this request.
Locale	getLocale() Returns the preferred Locale.
void	removeAttribute(String name) Removes an attribute from this request.
void	setAttribute(String name, Object o) Stores an attribute in this request.
void	setCharacterEncoding(String characterEncoding) Overrides the name of the character encoding used in the body of this request.
protected MultiValueMap<String,String>	touchHeaders() Returns a map of the request headers that can be modified.

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

getAdaptee, getRequestScope, getRequestScope, setRequestScope

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

addHeader, containsHeader, fillAttributeMap, fillPrameterMap, getAttributeMap, getFileParameter, getFileParameterNames, getFileParameterValues, getHeader, getHeaderNames, getHeaders, getHeaders, getParameter, getParameterMap, getParameterNames, getParameterValues, getRequestMethod, getTimeZone, isHeadersInstantiated, isMaxLengthExceeded, removeFileParameter, setFileParameter, setFileParameter, setHeader, setLocale, setMaxLengthExceeded, setParameter, setParameter, setRequestMethod, 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, fillAttributeMap, fillPrameterMap, getAttributeMap, getFileParameter, getFileParameterNames, getFileParameterValues, getHeader, getHeaderNames, getHeaders, getHeaders, getParameter, getParameterMap, getParameterNames, getParameterValues, getRequestMethod, getTimeZone, isMaxLengthExceeded, removeFileParameter, setFileParameter, setFileParameter, setHeader, setLocale, setMaxLengthExceeded, setParameter, setParameter, setTimeZone

Constructor Detail

HttpServletRequestAdapter

public HttpServletRequestAdapter(javax.servlet.http.HttpServletRequest request)

Instantiates a new HttpServletRequestAdapter.

Parameters:

request - the HTTP request

Method Detail

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: RequestAdapter

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

Returns:

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

setCharacterEncoding

public void setCharacterEncoding(String characterEncoding)
                          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.

Parameters:

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

Throws:

UnsupportedEncodingException - if the specified encoding is invalid

touchHeaders

protected MultiValueMap<String,String> touchHeaders()

Description copied from class: AbstractAdaptiveRequest

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

Overrides:

touchHeaders in class AbstractAdaptiveRequest

Returns:

an MultiValueMap object, may not be null

getAttribute

public <T> T getAttribute(String name)

Description copied from interface: RequestAdapter

Returns the value of the named attribute as a given type, or null if no attribute of the given name exists.

Specified by:

getAttribute in interface RequestAdapter

Specified by:

getAttribute in class AbstractAdaptiveRequest

Type Parameters:

T - the generic type

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if the attribute does not exist

setAttribute

public void setAttribute(String name,
                         Object o)

Description copied from interface: RequestAdapter

Stores an attribute in this request.

Specified by:

setAttribute in interface RequestAdapter

Specified by:

setAttribute in class AbstractAdaptiveRequest

Parameters:

name - specifying the name of the attribute

o - the Object to be stored

getAttributeNames

public Enumeration<String> getAttributeNames()

Description copied from interface: RequestAdapter

Returns an Enumeration containing the names of the attributes available to this request. This method returns an empty Enumeration if the request has no attributes available to it.

Specified by:

getAttributeNames in interface RequestAdapter

Specified by:

getAttributeNames in class AbstractAdaptiveRequest

Returns:

the attribute names

removeAttribute

public void removeAttribute(String name)

Description copied from interface: RequestAdapter

Removes an attribute from this request.

Parameters:

name - a String specifying the name of the attribute to remove

getLocale

public Locale getLocale()

Description copied from interface: RequestAdapter

Returns the preferred Locale.

Specified by:

getLocale in interface RequestAdapter

Overrides:

getLocale in class AbstractAdaptiveRequest

Returns:

a preferred Locale