org.apache.shindig.gadgets.servlet

Class JsonRpcGadgetContext

java.lang.Object

org.apache.shindig.gadgets.GadgetContext

org.apache.shindig.gadgets.servlet.JsonRpcGadgetContext

public class JsonRpcGadgetContext
extends GadgetContext

Extracts context from JSON input.

Constructor Summary

Constructors

Constructor and Description
JsonRpcGadgetContext(org.json.JSONObject context, org.json.JSONObject gadget)

Method Summary

Methods

Modifier and Type	Method and Description
String	getContainer()
boolean	getDebug()
boolean	getIgnoreCache()
Locale	getLocale()
int	getModuleId()
String	getParameter(String name)
RenderingContext	getRenderingContext()
Uri	getUrl()
UserPrefs	getUserPrefs()
String	getView()

Methods inherited from class org.apache.shindig.gadgets.GadgetContext

getHost, getToken, getUserAgent, getUserIp

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonRpcGadgetContext

public JsonRpcGadgetContext(org.json.JSONObject context,
                    org.json.JSONObject gadget)
                     throws org.json.JSONException

Parameters:

context - Request global parameters.

gadget - Values for the gadget being rendered.

Throws:

org.json.JSONException - If parameters can't be extracted or aren't correctly formed.

Method Detail

getParameter

public String getParameter(String name)

Overrides:

getParameter in class GadgetContext

Parameters:

name - The parameter to get data for.

Returns:

The parameter set under the given name, or null.

getContainer

public String getContainer()

Overrides:

getContainer in class GadgetContext

Returns:

The container of the current request.

getDebug

public boolean getDebug()

Overrides:

getDebug in class GadgetContext

Returns:

Whether or not to show debug output.

getIgnoreCache

public boolean getIgnoreCache()

Overrides:

getIgnoreCache in class GadgetContext

Returns:

Whether or not to bypass caching behavior for the current request.

getLocale

public Locale getLocale()

Overrides:

getLocale in class GadgetContext

Returns:

The locale for this request.

getModuleId

public int getModuleId()

Overrides:

getModuleId in class GadgetContext

Returns:

The module id for this request.

getRenderingContext

public RenderingContext getRenderingContext()

Overrides:

getRenderingContext in class GadgetContext

Returns:

The rendering context for this request.

getUrl

public Uri getUrl()

Overrides:

getUrl in class GadgetContext

Returns:

The url for this gadget.

getUserPrefs

public UserPrefs getUserPrefs()

Overrides:

getUserPrefs in class GadgetContext

Returns:

The user prefs for the current request.

getView

public String getView()

Overrides:

getView in class GadgetContext

Returns:

Name of view to show