Package com.aspectran.core.activity.request

Class AbstractRequest

java.lang.Object

com.aspectran.core.activity.request.AbstractRequest

Direct Known Subclasses:

AbstractRequestAdapter

public abstract class AbstractRequest
extends java.lang.Object

The Class AbstractRequest.

Since:

2011. 3. 12.

Field Summary

Fields

Modifier and Type	Field	Description
protected Locker	locker

Constructor Summary

Constructors

Constructor	Description
AbstractRequest()
AbstractRequest(java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

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()
abstract void	fillAllAttributes(java.util.Map<java.lang.String,java.lang.Object> targetAttributes)
void	fillAllParameters(java.util.Map<java.lang.String,java.lang.Object> targetParameters)
abstract java.util.Map<java.lang.String,java.lang.Object>	getAllAttributes()	Returns an unmodifiable map of the attributes.
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()
abstract <T> T	getAttribute(java.lang.String name)
abstract java.util.Enumeration<java.lang.String>	getAttributeNames()
FileParameter	getFileParameter(java.lang.String name)
java.util.Enumeration<java.lang.String>	getFileParameterNames()
FileParameter[]	getFileParameterValues(java.lang.String name)
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()
java.lang.String	getParameter(java.lang.String name)
java.util.Enumeration<java.lang.String>	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
MethodType	getRequestMethod()
java.util.TimeZone	getTimeZone()	Gets the time zone.
protected boolean	isHeadersInstantiated()
boolean	isMaxLengthExceeded()	Returns whether request header has exceed the maximum length.
abstract void	putAllAttributes(java.util.Map<java.lang.String,java.lang.Object> attributes)	Copies all of the mappings from the specified attributes.
abstract void	removeAttribute(java.lang.String name)
void	removeFileParameter(java.lang.String name)
abstract void	setAttribute(java.lang.String name, java.lang.Object value)
void	setFileParameter(java.lang.String name, FileParameter fileParameter)
void	setFileParameter(java.lang.String name, FileParameter[] fileParameters)
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 locale.
void	setMaxLengthExceeded(boolean maxLengthExceeded)	Sets whether the request header has exceeded the maximum length.
void	setParameter(java.lang.String name, java.lang.String value)
void	setParameter(java.lang.String name, java.lang.String[] values)
protected void	setRequestMethod(MethodType requestMethod)
void	setTimeZone(java.util.TimeZone timeZone)	Sets the time zone.
protected MultiValueMap<java.lang.String,java.lang.String>	touchHeaders()	Returns a map of the request headers that can be modified.

Methods inherited from class java.lang.Object

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

Field Detail

locker

protected Locker locker

Constructor Detail

AbstractRequest

public AbstractRequest()

AbstractRequest

public AbstractRequest(java.util.Map<java.lang.String,java.lang.String[]> parameterMap)

Method Detail

getRequestMethod

public MethodType getRequestMethod()

setRequestMethod

protected void setRequestMethod(MethodType requestMethod)

getHeader

public 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

public 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

public 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

public 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

public 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

public 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

getAllHeaders

public 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

touchHeaders

protected MultiValueMap<java.lang.String,java.lang.String> touchHeaders()

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

Returns:

an MultiValueMap object, may not be null

isHeadersInstantiated

protected boolean isHeadersInstantiated()

getParameter

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

getParameterValues

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

getParameterNames

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

setParameter

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

setParameter

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

getAllParameters

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

copyAllParameters

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

fillAllParameters

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

getFileParameter

public FileParameter getFileParameter(java.lang.String name)

getFileParameterValues

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

removeFileParameter

public void removeFileParameter(java.lang.String name)

setFileParameter

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

setFileParameter

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

getFileParameterNames

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

getAttribute

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

getAttributeNames

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

setAttribute

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

removeAttribute

public abstract void removeAttribute(java.lang.String name)

getAllAttributes

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

Returns an unmodifiable map of the attributes.

Returns:

an unmodifiable map of the attributes

putAllAttributes

public abstract 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

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

setMaxLengthExceeded

public void setMaxLengthExceeded(boolean maxLengthExceeded)

Sets whether the request header has exceeded the maximum length.

Parameters:

maxLengthExceeded - whether the request header has exceeded the maximum length

isMaxLengthExceeded

public boolean isMaxLengthExceeded()

Returns whether request header has exceed the maximum length.

Returns:

true, if is max length exceeded

getLocale

public java.util.Locale getLocale()

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale.

Parameters:

locale - the locale

getTimeZone

public java.util.TimeZone getTimeZone()

Gets the time zone.

Returns:

the time zone

setTimeZone

public void setTimeZone(java.util.TimeZone timeZone)

Sets the time zone.

Parameters:

timeZone - the time zone