Package org.apache.turbine.modules.screens

Klasse PlainJSONScreen

java.lang.Object

org.apache.turbine.modules.screens.RawScreen

org.apache.turbine.modules.screens.PlainJSONScreen

Alle implementierten Schnittstellen:

Assembler, Screen

Bekannte direkte Unterklassen:

PlainJSONSecureAnnotatedScreen

public class PlainJSONScreen
extends RawScreen

A Screen class for dealing with JSON requests. Typically you would extend this class and override the doOutput() method to use it by setting the JSON output into rundata.setMessage( serialized ). As convenience you may use inject in your extended class the Turbine service JsonService Use PlainJSONSecureAnnotatedScreen if you need the user to be logged in or having a special role in prior to executing the functions you provide.

Here is an example from a subclass: public void doOutput(PipelineData pipelineData) throws Exception { RunData data = pipelineData.getRunData(); JSONStrategy strategy = null; try { strategy = new XYStrategy(); // the result goes into rundata.message strategy.execute(data, jsonService); } catch ( Exception e ) { log.error( "init failed for "+strategy , e); String msg = new JSONObject().put("error", e.getMessage()).toString(); data.setMessage( msg ); } super.doOutput(data); }

Version:

$Id$

Autor:

gk

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected static final int	BUFFER_SIZE
protected static final String	JSON_TYPE

Von Schnittstelle geerbte Felder org.apache.turbine.modules.Screen

CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
PlainJSONScreen()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	doOutput(PipelineData pipelineData)	Output JSON content set into RunData.getMessage().
protected String	getContentType(PipelineData pipelineData)	Set the content type.

Von Klasse geerbte Methoden org.apache.turbine.modules.screens.RawScreen

doBuild, getLayout

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.apache.turbine.modules.Screen

build, setLayout

Felddetails

JSON_TYPE

protected static final String JSON_TYPE

Siehe auch:

• Konstantenfeldwerte

BUFFER_SIZE

protected static final int BUFFER_SIZE

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

PlainJSONScreen

public PlainJSONScreen()

Methodendetails

getContentType

protected String getContentType(PipelineData pipelineData)

Beschreibung aus Klasse kopiert: RawScreen

Set the content type. This method should be overridden to actually set the real content-type header of the output.

Angegeben von:

getContentType in Klasse RawScreen

Parameter:

pipelineData - Turbine information.

Gibt zurück:

A String with the content type.

Siehe auch:

• RawScreen.getContentType(org.apache.turbine.pipeline.PipelineData)

doOutput

protected void doOutput(PipelineData pipelineData)
                 throws Exception

Output JSON content set into RunData.getMessage(). Encoding is UTF-8. @JSON_TYPE: "application/json;charset=utf-8".

Angegeben von:

doOutput in Klasse RawScreen

Parameter:

pipelineData - The PipelineData object.

Löst aus:

Exception - a generic exception.