edu.cornell.mannlib.vitro.webapp.controller.json

Class JsonObjectProducer

java.lang.Object

edu.cornell.mannlib.vitro.webapp.controller.json.JsonProducer

edu.cornell.mannlib.vitro.webapp.controller.json.JsonObjectProducer

Direct Known Subclasses:

GetAllVClasses, GetSearchIndividualsByVClass, GetSearchIndividualsByVClasses, GetVClassesForVClassGroup

public abstract class JsonObjectProducer
extends JsonProducer

A base for classes that produce a JSON object, based on the parameters in the request. The result is never empty. At worst, it is an object that contains only an "errorMessage" field. If an exception occurrs during processing, The "errorMessage" field will contain the exception message and the response status will be set to 500 (server error). Normally, "errorMessage" will be empty, and the status will default to 200 (OK).

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.servlet.ServletContext	ctx
protected VitroRequest	vreq

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonObjectProducer(VitroRequest vreq)

Method Summary

Modifier and Type	Method and Description
protected abstract JSONObject	process() Sub-classes implement this method.
void	process(javax.servlet.http.HttpServletResponse resp)

Methods inherited from class edu.cornell.mannlib.vitro.webapp.controller.json.JsonProducer

getVclassIds, getVclassParameter, individualsToJson

Methods inherited from class java.lang.Object

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

Field Detail

vreq

protected final VitroRequest vreq

ctx

protected final javax.servlet.ServletContext ctx

Constructor Detail

JsonObjectProducer

protected JsonObjectProducer(VitroRequest vreq)

Method Detail

process

protected abstract JSONObject process()
                               throws Exception

Sub-classes implement this method. Given the request, produce a JSON object as the result.

Throws:

Exception

process

public final void process(javax.servlet.http.HttpServletResponse resp)
                   throws IOException

Throws:

IOException