Package com.aspectran.core.adapter

Interface RequestAdapter

All Known Implementing Classes:

AbstractRequestAdapter, BasicRequestAdapter, QuartzJobRequestAdapter

public interface RequestAdapter

The Interface RequestAdapter.

Since:

2011. 3. 13.

Method Summary

Modifier and Type	Method	Description
void	addHeader(java.lang.String name, java.lang.String value)	Add the given single header value to the current list of values for the given header.
boolean	containsHeader(java.lang.String name)	Returns a boolean indicating whether the named response header has already been set.
java.util.Map<java.lang.String,java.lang.Object>	copyAllParameters()	Returns the parameter copied to the new instance.
void	fillAllAttributes(java.util.Map<java.lang.String,java.lang.Object> targetAttributes)	Fills all attributes to the specified map.
void	fillAllParameters(java.util.Map<java.lang.String,java.lang.Object> targetParameters)	Fills all parameters to the specified map.
<T> T	getAdaptee()	Returns the adaptee object to provide request information.
java.util.Map<java.lang.String,java.lang.Object>	getAllAttributes()	Returns an immutable map of the attributes, with attribute names as map keys and attribute value as map value.
MultiValueMap<java.lang.String,java.lang.String>	getAllHeaders()	Returns a map of the request headers that can be modified.
java.util.Map<java.lang.String,java.lang.Object>	getAllParameters()	Return an immutable Map of the request parameters, with parameter names as map keys and parameter values as map values.
<T> T	getAttribute(java.lang.String name)	Returns the value of the named attribute as a given type, or null if no attribute of the given name exists.
java.util.Enumeration<java.lang.String>	getAttributeNames()	Returns an Enumeration containing the names of the attributes available to this request.
java.lang.String	getEncoding()	Returns the name of the character encoding used in the body of this request.
FileParameter	getFileParameter(java.lang.String name)	Returns a FileParameter object as a given request parameter name, or null if the file parameter does not exist.
java.util.Enumeration<java.lang.String>	getFileParameterNames()	Returns an Enumeration of String objects containing the names of the file parameters contained in this request.
FileParameter[]	getFileParameterValues(java.lang.String name)	Returns an array of FileParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.
java.lang.String	getHeader(java.lang.String name)	Returns the value of the response header with the given name.
java.util.Collection<java.lang.String>	getHeaderNames()	Returns the names of the headers of this response.
java.util.Collection<java.lang.String>	getHeaders(java.lang.String name)	Returns the values of the response header with the given name.
java.util.Locale	getLocale()	Returns the preferred Locale.
java.lang.String	getParameter(java.lang.String name)	Returns the value of a request parameter as a String, or null if the parameter does not exist.
java.util.Enumeration<java.lang.String>	getParameterNames()	Returns an Enumeration of String objects containing the names of the parameters contained in this request.
java.lang.String[]	getParameterValues(java.lang.String name)	Returns an array of String objects containing all of the values the given activity's request parameter has, or null if the parameter does not exist.
MethodType	getRequestMethod()	Returns the method used for the request.
RequestScope	getRequestScope()	Gets the request scope.
RequestScope	getRequestScope(boolean create)	Gets the request scope.
java.util.TimeZone	getTimeZone()	Returns the preferred TimeZone.
boolean	isMaxLengthExceeded()	Returns whether request header has exceed the maximum length.
void	putAllAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)	Copies all of the mappings from the specified attributes.
void	removeAttribute(java.lang.String name)	Removes an attribute from this request.
void	removeFileParameter(java.lang.String name)	Removes the file parameter with the specified name.
void	setAttribute(java.lang.String name, java.lang.Object value)	Stores an attribute in this request.
void	setEncoding(java.lang.String encoding)	Overrides the name of the character encoding used in the body of this request.
void	setFileParameter(java.lang.String name, FileParameter fileParameter)	Sets the FileParameter object to the file parameter with the given name.
void	setFileParameter(java.lang.String name, FileParameter[] fileParameters)	Sets the value to the file parameter with the given name.
void	setHeader(java.lang.String name, java.lang.String value)	Set the given single header value under the given header name.
void	setLocale(java.util.Locale locale)	Sets the preferred Locale.
void	setMaxLengthExceeded(boolean maxLengthExceeded)	Sets whether request header has exceed the maximum length.
void	setParameter(java.lang.String name, java.lang.String value)	Sets the value to the parameter with the given name.
void	setParameter(java.lang.String name, java.lang.String[] values)	Sets the value to the parameter with the given name.
void	setTimeZone(java.util.TimeZone timeZone)	Sets the preferred TimeZone.

