org.apache.shindig.protocol

Class JsonRpcServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.shindig.common.servlet.InjectedServlet

org.apache.shindig.protocol.ApiServlet

org.apache.shindig.protocol.JsonRpcServlet

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class JsonRpcServlet
extends ApiServlet

JSON-RPC handler servlet.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Set<String>	ALLOWED_CONTENT_TYPES
protected static Map<Integer,String>	errorTitles Map of old-style error titles
static String	REQUEST_PARAM In a multipart request, the form item with field name "request" will contain the actual request, per the proposed Opensocial 0.9 specification.

Fields inherited from class org.apache.shindig.protocol.ApiServlet

ATOM_FORMAT, atomConverter, containerConfig, DEFAULT_ENCODING, DEFAULT_HANDLER_KEY, dispatcher, FORMAT_PARAM, HANDLERS_PARAM, isJSONPAllowed, JSON_FORMAT, jsonConverter, XML_FORMAT, xmlConverter

Fields inherited from class org.apache.shindig.common.servlet.InjectedServlet

initialized, injector

Constructor Summary

Constructors

Constructor and Description
JsonRpcServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addResult(Map<String,Object> result, Object data)
protected void	dispatch(JSONObject request, Map<String,FormDataItem> formItems, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, SecurityToken token, String callback)
protected void	dispatchBatch(JSONArray batch, Map<String,FormDataItem> formItems, javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse, SecurityToken token, String callback)
protected Object	getErrorJson(ResponseItem responseItem)
protected RpcHandler	getHandler(JSONObject rpc, javax.servlet.http.HttpServletRequest request) Wrap call to dispatcher to allow for implementation specific overrides and servlet-request contextual handling
protected Object	getJSONResponse(String key, ResponseItem responseItem)
protected String	getPostContent(javax.servlet.http.HttpServletRequest request, Map<String,FormDataItem> formItems)
protected void	sendBadRequest(Throwable t, javax.servlet.http.HttpServletResponse response)
protected void	sendError(javax.servlet.http.HttpServletResponse servletResponse, ResponseItem responseItem)
protected void	sendJsonParseError(JSONException e, javax.servlet.http.HttpServletResponse response)
protected void	service(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)

Methods inherited from class org.apache.shindig.protocol.ApiServlet

getResponseItem, getSecurityToken, init, responseItemFromException, sendSecurityError, setBeanConverters, setCharacterEncodings, setContainerConfig, setHandlerRegistry, setJSONPAllowed

Methods inherited from class org.apache.shindig.common.servlet.InjectedServlet

checkInitialized

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWED_CONTENT_TYPES

public static final Set<String> ALLOWED_CONTENT_TYPES

REQUEST_PARAM

public static final String REQUEST_PARAM

In a multipart request, the form item with field name "request" will contain the actual request, per the proposed Opensocial 0.9 specification.

See Also:

Constant Field Values

errorTitles

protected static final Map<Integer,String> errorTitles

Map of old-style error titles

Constructor Detail

JsonRpcServlet

public JsonRpcServlet()

Method Detail

service

protected void service(javax.servlet.http.HttpServletRequest servletRequest,
           javax.servlet.http.HttpServletResponse servletResponse)
                throws IOException

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

IOException

getPostContent

protected String getPostContent(javax.servlet.http.HttpServletRequest request,
                    Map<String,FormDataItem> formItems)
                         throws ContentTypes.InvalidContentTypeException,
                                IOException

Throws:

ContentTypes.InvalidContentTypeException

IOException

dispatchBatch

protected void dispatchBatch(JSONArray batch,
                 Map<String,FormDataItem> formItems,
                 javax.servlet.http.HttpServletRequest servletRequest,
                 javax.servlet.http.HttpServletResponse servletResponse,
                 SecurityToken token,
                 String callback)
                      throws JSONException,
                             IOException

Throws:

JSONException

IOException

dispatch

protected void dispatch(JSONObject request,
            Map<String,FormDataItem> formItems,
            javax.servlet.http.HttpServletRequest servletRequest,
            javax.servlet.http.HttpServletResponse servletResponse,
            SecurityToken token,
            String callback)
                 throws JSONException,
                        IOException

Throws:

JSONException

IOException

addResult

protected void addResult(Map<String,Object> result,
             Object data)

getHandler

protected RpcHandler getHandler(JSONObject rpc,
                    javax.servlet.http.HttpServletRequest request)

Wrap call to dispatcher to allow for implementation specific overrides and servlet-request contextual handling

getJSONResponse

protected Object getJSONResponse(String key,
                     ResponseItem responseItem)

getErrorJson

protected Object getErrorJson(ResponseItem responseItem)

sendError

protected void sendError(javax.servlet.http.HttpServletResponse servletResponse,
             ResponseItem responseItem)
                  throws IOException

Specified by:

sendError in class ApiServlet

Throws:

IOException

sendBadRequest

protected void sendBadRequest(Throwable t,
                  javax.servlet.http.HttpServletResponse response)
                       throws IOException

Throws:

IOException

sendJsonParseError

protected void sendJsonParseError(JSONException e,
                      javax.servlet.http.HttpServletResponse response)
                           throws IOException

Throws:

IOException