Package com.aspectran.core.activity.response

Class AbstractResponse

java.lang.Object

com.aspectran.core.activity.response.AbstractResponse

Direct Known Subclasses:

AbstractResponseAdapter

public abstract class AbstractResponse
extends java.lang.Object

Represents response headers, mapping string header names to a list of string values.

This class is generally not thread-safe. It is primarily designed for use in a single thread only.

Since:

3.0.0

Constructor Summary

Constructors

Constructor	Description
AbstractResponse()

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.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.
MultiValueMap<java.lang.String,java.lang.String>	getHeaders()	Returns a map of the request headers that can be modified.
java.util.Collection<java.lang.String>	getHeaders(java.lang.String name)	Returns the values of the response header with the given name.
int	getStatus()	Returns the status code.
void	setHeader(java.lang.String name, java.lang.String value)	Set the given single header value under the given header name.
void	setStatus(int status)	Sets the status code.
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

Constructor Detail

AbstractResponse

public AbstractResponse()

Method Detail

touchHeaders

public 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

getHeaders

public MultiValueMap<java.lang.String,java.lang.String> getHeaders()

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

Returns:

an MultiValueMap object, may be null

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

getStatus

public int getStatus()

Returns the status code.

Returns:

the status

setStatus

public void setStatus(int status)

Sets the status code.

Parameters:

status - the status code