org.apache.shindig.gadgets.uri

Class ProxyUriBase

java.lang.Object

org.apache.shindig.gadgets.uri.ProxyUriBase

Direct Known Subclasses:

ConcatUriManager.ConcatUri, JsUriManager.JsUri, ProxyUriManager.ProxyUri

public class ProxyUriBase
extends Object

Represents state/config information for the proxy.

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	extensionParams Extension parameters to support implementation specific flags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProxyUriBase(Gadget gadget)
protected	ProxyUriBase(UriStatus status, Integer refresh, boolean debug, boolean noCache, String container, String gadget)
protected	ProxyUriBase(UriStatus status, Uri origUri)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cajoleContent()
boolean	equals(Object obj)
protected static boolean	getBooleanValue(String str)
String	getContainer()
String	getExtensionParam(String key)
Map<String,String>	getExtensionParams()
String	getGadget()
protected static Integer	getIntegerValue(String str)
Integer	getRefresh()
String	getRewriteMimeType()
UriStatus	getStatus()
protected static boolean	getTruthyValue(String str)
int	hashCode()
boolean	isDebug()
boolean	isNoCache()
HttpRequest	makeHttpRequest(Uri targetUri)
UriBuilder	makeQueryParams(Integer forcedRefresh, String version) Construct the query parameters for proxy url
boolean	sanitizeContent()
ProxyUriBase	setCajoleContent(boolean cajole)
void	setExtensionParam(String key, String val)
ProxyUriBase	setExtensionParams(Map<String,String> extensionParams)
void	setFromUri(Uri uri) Parse uri query paramaters.
ProxyUriBase	setGadget(String gadget)
ProxyUriBase	setRewriteMimeType(String type)
ProxyUriBase	setSanitizeContent(boolean sanitize)
Integer	translateStatusRefresh(int longVal, int originalResourceTtl) Calculate cache time for a resource url.

Methods inherited from class java.lang.Object

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

Field Detail

extensionParams

protected Map<String,String> extensionParams

Extension parameters to support implementation specific flags

Constructor Detail

ProxyUriBase

protected ProxyUriBase(Gadget gadget)

ProxyUriBase

protected ProxyUriBase(UriStatus status,
            Uri origUri)

ProxyUriBase

protected ProxyUriBase(UriStatus status,
            Integer refresh,
            boolean debug,
            boolean noCache,
            String container,
            String gadget)

Method Detail

setFromUri

public void setFromUri(Uri uri)

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

getTruthyValue

protected static boolean getTruthyValue(String str)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setRewriteMimeType

public ProxyUriBase setRewriteMimeType(String type)

setSanitizeContent

public ProxyUriBase setSanitizeContent(boolean sanitize)

setCajoleContent

public ProxyUriBase setCajoleContent(boolean cajole)

setGadget

public ProxyUriBase setGadget(String gadget)

getStatus

public UriStatus getStatus()

getRefresh

public Integer getRefresh()

isDebug

public boolean isDebug()

isNoCache

public boolean isNoCache()

getContainer

public String getContainer()

getGadget

public String getGadget()

getRewriteMimeType

public String getRewriteMimeType()

sanitizeContent

public boolean sanitizeContent()

cajoleContent

public boolean cajoleContent()

setExtensionParam

public void setExtensionParam(String key,
                     String val)

getExtensionParam

public String getExtensionParam(String key)

setExtensionParams

public ProxyUriBase setExtensionParams(Map<String,String> extensionParams)

getExtensionParams

public Map<String,String> getExtensionParams()

makeHttpRequest

public HttpRequest makeHttpRequest(Uri targetUri)
                            throws GadgetException

Throws:

GadgetException

makeQueryParams

public UriBuilder makeQueryParams(Integer forcedRefresh,
                         String version)

Construct the query parameters for proxy url

Parameters:

forcedRefresh - optional overwrite the refresh time

version - optional version

Returns:

Url with only query parameters set

translateStatusRefresh

public Integer translateStatusRefresh(int longVal,
                             int originalResourceTtl)
                               throws GadgetException

Calculate cache time for a resource url. Provide long period for versioned resource, use original value for unversioned resource, and no cache for invalid versions. Invalid version can happen in multiple instances environemnt where the url can be created on one server and the actually retreival is done on another that have an older version of resource in cache. In that case no caching will cause the user browser to try again next time and hopefully getting the newer version.

Parameters:

longVal - long expiry for versioned resource

originalResourceTtl - original resource ttl, to be served fro unversion resource

Returns:

the calculated expiry to the Uri according to status

Throws:

GadgetException

getBooleanValue

protected static boolean getBooleanValue(String str)

getIntegerValue

protected static Integer getIntegerValue(String str)