org.apache.shindig.gadgets.uri

Class DefaultIframeUriManager

java.lang.Object

org.apache.shindig.gadgets.uri.DefaultIframeUriManager

All Implemented Interfaces:

IframeUriManager

public class DefaultIframeUriManager
extends Object
implements IframeUriManager

Default implementation of an IframeUriManager which references the /ifr endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultIframeUriManager.DefaultTemplatingSignal
static interface	DefaultIframeUriManager.TemplatingSignal

Nested classes/interfaces inherited from interface org.apache.shindig.gadgets.uri.IframeUriManager

IframeUriManager.Versioner

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCKED_DOMAIN_FEATURE_NAME
static String	LOCKED_DOMAIN_SUFFIX_KEY
static String	SECURITY_TOKEN_ALWAYS_KEY
static String	SECURITY_TOKEN_FEATURE_NAME
static String	UNLOCKED_DOMAIN_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultIframeUriManager(ContainerConfig config, LockedDomainService ldService, SecurityTokenCodec securityTokenCodec)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addAllUserPrefs(UriBuilder uri, Gadget gadget, View view, boolean useTpl)
protected void	addDefaultUriParameters(UriBuilder uri, Gadget gadget, View view, boolean useTpl)
protected void	addExtras(UriBuilder uri, Gadget gadget)
protected void	addExtrasForTypeUrl(UriBuilder uri, Gadget gadget, String container)
protected Uri	buildUri(View view, Gadget gadget)
protected String	generateSecurityToken(Gadget gadget)
protected String	getScheme(Gadget gadget, String container)
protected boolean	isTokenNeededForRendering(Gadget gadget)
Map<String,Uri>	makeAllRenderingUris(Gadget gadget) Returns a list of all URIs for rendering this gadget.
Uri	makeRenderingUri(Gadget gadget) Generates iframe urls for meta data service.
protected UriBuilder	processUriForHtmlTypeView(View view, Gadget gadget)
protected UriBuilder	processUriForUrlTypeView(View view, Gadget gadget)
void	setAuthority(Authority authority)
void	setTemplatingSignal(DefaultIframeUriManager.TemplatingSignal tplSignal)
void	setVersioner(IframeUriManager.Versioner versioner)
static String	tplKey(String key)
UriStatus	validateRenderingUri(Uri inUri) Validates the provided rendering Uri.
protected boolean	wantsSecurityToken(Gadget gadget)

Methods inherited from class java.lang.Object

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

Field Detail

LOCKED_DOMAIN_SUFFIX_KEY

public static final String LOCKED_DOMAIN_SUFFIX_KEY

See Also:

Constant Field Values

UNLOCKED_DOMAIN_KEY

public static final String UNLOCKED_DOMAIN_KEY

See Also:

Constant Field Values

SECURITY_TOKEN_ALWAYS_KEY

public static final String SECURITY_TOKEN_ALWAYS_KEY

See Also:

Constant Field Values

LOCKED_DOMAIN_FEATURE_NAME

public static final String LOCKED_DOMAIN_FEATURE_NAME

See Also:

Constant Field Values

SECURITY_TOKEN_FEATURE_NAME

public static final String SECURITY_TOKEN_FEATURE_NAME

See Also:

Constant Field Values

Constructor Detail

DefaultIframeUriManager

@Inject
public DefaultIframeUriManager(ContainerConfig config,
                              LockedDomainService ldService,
                              SecurityTokenCodec securityTokenCodec)

Method Detail

setVersioner

@Inject(optional=true)
public void setVersioner(IframeUriManager.Versioner versioner)

setTemplatingSignal

@Inject(optional=true)
public void setTemplatingSignal(DefaultIframeUriManager.TemplatingSignal tplSignal)

setAuthority

@Inject(optional=true)
public void setAuthority(Authority authority)

makeRenderingUri

public Uri makeRenderingUri(Gadget gadget)

Description copied from interface: IframeUriManager

Generates iframe urls for meta data service. Use this rather than generating your own urls by hand.

Specified by:

makeRenderingUri in interface IframeUriManager

Returns:

The generated iframe url.

buildUri

protected Uri buildUri(View view,
           Gadget gadget)

processUriForUrlTypeView

protected UriBuilder processUriForUrlTypeView(View view,
                                  Gadget gadget)

processUriForHtmlTypeView

protected UriBuilder processUriForHtmlTypeView(View view,
                                   Gadget gadget)

addDefaultUriParameters

protected void addDefaultUriParameters(UriBuilder uri,
                           Gadget gadget,
                           View view,
                           boolean useTpl)

addAllUserPrefs

protected void addAllUserPrefs(UriBuilder uri,
                   Gadget gadget,
                   View view,
                   boolean useTpl)

generateSecurityToken

protected String generateSecurityToken(Gadget gadget)

wantsSecurityToken

protected boolean wantsSecurityToken(Gadget gadget)

isTokenNeededForRendering

protected boolean isTokenNeededForRendering(Gadget gadget)

validateRenderingUri

public UriStatus validateRenderingUri(Uri inUri)

Description copied from interface: IframeUriManager

Validates the provided rendering Uri. May include locked-domain, version param, and/or other checks.

Specified by:

validateRenderingUri in interface IframeUriManager

tplKey

public static String tplKey(String key)

getScheme

protected String getScheme(Gadget gadget,
               String container)

addExtrasForTypeUrl

protected void addExtrasForTypeUrl(UriBuilder uri,
                       Gadget gadget,
                       String container)

addExtras

protected void addExtras(UriBuilder uri,
             Gadget gadget)

makeAllRenderingUris

public Map<String,Uri> makeAllRenderingUris(Gadget gadget)

Returns a list of all URIs for rendering this gadget. The map is keyed by the view name.

Specified by:

makeAllRenderingUris in interface IframeUriManager

Parameters:

gadget - The gadget to generate the URIs for.

Returns:

A map of URIs indexed by the view name.