com.hcl.voltmx.middleware.controller

Interface DataControllerResponse

public interface DataControllerResponse

An abstraction over actual response that will be sent to client.

See Also:

DataControllerRequest

Method Summary

Modifier and Type	Method and Description
DataControllerResponse	clone() Creates a copy (clone) of this response.
<T> T	getAttribute(String name) Gets an attribute value, an Object previously stored in the scope of this response.
Iterator<String>	getAttributeNames() Gets name of all the attributes stored in the scope of this response.
String	getCharsetEncoding() Gets the character encoding of the response.
List<org.apache.http.cookie.Cookie>	getCookies() Gets the list of response cookies.
List<org.apache.http.cookie.Cookie>	getDeviceCookies() Gets the list of response cookies that will be sent to the client (device).
Map<String,String>	getDeviceHeaders() Gets map of all headers that will be sent to client (device).
Map<String,String>	getHeaders() Gets the map of all headers from the response.
String	getLocation() Gets the redirected location URL if the response was a 302 redirect.
String	getResponse() Gets the response content.
int	getStatusCode() Gets the (HTTP) status code of the back-end service call.
<T> void	setAttribute(String name, T value) Sets an attribute value, an Object storied in the scope of this response.
void	setCharsetEncoding(String encoding) Sets the character encoding of the response.
void	setCookies(List<org.apache.http.cookie.Cookie> cookies) Sets the list of response cookies.
void	setDeviceCookies(List<org.apache.http.cookie.Cookie> cookies) Sets list of response cookies sent to the client (device).
void	setDeviceHeaders(Map<String,String> header) Sets map of all headers that will be sent to client (device).
void	setHeaders(Map<String,String> header) Sets the map of all headers in the response.
void	setLocation(String location) Sets the redirected location URL when there is 302 redirect.
void	setResponse(String response) Sets the content of this response.
void	setStatusCode(int statusCode) Sets the (HTTP) status code of the back-end service call.

Method Detail

setAttribute

<T> void setAttribute(String name,
                      T value)

Sets an attribute value, an Object storied in the scope of this response.

Parameters:

name - The attribute name

value - The attribute value

getAttribute

<T> T getAttribute(String name)

Gets an attribute value, an Object previously stored in the scope of this response.

Parameters:

name - The attribute name

Returns:

The attribute value

getAttributeNames

Iterator<String> getAttributeNames()

Gets name of all the attributes stored in the scope of this response.

Returns:

Name of all attributes

setResponse

void setResponse(String response)

Sets the content of this response. This method will trim the leading and trailing spaces.

Parameters:

response - The response content to set

getResponse

String getResponse()

Gets the response content.

Returns:

The response content or null if no content

setCharsetEncoding

void setCharsetEncoding(String encoding)

Sets the character encoding of the response. By default, the encoding is set to UTF-8.

Parameters:

encoding - The character encoding to set

getCharsetEncoding

String getCharsetEncoding()

Gets the character encoding of the response. By default, the encoding is set to UTF-8.

Returns:

The character encoding

setStatusCode

void setStatusCode(int statusCode)

Sets the (HTTP) status code of the back-end service call.

Parameters:

statusCode - The (HTTP) status code to set

getStatusCode

int getStatusCode()

Gets the (HTTP) status code of the back-end service call.

Returns:

int The (HTTP) status code

setCookies

void setCookies(List<org.apache.http.cookie.Cookie> cookies)

Sets the list of response cookies.

Parameters:

cookies - The list to set

getCookies

List<org.apache.http.cookie.Cookie> getCookies()

Gets the list of response cookies.

Returns:

The list of cookies

setLocation

void setLocation(String location)

Sets the redirected location URL when there is 302 redirect.

Parameters:

location - The redirected location

getLocation

String getLocation()

Gets the redirected location URL if the response was a 302 redirect.

Returns:

The redirected location

setHeaders

void setHeaders(Map<String,String> header)

Sets the map of all headers in the response.

Parameters:

header - The map of all headers

getHeaders

Map<String,String> getHeaders()

Gets the map of all headers from the response.

Returns:

The map of all headers

setDeviceCookies

void setDeviceCookies(List<org.apache.http.cookie.Cookie> cookies)

Sets list of response cookies sent to the client (device).

Parameters:

cookies - The list of cookies to set

getDeviceCookies

List<org.apache.http.cookie.Cookie> getDeviceCookies()

Gets the list of response cookies that will be sent to the client (device).

Returns:

The list of cookies

setDeviceHeaders

void setDeviceHeaders(Map<String,String> header)

Sets map of all headers that will be sent to client (device).

Parameters:

header - The map of all headers

getDeviceHeaders

Map<String,String> getDeviceHeaders()

Gets map of all headers that will be sent to client (device).

Returns:

The map of all headers

clone

DataControllerResponse clone()

Creates a copy (clone) of this response.

Returns:

A copy of this response