org.apache.shindig.gadgets.servlet

Class MakeRequestHandler

java.lang.Object

org.apache.shindig.gadgets.servlet.MakeRequestHandler

All Implemented Interfaces:

ContainerConfig.ConfigObserver

public class MakeRequestHandler
extends Object
implements ContainerConfig.ConfigObserver

Handles gadgets.io.makeRequest requests. Unlike ProxyHandler, this may perform operations such as OAuth or signed fetch.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS_PARAM
static String	AUTHZ_PARAM
static String	CONTENT_TYPE_PARAM
static String	CORE_IO
static String	DEFAULT_NUM_ENTRIES
static String	GADGETS_FEATURES
static String	GET_FULL_HEADERS_PARAM
static String	GET_SUMMARIES_PARAM
static String	HEADERS_PARAM
static String	IFRAME_RESPONSE_PREFIX
static String	IFRAME_RESPONSE_SUFFIX
static int	MAX_POST_SIZE_DEFAULT
static String	MAX_POST_SIZE_KEY
static String	METHOD_PARAM
static String	MULTI_PART_FORM_POST
static String	MULTI_PART_FORM_POST_IFRAME
static String	NUM_ENTRIES_PARAM
static String	POST_DATA_PARAM
static String	UNPARSEABLE_CRUFT

Constructor Summary

Constructors

Constructor and Description
MakeRequestHandler(ContainerConfig config, RequestPipeline requestPipeline, ResponseRewriterRegistry contentRewriterRegistry, com.google.inject.Provider<FeedProcessor> feedProcessorProvider, GadgetAdminStore gadgetAdminStore, Processor processor, LockedDomainService lockedDomainService)

Method Summary

Methods

Modifier and Type	Method and Description
protected HttpRequest	buildHttpRequest(javax.servlet.http.HttpServletRequest request) Generate a remote content request based on the parameters sent from the client.
void	containersChanged(ContainerConfig config, Collection<String> changed, Collection<String> removed)
protected String	convertResponseToJson(SecurityToken authToken, javax.servlet.http.HttpServletRequest request, HttpResponse results) Format a response as JSON, including additional JSON inserted by chained content fetchers.
void	fetch(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Executes a request, returning the response as JSON to be handled by makeRequest.
protected static String	getContainer(javax.servlet.http.HttpServletRequest request) Extracts the container name from the request.
protected static String	getParameter(javax.servlet.http.HttpServletRequest request, String key, String defaultValue) getParameter helper method, returning default value if param not present.
protected RequestPipeline	getRequestPipeline()
protected void	setPostData(String container, javax.servlet.http.HttpServletRequest request, HttpRequest req) Set http request post data according to servlet request.
protected void	setResponseHeaders(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, HttpResponse results) Sets cache control headers for the response.

Methods inherited from class java.lang.Object

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

Field Detail

ALIAS_PARAM

public static final String ALIAS_PARAM

See Also:

Constant Field Values

POST_DATA_PARAM

public static final String POST_DATA_PARAM

See Also:

Constant Field Values

METHOD_PARAM

public static final String METHOD_PARAM

See Also:

Constant Field Values

HEADERS_PARAM

public static final String HEADERS_PARAM

See Also:

Constant Field Values

CONTENT_TYPE_PARAM

public static final String CONTENT_TYPE_PARAM

See Also:

Constant Field Values

NUM_ENTRIES_PARAM

public static final String NUM_ENTRIES_PARAM

See Also:

Constant Field Values

DEFAULT_NUM_ENTRIES

public static final String DEFAULT_NUM_ENTRIES

See Also:

Constant Field Values

GET_SUMMARIES_PARAM

public static final String GET_SUMMARIES_PARAM

See Also:

Constant Field Values

GET_FULL_HEADERS_PARAM

public static final String GET_FULL_HEADERS_PARAM

See Also:

Constant Field Values

AUTHZ_PARAM

public static final String AUTHZ_PARAM

See Also:

Constant Field Values

MAX_POST_SIZE_KEY

public static final String MAX_POST_SIZE_KEY

See Also:

Constant Field Values

MULTI_PART_FORM_POST

public static final String MULTI_PART_FORM_POST

See Also:

Constant Field Values

MULTI_PART_FORM_POST_IFRAME

public static final String MULTI_PART_FORM_POST_IFRAME

See Also:

Constant Field Values

GADGETS_FEATURES

public static final String GADGETS_FEATURES

See Also:

Constant Field Values

CORE_IO

public static final String CORE_IO

See Also:

Constant Field Values

UNPARSEABLE_CRUFT

public static final String UNPARSEABLE_CRUFT

See Also:

Constant Field Values

MAX_POST_SIZE_DEFAULT

public static final int MAX_POST_SIZE_DEFAULT

See Also:

Constant Field Values

IFRAME_RESPONSE_PREFIX

public static final String IFRAME_RESPONSE_PREFIX

See Also:

Constant Field Values

IFRAME_RESPONSE_SUFFIX

public static final String IFRAME_RESPONSE_SUFFIX

See Also:

Constant Field Values

Constructor Detail

MakeRequestHandler

@Inject
public MakeRequestHandler(ContainerConfig config,
                         RequestPipeline requestPipeline,
                         ResponseRewriterRegistry contentRewriterRegistry,
                         com.google.inject.Provider<FeedProcessor> feedProcessorProvider,
                         GadgetAdminStore gadgetAdminStore,
                         Processor processor,
                         LockedDomainService lockedDomainService)

Method Detail

fetch

public void fetch(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
           throws GadgetException,
                  IOException

Executes a request, returning the response as JSON to be handled by makeRequest.

Throws:

GadgetException

IOException

buildHttpRequest

protected HttpRequest buildHttpRequest(javax.servlet.http.HttpServletRequest request)
                                throws GadgetException

Generate a remote content request based on the parameters sent from the client.

Throws:

GadgetException

setPostData

protected void setPostData(String container,
               javax.servlet.http.HttpServletRequest request,
               HttpRequest req)
                    throws GadgetException

Set http request post data according to servlet request. It uses header encoding if available, and defaulted to utf8 Override the function if different behavior is needed.

Throws:

GadgetException

convertResponseToJson

protected String convertResponseToJson(SecurityToken authToken,
                           javax.servlet.http.HttpServletRequest request,
                           HttpResponse results)
                                throws GadgetException

Format a response as JSON, including additional JSON inserted by chained content fetchers.

Throws:

GadgetException

getRequestPipeline

protected RequestPipeline getRequestPipeline()

getContainer

protected static String getContainer(javax.servlet.http.HttpServletRequest request)

Extracts the container name from the request.

getParameter

protected static String getParameter(javax.servlet.http.HttpServletRequest request,
                  String key,
                  String defaultValue)

getParameter helper method, returning default value if param not present.

setResponseHeaders

protected void setResponseHeaders(javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response,
                      HttpResponse results)
                           throws GadgetException

Sets cache control headers for the response.

Throws:

GadgetException

containersChanged

public void containersChanged(ContainerConfig config,
                     Collection<String> changed,
                     Collection<String> removed)

Specified by:

containersChanged in interface ContainerConfig.ConfigObserver