Method Detail

getAdaptee

<T> T getAdaptee()

Returns the adaptee object to provide request information.

Type Parameters:

T - the type of the adaptee object

Returns:

the adaptee object

getRequestScope

RequestScope getRequestScope()

Gets the request scope.

Returns:

the request scope

getRequestScope

RequestScope getRequestScope(boolean create)

Gets the request scope.

Parameters:

create - true to create a new request scope for this request if necessary; false to return null

Returns:

the request scope

getEncoding

java.lang.String getEncoding()

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

setEncoding

void setEncoding(java.lang.String encoding)
          throws java.io.UnsupportedEncodingException

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:

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

Throws:

java.io.UnsupportedEncodingException - if the specified encoding is invalid

getRequestMethod

MethodType getRequestMethod()

Returns the method used for the request.

Returns:

a MethodType object

getAllHeaders

MultiValueMap<java.lang.String,java.lang.String> getAllHeaders()

Returns a map of the request headers that can be modified.

Returns:

an MultiValueMap object, may be null

getHeader

java.lang.String getHeader(java.lang.String name)

Returns the value of the response header with the given name.

If a response header with the given name exists and contains multiple values, the value that was added first will be returned.

Parameters:

name - the name of the response header whose value to return

Returns:

the value of the response header with the given name, or null if no header with the given name has been set on this response

getHeaders

java.util.Collection<java.lang.String> getHeaders(java.lang.String name)

Returns the values of the response header with the given name.

Parameters:

name - the name of the response header whose values to return

Returns:

a (possibly empty) Collection of the values of the response header with the given name

getHeaderNames

java.util.Collection<java.lang.String> getHeaderNames()

Returns the names of the headers of this response.

Returns:

a (possibly empty) Collection of the names of the headers of this response

containsHeader

boolean containsHeader(java.lang.String name)

Returns a boolean indicating whether the named response header has already been set.

Parameters:

name - the header name

Returns:

true if the named response header has already been set; false otherwise

setHeader

void setHeader(java.lang.String name,
               java.lang.String value)

Set the given single header value under the given header name.

Parameters:

name - the header name

value - the header value to set

addHeader

void addHeader(java.lang.String name,
               java.lang.String value)

Add the given single header value to the current list of values for the given header.

Parameters:

name - the header name

value - the header value to be added

getParameter

java.lang.String getParameter(java.lang.String name)

Returns the value of a request parameter as a String, or null if the parameter does not exist.

Parameters:

name - a String specifying the name of the parameter

Returns:

a String representing the single value of the parameter

See Also:

getParameterValues(java.lang.String)

getParameterValues

java.lang.String[] getParameterValues(java.lang.String name)

Returns an array of String objects containing all of the values the given activity's request parameter has, or null if the parameter does not exist.

Parameters:

name - a String specifying the name of the parameter

Returns:

an array of String objects containing the parameter's values

See Also:

getParameter(java.lang.String)

getParameterNames

java.util.Enumeration<java.lang.String> getParameterNames()

Returns an Enumeration of String objects containing the names of the parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Returns:

an Enumeration of String objects, each String containing the name of a request parameter; or an empty Enumeration if the request has no parameters

setParameter

void setParameter(java.lang.String name,
                  java.lang.String value)

Sets the value to the parameter with the given name.

Parameters:

name - a String specifying the name of the parameter

value - a String representing the single value of the parameter

See Also:

setParameter(String, String[])

setParameter

void setParameter(java.lang.String name,
                  java.lang.String[] values)

Sets the value to the parameter with the given name.

Parameters:

name - a String specifying the name of the parameter

values - an array of String objects containing the parameter's values

See Also:

setParameter(java.lang.String, java.lang.String)

getAllParameters

java.util.Map<java.lang.String,java.lang.Object> getAllParameters()

Return an immutable Map of the request parameters, with parameter names as map keys and parameter values as map values. If the parameter value type is the String then map value will be of type String. If the parameter value type is the String array then map value will be of type String array.

Returns:

