org.apache.shindig.gadgets.uri

Class ProxyUriManager.ProxyUri

java.lang.Object

org.apache.shindig.gadgets.uri.ProxyUriBase

org.apache.shindig.gadgets.uri.ProxyUriManager.ProxyUri

Enclosing interface:

ProxyUriManager

public static class ProxyUriManager.ProxyUri
extends ProxyUriBase

Field Summary

Fields inherited from class org.apache.shindig.gadgets.uri.ProxyUriBase

extensionParams

Constructor Summary

Constructors

Constructor and Description
ProxyUriManager.ProxyUri(Gadget gadget, Uri resource)
ProxyUriManager.ProxyUri(Integer refresh, boolean debug, boolean noCache, String container, String gadget, Uri resource)
ProxyUriManager.ProxyUri(UriStatus status, Uri resource, Uri base)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static List<ProxyUriManager.ProxyUri>	fromList(Gadget gadget, List<Uri> uris)
AuthType	getAuthType()
Uri	getFallbackUri()
String	getHtmlTagContext()
OAuth2Arguments	getOAuth2Arguments()
OAuthArguments	getOAuthArguments()
Uri	getResource()
SecurityToken	getSecurityToken()
String	getUserAgent()
int	hashCode()
HttpRequest	makeHttpRequest(Uri targetUri)
UriBuilder	makeQueryParams(Integer forcedRefresh, String version) Construct the query parameters for proxy url
ProxyUriManager.ProxyUri	setAuthType(AuthType authType)
ProxyUriManager.ProxyUri	setFallbackUrl(String fallbackUrl)
void	setFromUri(Uri uri) Parse uri query paramaters.
void	setHtmlTagContext(String htmlTagContext)
ProxyUriManager.ProxyUri	setOAuth2Arguments(OAuth2Arguments oauth2Arguments)
ProxyUriManager.ProxyUri	setOAuthArguments(OAuthArguments oauthArgments)
ProxyUriManager.ProxyUri	setResize(Integer w, Integer h, Integer q, boolean noExpand)
void	setReturnOriginalContentOnError(boolean returnOriginalContentOnError)
ProxyUriManager.ProxyUri	setSecurityToken(SecurityToken securityToken)
void	setUserAgent(String ua)
boolean	shouldReturnOrigOnErr()

Methods inherited from class org.apache.shindig.gadgets.uri.ProxyUriBase

cajoleContent, getBooleanValue, getContainer, getExtensionParam, getExtensionParams, getGadget, getIntegerValue, getRefresh, getRewriteMimeType, getStatus, getTruthyValue, isDebug, isNoCache, sanitizeContent, setCajoleContent, setExtensionParam, setExtensionParams, setGadget, setRewriteMimeType, setSanitizeContent, translateStatusRefresh

Methods inherited from class java.lang.Object

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

Constructor Detail

ProxyUriManager.ProxyUri

public ProxyUriManager.ProxyUri(Gadget gadget,
                        Uri resource)

ProxyUriManager.ProxyUri

public ProxyUriManager.ProxyUri(Integer refresh,
                        boolean debug,
                        boolean noCache,
                        String container,
                        String gadget,
                        Uri resource)

ProxyUriManager.ProxyUri

public ProxyUriManager.ProxyUri(UriStatus status,
                        Uri resource,
                        Uri base)

Method Detail

setReturnOriginalContentOnError

public void setReturnOriginalContentOnError(boolean returnOriginalContentOnError)

setUserAgent

public void setUserAgent(String ua)

getUserAgent

public String getUserAgent()

setHtmlTagContext

public void setHtmlTagContext(String htmlTagContext)

getHtmlTagContext

public String getHtmlTagContext()

getSecurityToken

public SecurityToken getSecurityToken()

getAuthType

public AuthType getAuthType()

getOAuthArguments

public OAuthArguments getOAuthArguments()

getOAuth2Arguments

public OAuth2Arguments getOAuth2Arguments()

equals

public boolean equals(Object obj)

Overrides:

equals in class ProxyUriBase

hashCode

public int hashCode()

Overrides:

hashCode in class ProxyUriBase

setFromUri

public void setFromUri(Uri uri)

Description copied from class: ProxyUriBase

Parse uri query paramaters. Note this function is called by a constructor, and can be override to handle derived class parsing

Overrides:

setFromUri in class ProxyUriBase

setResize

public ProxyUriManager.ProxyUri setResize(Integer w,
                                 Integer h,
                                 Integer q,
                                 boolean noExpand)

setFallbackUrl

public ProxyUriManager.ProxyUri setFallbackUrl(String fallbackUrl)

setSecurityToken

public ProxyUriManager.ProxyUri setSecurityToken(SecurityToken securityToken)

setAuthType

public ProxyUriManager.ProxyUri setAuthType(AuthType authType)

setOAuthArguments

public ProxyUriManager.ProxyUri setOAuthArguments(OAuthArguments oauthArgments)

setOAuth2Arguments

public ProxyUriManager.ProxyUri setOAuth2Arguments(OAuth2Arguments oauth2Arguments)

getResource

public Uri getResource()

getFallbackUri

public Uri getFallbackUri()
                   throws GadgetException

Throws:

GadgetException

shouldReturnOrigOnErr

public boolean shouldReturnOrigOnErr()

makeQueryParams

public UriBuilder makeQueryParams(Integer forcedRefresh,
                         String version)

Description copied from class: ProxyUriBase

Construct the query parameters for proxy url

Overrides:

makeQueryParams in class ProxyUriBase

Parameters:

forcedRefresh - optional overwrite the refresh time

version - optional version

Returns:

Url with only query parameters set

makeHttpRequest

public HttpRequest makeHttpRequest(Uri targetUri)
                            throws GadgetException

Overrides:

makeHttpRequest in class ProxyUriBase

Throws:

GadgetException

fromList

public static List<ProxyUriManager.ProxyUri> fromList(Gadget gadget,
                                      List<Uri> uris)