Package com.google.api.server.spi.request

Class RestServletRequestParamReader

java.lang.Object

com.google.api.server.spi.request.AbstractParamReader

com.google.api.server.spi.request.ServletRequestParamReader

com.google.api.server.spi.request.RestServletRequestParamReader

All Implemented Interfaces:

ParamReader

public class RestServletRequestParamReader
extends ServletRequestParamReader

A ParamReader which reads parameters from a JSON-REST request. That is, instead of just looking in the JSON body, it also looks at path and query parameters. This is mainly for use with EndpointsServlet, and tries to emulate existing behavior by stuffing path and query parameters into the main request body.

Field Summary

Fields inherited from class com.google.api.server.spi.request.ServletRequestParamReader

endpointsContext, methodConfig, objectReader

Constructor Summary

Constructors

Constructor	Description
RestServletRequestParamReader(EndpointMethod method, EndpointsContext endpointsContext, javax.servlet.ServletContext servletContext, ApiSerializationConfig serializationConfig, ApiMethodConfig methodConfig)

Method Summary

Modifier and Type	Method	Description
Object[]	read()	Reads parameters in JSON into an Object array to be used to invoke an Endpoint method.

Methods inherited from class com.google.api.server.spi.request.ServletRequestParamReader

deserializeParams, getParameterNames

Methods inherited from class com.google.api.server.spi.request.AbstractParamReader

getMethod

Methods inherited from class java.lang.Object

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

Constructor Detail

RestServletRequestParamReader

public RestServletRequestParamReader(EndpointMethod method,
                                     EndpointsContext endpointsContext,
                                     javax.servlet.ServletContext servletContext,
                                     ApiSerializationConfig serializationConfig,
                                     ApiMethodConfig methodConfig)

Method Detail

read

public Object[] read()
              throws ServiceException

Description copied from interface: ParamReader

Reads parameters in JSON into an Object array to be used to invoke an Endpoint method.

Specified by:

read in interface ParamReader

Overrides:

read in class ServletRequestParamReader

Throws:

ServiceException - when reading of input stream failed, input JSON is invalid, or cannot be mapped into parameter objects, or user authentication fails.