org.apache.shindig.gadgets.servlet

Class GadgetsHandlerService

java.lang.Object

org.apache.shindig.gadgets.servlet.GadgetsHandlerService

public class GadgetsHandlerService
extends Object

Service that interfaces with the system to provide information about gadgets.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GadgetsHandlerService.MetadataGadgetContext GadgetContext for metadata request.

Field Summary

Fields

Modifier and Type	Field and Description
protected BeanDelegator	beanDelegator
protected BeanFilter	beanFilter
protected CajaContentRewriter	cajaContentRewriter
protected FeatureRegistryProvider	featureRegistryProvider
protected GadgetAdminStore	gadgetAdminStore
protected IframeUriManager	iframeUriManager
protected JsServingPipeline	jsPipeline
protected JsRequestBuilder	jsRequestBuilder
protected JsUriManager	jsUriManager
protected ModuleIdManager	moduleIdManager
protected Processor	processor
protected ProxyHandler	proxyHandler
protected ProxyUriManager	proxyUriManager
protected SecurityTokenCodec	securityTokenCodec
protected long	specRefreshInterval
protected TimeSource	timeSource

Constructor Summary

Constructors

Constructor and Description

GadgetsHandlerService(TimeSource timeSource, Processor processor, IframeUriManager iframeUriManager, SecurityTokenCodec securityTokenCodec, ProxyUriManager proxyUriManager, JsUriManager jsUriManager, ProxyHandler proxyHandler, JsServingPipeline jsPipeline, JsRequestBuilder jsRequestBuilder, long specRefreshInterval, BeanFilter beanFilter, CajaContentRewriter cajaContentRewriter, GadgetAdminStore gadgetAdminStore, FeatureRegistryProvider featureRegistryProvider, ModuleIdManager moduleIdManager, ContainerConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
static GadgetsHandlerApi.MessageLevel	convertMessageLevel(String name) Convert message level to Shindig's serializable message type
GadgetsHandlerApi.BaseResponse	createErrorResponse(Uri uri, Exception e, String defaultMsg)
GadgetsHandlerApi.BaseResponse	createErrorResponse(Uri url, int code, String error)
protected JsUriManager.JsUri	createJsUri(GadgetsHandlerApi.JsRequest request)
protected ProxyUriManager.ProxyUri	createProxyUri(GadgetsHandlerApi.ProxyRequest request)
GadgetsHandlerApi.CajaResponse	getCaja(GadgetsHandlerApi.CajaRequest request)
protected long	getDefaultExpiration()
GadgetsHandlerApi.JsResponse	getJs(GadgetsHandlerApi.JsRequest request)
GadgetsHandlerApi.MetadataResponse	getMetadata(GadgetsHandlerApi.MetadataRequest request) Get gadget metadata information and iframe url.
GadgetsHandlerApi.ProxyResponse	getProxy(GadgetsHandlerApi.ProxyRequest request)
protected Long	getProxyExpireMs(ProxyUriManager.ProxyUri proxyUri, HttpResponse httpResponse)
GadgetsHandlerApi.TokenResponse	getToken(GadgetsHandlerApi.TokenRequest request) Create security token
protected void	verifyBaseParams(GadgetsHandlerApi.BaseRequest request, boolean checkUrl) Verify request parameter are defined.

Methods inherited from class java.lang.Object

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

Field Detail

timeSource

protected final TimeSource timeSource

processor

protected final Processor processor

iframeUriManager

protected final IframeUriManager iframeUriManager

securityTokenCodec

protected final SecurityTokenCodec securityTokenCodec

proxyUriManager

protected final ProxyUriManager proxyUriManager

jsUriManager

protected final JsUriManager jsUriManager

jsPipeline

protected final JsServingPipeline jsPipeline

jsRequestBuilder

protected final JsRequestBuilder jsRequestBuilder

proxyHandler

protected final ProxyHandler proxyHandler

beanDelegator

protected final BeanDelegator beanDelegator

specRefreshInterval

protected final long specRefreshInterval

beanFilter

protected final BeanFilter beanFilter

cajaContentRewriter

protected final CajaContentRewriter cajaContentRewriter

gadgetAdminStore

protected final GadgetAdminStore gadgetAdminStore

featureRegistryProvider

protected final FeatureRegistryProvider featureRegistryProvider

moduleIdManager

protected final ModuleIdManager moduleIdManager

Constructor Detail

GadgetsHandlerService

@Inject
public GadgetsHandlerService(TimeSource timeSource,
                            Processor processor,
                            IframeUriManager iframeUriManager,
                            SecurityTokenCodec securityTokenCodec,
                            ProxyUriManager proxyUriManager,
                            JsUriManager jsUriManager,
                            ProxyHandler proxyHandler,
                            JsServingPipeline jsPipeline,
                            JsRequestBuilder jsRequestBuilder,
                            long specRefreshInterval,
                            BeanFilter beanFilter,
                            CajaContentRewriter cajaContentRewriter,
                            GadgetAdminStore gadgetAdminStore,
                            FeatureRegistryProvider featureRegistryProvider,
                            ModuleIdManager moduleIdManager,
                            ContainerConfig config)

Method Detail

getMetadata

public GadgetsHandlerApi.MetadataResponse getMetadata(GadgetsHandlerApi.MetadataRequest request)
                                               throws ProcessingException

Get gadget metadata information and iframe url. Support filtering of fields

Parameters:

request - request parameters

Returns:

gadget metadata and iframe urls

Throws:

ProcessingException

getToken

public GadgetsHandlerApi.TokenResponse getToken(GadgetsHandlerApi.TokenRequest request)
                                         throws SecurityTokenException,
                                                ProcessingException

Create security token

Parameters:

request - token parameters (gadget, owner and viewer)

Returns:

Security token

Throws:

SecurityTokenException

ProcessingException

getJs

public GadgetsHandlerApi.JsResponse getJs(GadgetsHandlerApi.JsRequest request)
                                   throws ProcessingException

Throws:

ProcessingException

getProxy

public GadgetsHandlerApi.ProxyResponse getProxy(GadgetsHandlerApi.ProxyRequest request)
                                         throws ProcessingException

Throws:

ProcessingException

convertMessageLevel

public static GadgetsHandlerApi.MessageLevel convertMessageLevel(String name)

Convert message level to Shindig's serializable message type

getCaja

public GadgetsHandlerApi.CajaResponse getCaja(GadgetsHandlerApi.CajaRequest request)
                                       throws ProcessingException

Throws:

ProcessingException

verifyBaseParams

protected void verifyBaseParams(GadgetsHandlerApi.BaseRequest request,
                    boolean checkUrl)
                         throws ProcessingException

Verify request parameter are defined.

Throws:

ProcessingException

getProxyExpireMs

protected Long getProxyExpireMs(ProxyUriManager.ProxyUri proxyUri,
                    HttpResponse httpResponse)

getDefaultExpiration

protected long getDefaultExpiration()

createErrorResponse

public GadgetsHandlerApi.BaseResponse createErrorResponse(Uri uri,
                                                 Exception e,
                                                 String defaultMsg)

createErrorResponse

public GadgetsHandlerApi.BaseResponse createErrorResponse(Uri url,
                                                 int code,
                                                 String error)

createJsUri

protected JsUriManager.JsUri createJsUri(GadgetsHandlerApi.JsRequest request)

createProxyUri

protected ProxyUriManager.ProxyUri createProxyUri(GadgetsHandlerApi.ProxyRequest request)