core.tut.pori.http

Class Response

java.lang.Object

core.tut.pori.http.Response

Direct Known Subclasses:

JSONResponse, RedirectResponse, StringResponse

public class Response
extends java.lang.Object

Basic HTTP response, which prints the given ResponseData as an xml. By default, the status of the response is 200 OK

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Response.Status HTTP Status code enumerations.

Constructor Summary

Constructors

Constructor and Description
Response() for serialization
Response(Response.Status status)
Response(Response.Status status, java.lang.String message)
Response(ResponseData data)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage()
java.lang.String	getMethod()
ResponseData	getResponseData()
java.lang.String	getService()
Response.Status	getStatus()
static void	setDefaultAuthenticationHeader(javax.servlet.http.HttpServletResponse response) Set the default HTTP authentication header in the response.
void	setMessage(java.lang.String message) Set an optional message to be shown with the response
void	setMethod(java.lang.String method)
void	setResponseData(ResponseData data)
void	setService(java.lang.String service)
void	setStatus(Response.Status status)
void	writeTo(javax.servlet.http.HttpServletResponse response) Write this response to the given response object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Response

public Response()

for serialization

Response

public Response(Response.Status status)

Parameters:

status -

Response

public Response(Response.Status status,
                java.lang.String message)

Parameters:

status -

message -

Response

public Response(ResponseData data)

Parameters:

data -

Method Detail

writeTo

public void writeTo(javax.servlet.http.HttpServletResponse response)

Write this response to the given response object. This method can be overridden to provide custom responses. By default this method writes this object to the stream as XML based on JAXB annotations and sets the encoding (UTF-8) and content type (text/xml) to appropriate values. These to parameters should be changed for the response if format is changed in the overriding method. Additionally this method sets the HTTP basic authentication header if the status is set Response.Status.UNAUTHORIZED.

Parameters:

response -

See Also:

setDefaultAuthenticationHeader(HttpServletResponse), setStatus(core.tut.pori.http.Response.Status)

setDefaultAuthenticationHeader

public static void setDefaultAuthenticationHeader(javax.servlet.http.HttpServletResponse response)

Set the default HTTP authentication header in the response. HTTP Basic Authentication

Parameters:

response -

getStatus

public Response.Status getStatus()

Returns:

the status

setStatus

public void setStatus(Response.Status status)

Parameters:

status - the status to set

getMethod

public java.lang.String getMethod()

Returns:

the method

setMethod

public void setMethod(java.lang.String method)

Parameters:

method - the method to set

getService

public java.lang.String getService()

Returns:

the service

setService

public void setService(java.lang.String service)

Parameters:

service - the service to set

getResponseData

public ResponseData getResponseData()

Returns:

the data

setResponseData

public void setResponseData(ResponseData data)

Parameters:

data - the data to set

getMessage

public java.lang.String getMessage()

Returns:

response message

setMessage

public void setMessage(java.lang.String message)

Set an optional message to be shown with the response

Parameters:

message -