org.apache.shindig.gadgets.uri

Interface IframeUriManager

All Known Implementing Classes:

DefaultIframeUriManager

public interface IframeUriManager

Interface defining methods needed to generate iframe URL for the /ifr servlet.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IframeUriManager.Versioner

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Uri>	makeAllRenderingUris(Gadget gadget) Generates iframe uris for all views in the gadget.
Uri	makeRenderingUri(Gadget gadget) Generates iframe urls for meta data service.
UriStatus	validateRenderingUri(Uri uri) Validates the provided rendering Uri.

Method Detail

makeRenderingUri

Uri makeRenderingUri(Gadget gadget)

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

Returns:

The generated iframe url.

makeAllRenderingUris

Map<String,Uri> makeAllRenderingUris(Gadget gadget)

Generates iframe uris for all views in the gadget.

Parameters:

gadget - The gadget to generate the URI for.

Returns:

A map of views to iframe uris.

validateRenderingUri

UriStatus validateRenderingUri(Uri uri)

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