core.tut.pori.http

Class StringResponse

java.lang.Object

core.tut.pori.http.Response

core.tut.pori.http.StringResponse

public class StringResponse
extends Response

Prints data as raw strings format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringResponse.StringData Interface for classes, which should support conversion to string-based response data

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

Response.Status

Constructor Summary

Constructors

Constructor and Description
StringResponse() for serialization
StringResponse(Response.Status status)
StringResponse(StringResponse.StringData data)

Method Summary

Modifier and Type	Method and Description
StringResponse.StringData	getStringData()
void	setResponseData(ResponseData data)
void	setStringData(StringResponse.StringData stringData)
void	writeTo(javax.servlet.http.HttpServletResponse response) Write this response to the given response object.

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

StringResponse

public StringResponse()

for serialization

StringResponse

public StringResponse(Response.Status status)

Parameters:

status -

StringResponse

public StringResponse(StringResponse.StringData data)

Parameters:

data -

Method Detail

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 StringResponse.StringData

See Also:

setStringData(StringData)

writeTo

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

Description copied from class: 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.

Overrides:

writeTo in class Response

See Also:

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

getStringData

public StringResponse.StringData getStringData()

Returns:

the stringData

setStringData

public void setStringData(StringResponse.StringData stringData)

Parameters:

stringData - the stringData to set