core.tut.pori.http

Class JSONResponse

java.lang.Object

core.tut.pori.http.Response

core.tut.pori.http.JSONResponse

public class JSONResponse
extends Response

Response object that supports JSON output. Note that you MUST use this class if you plan to use JSON output, the ResponseData is one you should use if you need XML output.

Nested Class Summary

Nested classes/interfaces inherited from class core.tut.pori.http.Response

Response.Status

Constructor Summary

Constructors

Constructor and Description
JSONResponse()
JSONResponse(JSONResponseData data)
JSONResponse(Response.Status stat)
JSONResponse(Response.Status stat, java.lang.String message)
JSONResponse(ResponseData data)

Method Summary

Modifier and Type	Method and Description
void	setResponseData(JSONResponseData data)
void	setResponseData(ResponseData data)
void	writeTo(javax.servlet.http.HttpServletResponse response) This method replaces the default XML/JAXB output with JSON using GSON annotations and sets content type to application/json.

Methods inherited from class core.tut.pori.http.Response

getMessage, getMethod, getResponseData, getService, getStatus, setDefaultAuthenticationHeader, setMessage, setMethod, setService, setStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONResponse

public JSONResponse()

JSONResponse

public JSONResponse(ResponseData data)
             throws java.lang.UnsupportedOperationException

Parameters:

data -

Throws:

java.lang.UnsupportedOperationException - if the given data is not of type JSONResponseData

JSONResponse

public JSONResponse(JSONResponseData data)

Parameters:

data -

JSONResponse

public JSONResponse(Response.Status stat,
                    java.lang.String message)

Parameters:

stat -

message -

JSONResponse

public JSONResponse(Response.Status stat)

Parameters:

stat -

Method Detail

writeTo

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

This method replaces the default XML/JAXB output with JSON using GSON annotations and sets content type to application/json. 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.

Overrides:

writeTo in class Response

Parameters:

response -

See Also:

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

setResponseData

public void setResponseData(ResponseData data)
                     throws java.lang.UnsupportedOperationException

Overrides:

setResponseData in class Response

Parameters:

data - the data to set

Throws:

java.lang.UnsupportedOperationException - if data is not of type JSONResponseData

See Also:

setResponseData(JSONResponseData)

setResponseData

public void setResponseData(JSONResponseData data)

Parameters:

data -