org.apache.sling.servlets.post

Class JSONResponse

java.lang.Object

org.apache.sling.servlets.post.AbstractPostResponse

org.apache.sling.servlets.post.JSONResponse

All Implemented Interfaces:

PostResponse

public class JSONResponse
extends AbstractPostResponse

The JSONResponse is an AbstractPostResponse preparing the response in JSON.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JSONResponse.JSONResponseException

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESPONSE_CONTENT_TYPE

Fields inherited from class org.apache.sling.servlets.post.AbstractPostResponse

PN_ERROR, PN_IS_CREATED, PN_LOCATION, PN_PARENT_LOCATION, PN_PATH, PN_REFERER, PN_STATUS_CODE, PN_STATUS_MESSAGE, PN_TITLE

Constructor Summary

Constructors

Constructor and Description
JSONResponse()

Method Summary

Modifier and Type	Method and Description
protected void	doSend(javax.servlet.http.HttpServletResponse response)
java.lang.Throwable	getError() Returns any recorded error or null
java.lang.Object	getProperty(java.lang.String name) Returns the generic response property with the given name and type or null if no such property exists.
void	onChange(java.lang.String type, java.lang.String... arguments) Records a generic change of the given type with arguments.
void	setError(java.lang.Throwable error) Sets the recorded error causing the operation to fail.
void	setProperty(java.lang.String name, java.lang.Object value) This method accepts values that correspond to json primitives or otherwise assumes that the toString() of the value can be parsed as json.

Methods inherited from class org.apache.sling.servlets.post.AbstractPostResponse

getLocation, getParentLocation, getPath, getProperty, getReferer, getStatusCode, getStatusMessage, isCreateRequest, isSafeReferer, isSuccessful, onCopied, onCreated, onDeleted, onModified, onMoved, send, setCreateRequest, setLocation, setParentLocation, setPath, setReferer, setStatus, setTitle

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE_CONTENT_TYPE

public static final java.lang.String RESPONSE_CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

JSONResponse

public JSONResponse()

Method Detail

onChange

public void onChange(java.lang.String type,
                     java.lang.String... arguments)

Description copied from interface: PostResponse

Records a generic change of the given type with arguments.

Parameters:

type - The type of the modification

arguments - The arguments to the modifications

setError

public void setError(java.lang.Throwable error)

Description copied from interface: PostResponse

Sets the recorded error causing the operation to fail.

Specified by:

setError in interface PostResponse

Overrides:

setError in class AbstractPostResponse

Parameters:

error - the throwable

getError

public java.lang.Throwable getError()

Description copied from class: AbstractPostResponse

Returns any recorded error or null

Specified by:

getError in interface PostResponse

Overrides:

getError in class AbstractPostResponse

Returns:

an error or null

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

This method accepts values that correspond to json primitives or otherwise assumes that the toString() of the value can be parsed as json. If neither is the case it will throw an Exception. Assuming the above holds, it will put the value as json directly into the json value part of the response.

Overrides:

setProperty in class AbstractPostResponse

Parameters:

name - name of the property

value - value of the property - either of type {String, Boolean, Number, null} or the toString() is parseable as json

Throws:

JSONResponse.JSONResponseException - if the value is not usable

getProperty

public java.lang.Object getProperty(java.lang.String name)

Description copied from class: AbstractPostResponse

Returns the generic response property with the given name and type or null if no such property exists.

Overrides:

getProperty in class AbstractPostResponse

Parameters:

name - the name of the response property

Returns:

the requested property (might be null)

doSend

protected void doSend(javax.servlet.http.HttpServletResponse response)
               throws java.io.IOException

Specified by:

doSend in class AbstractPostResponse

Throws:

java.io.IOException