the immutable parameter map

Since:

1.4.0

copyAllParameters

java.util.Map<java.lang.String,java.lang.Object> copyAllParameters()

Returns the parameter copied to the new instance.

Returns:

the mutable parameter map

fillAllParameters

void fillAllParameters(java.util.Map<java.lang.String,java.lang.Object> targetParameters)

Fills all parameters to the specified map.

Parameters:

targetParameters - the target parameter map to be filled

Since:

2.0.0

getFileParameter

FileParameter getFileParameter(java.lang.String name)

Returns a FileParameter object as a given request parameter name, or null if the file parameter does not exist.

Parameters:

name - a String specifying the name of the file parameter

Returns:

a FileParameter representing the single value of the parameter

See Also:

getFileParameterValues(java.lang.String)

getFileParameterValues

FileParameter[] getFileParameterValues(java.lang.String name)

Returns an array of FileParameter objects containing all of the values the given request parameter has, or null if the parameter does not exist.

Parameters:

name - a String specifying the name of the file parameter

Returns:

an array of FileParameter objects containing the parameter's values

See Also:

getFileParameter(java.lang.String)

getFileParameterNames

java.util.Enumeration<java.lang.String> getFileParameterNames()

Returns an Enumeration of String objects containing the names of the file parameters contained in this request. If the request has no parameters, the method returns an empty Enumeration.

Returns:

an Enumeration of String objects, each String containing the name of a file parameter; or an empty Enumeration if the request has no file parameters

setFileParameter

void setFileParameter(java.lang.String name,
                      FileParameter fileParameter)

Sets the FileParameter object to the file parameter with the given name.

Parameters:

name - a String specifying the name of the file parameter

fileParameter - a FileParameter representing the single value of the parameter

See Also:

setFileParameter(String, FileParameter[])

setFileParameter

void setFileParameter(java.lang.String name,
                      FileParameter[] fileParameters)

Sets the value to the file parameter with the given name.

Parameters:

name - a String specifying the name of the file parameter

fileParameters - an array of FileParameter objects containing the file parameter's values

See Also:

setFileParameter(java.lang.String, com.aspectran.core.activity.request.parameter.FileParameter)

removeFileParameter

void removeFileParameter(java.lang.String name)

Removes the file parameter with the specified name.

Parameters:

name - a String specifying the name of the file parameter

getAttribute

<T> T getAttribute(java.lang.String name)

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

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

void setAttribute(java.lang.String name,
                  java.lang.Object value)

Stores an attribute in this request.

Parameters:

name - specifying the name of the attribute

value - the Object to be stored

getAttributeNames

java.util.Enumeration<java.lang.String> getAttributeNames()

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.

Returns:

the attribute names

removeAttribute

void removeAttribute(java.lang.String name)

Removes an attribute from this request.

Parameters:

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

getAllAttributes

java.util.Map<java.lang.String,java.lang.Object> getAllAttributes()

Returns an immutable map of the attributes, with attribute names as map keys and attribute value as map value.

Returns:

an unmodifiable map of the attributes

putAllAttributes

void putAllAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)

Copies all of the mappings from the specified attributes.

Parameters:

attributes - the specified attributes

fillAllAttributes

void fillAllAttributes(java.util.Map<java.lang.String,java.lang.Object> targetAttributes)

Fills all attributes to the specified map.

Parameters:

targetAttributes - the target attribute map to be filled

Since:

2.0.0

isMaxLengthExceeded

boolean isMaxLengthExceeded()

Returns whether request header has exceed the maximum length.

Returns:

true, if max length exceeded

setMaxLengthExceeded

void setMaxLengthExceeded(boolean maxLengthExceeded)

Sets whether request header has exceed the maximum length.

Parameters:

maxLengthExceeded - whether the max length exceeded

getLocale

java.util.Locale getLocale()

Returns the preferred Locale.

Returns:

a preferred Locale

setLocale

void setLocale(java.util.Locale locale)

Sets the preferred Locale.

Parameters:

locale - a given Locale

getTimeZone

java.util.TimeZone getTimeZone()

Returns the preferred TimeZone.

Returns:

a preferred TimeZone

setTimeZone

void setTimeZone(java.util.TimeZone timeZone)

Sets the preferred TimeZone.

Parameters:

timeZone - a given TimeZone