org.apache.shindig.protocol

Class ApiServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.shindig.common.servlet.InjectedServlet

org.apache.shindig.protocol.ApiServlet

All Implemented Interfaces:

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

Direct Known Subclasses:

DataServiceServlet, JsonRpcServlet

public abstract class ApiServlet
extends InjectedServlet

Common base class for API servlets.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ATOM_FORMAT
protected BeanConverter	atomConverter
protected ContainerConfig	containerConfig
protected static String	DEFAULT_ENCODING
static com.google.inject.Key<Set<Object>>	DEFAULT_HANDLER_KEY The default key used to look up handlers if the servlet config parameter is not available
protected HandlerRegistry	dispatcher
protected static String	FORMAT_PARAM
static String	HANDLERS_PARAM ServletConfig parameter set to provide an explicit named binding for handlers
protected Boolean	isJSONPAllowed
protected static String	JSON_FORMAT
protected BeanConverter	jsonConverter
protected static String	XML_FORMAT
protected BeanConverter	xmlConverter

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

initialized, injector

Constructor Summary

Constructors

Constructor and Description
ApiServlet()

Method Summary

Methods

Modifier and Type	Method and Description
protected ResponseItem	getResponseItem(Future<?> future)
protected SecurityToken	getSecurityToken(javax.servlet.http.HttpServletRequest servletRequest)
void	init(javax.servlet.ServletConfig config)
protected ResponseItem	responseItemFromException(Throwable t)
protected abstract void	sendError(javax.servlet.http.HttpServletResponse servletResponse, ResponseItem responseItem)
protected void	sendSecurityError(javax.servlet.http.HttpServletResponse servletResponse)
void	setBeanConverters(BeanConverter jsonConverter, BeanConverter xmlConverter, BeanConverter atomConverter)
protected void	setCharacterEncodings(javax.servlet.http.HttpServletRequest servletRequest, javax.servlet.http.HttpServletResponse servletResponse)
void	setContainerConfig(ContainerConfig containerConfig)
void	setHandlerRegistry(HandlerRegistry dispatcher)
void	setJSONPAllowed(Boolean isJSONPAllowed)

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, 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

FORMAT_PARAM

protected static final String FORMAT_PARAM

See Also:

Constant Field Values

JSON_FORMAT

protected static final String JSON_FORMAT

See Also:

Constant Field Values

ATOM_FORMAT

protected static final String ATOM_FORMAT

See Also:

Constant Field Values

XML_FORMAT

protected static final String XML_FORMAT

See Also:

Constant Field Values

DEFAULT_ENCODING

protected static final String DEFAULT_ENCODING

See Also:

Constant Field Values

HANDLERS_PARAM

public static final String HANDLERS_PARAM

ServletConfig parameter set to provide an explicit named binding for handlers

See Also:

Constant Field Values

DEFAULT_HANDLER_KEY

public static final com.google.inject.Key<Set<Object>> DEFAULT_HANDLER_KEY

The default key used to look up handlers if the servlet config parameter is not available

dispatcher

protected HandlerRegistry dispatcher

jsonConverter

protected BeanConverter jsonConverter

xmlConverter

protected BeanConverter xmlConverter

atomConverter

protected BeanConverter atomConverter

containerConfig

protected ContainerConfig containerConfig

isJSONPAllowed

protected Boolean isJSONPAllowed

Constructor Detail

ApiServlet

public ApiServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class InjectedServlet

Throws:

javax.servlet.ServletException

setHandlerRegistry

@Inject
public void setHandlerRegistry(HandlerRegistry dispatcher)

setContainerConfig

@Inject
public void setContainerConfig(ContainerConfig containerConfig)

setJSONPAllowed

@Inject
public void setJSONPAllowed(Boolean isJSONPAllowed)

setBeanConverters

@Inject
public void setBeanConverters(BeanConverter jsonConverter,
                            BeanConverter xmlConverter,
                            BeanConverter atomConverter)

getSecurityToken

protected SecurityToken getSecurityToken(javax.servlet.http.HttpServletRequest servletRequest)

sendError

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

Throws:

IOException

sendSecurityError

protected void sendSecurityError(javax.servlet.http.HttpServletResponse servletResponse)
                          throws IOException

Throws:

IOException

getResponseItem

protected ResponseItem getResponseItem(Future<?> future)

responseItemFromException

protected ResponseItem responseItemFromException(Throwable t)

setCharacterEncodings

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

Throws:

IOException