com.groiss.gui

Class JSONPage

java.lang.Object

com.groiss.gui.JSONPage

All Implemented Interfaces:

Page, StreamablePage

public class JSONPage
extends Object
implements StreamablePage

Implementation of the Page, that is used to send a JSON (JavaScript Object Notation) content back to the browser. Used for Ajax based requests. Contenttype is set to "application/json".

Field Summary

Fields

Modifier and Type	Field and Description
static JSONPage	EMPTY_PAGE

Constructor Summary

Constructors

Constructor and Description
JSONPage(Object jsonContent) Initializes an instance of this class using the final content in JSON form.

Method Summary

Modifier and Type	Method and Description
void	addHeader(String header, Date value) Set a header field in the response before writing the page.
void	addHeader(String header, int value) Set a header field in the response before writing the page.
void	addHeader(String header, String value) Set a header field in the response before writing the page.
Object	getContent()
String	getContentType() Returns the content type of the page, for example "text/html".
List<Pair<String,Object>>	getHeaders() Returns the list of http-response-headers to be set on the HttpServletResponse
void	output(Writer w)
String	show() For a JSONPage, this is usually never called by the dispatcher; the content will be written directly to the writer of the response.
void	writeTo(HttpServletResponse res) Deprecated. since ep 9.0; just return the page in your servlet methods. the required http-headers will be set automatically

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_PAGE

public static final JSONPage EMPTY_PAGE

Constructor Detail

JSONPage

public JSONPage(Object jsonContent)

Initializes an instance of this class using the final content in JSON form.

Parameters:

jsonContent - the response content in JSON form. If org.json.JSObject or org.json.JSONArray instances are used, the content can be streamed to the client (in order to to preserve memory). For all other types, the result of jsonObject.toString() is written to the response

Method Detail

getContentType

public String getContentType()

Description copied from interface: Page

Returns the content type of the page, for example "text/html".

Specified by:

getContentType in interface Page

Returns:

the contents mime type as String

show

public String show()

For a JSONPage, this is usually never called by the dispatcher; the content will be written directly to the writer of the response.

Specified by:

show in interface Page

See Also:

Page.show()

getContent

public Object getContent()

writeTo

@Deprecated
public void writeTo(HttpServletResponse res)
                         throws IOException

Deprecated. since ep 9.0; just return the page in your servlet methods. the required http-headers will be set automatically

Write page in response, and add specific to json headers

Parameters:

res -

Throws:

IOException

getHeaders

public List<Pair<String,Object>> getHeaders()

Description copied from interface: Page

Returns the list of http-response-headers to be set on the HttpServletResponse

Specified by:

getHeaders in interface Page

Returns:

the http-headers (the value may be one of String, Date or Integer

addHeader

public void addHeader(String header,
                      String value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setHeader(String, String) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

addHeader

public void addHeader(String header,
                      Date value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setDateHeader(String,long) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

addHeader

public void addHeader(String header,
                      int value)

Set a header field in the response before writing the page. Please note that HttpServletResponse.setIntHeader(String,int) will be used to set to the new value.

Parameters:

header - the name of the header

value - the header value

output

public void output(Writer w)

Specified by:

output in interface StreamablePage