org.apache.shindig.gadgets.features

Class FeatureResourceLoader

java.lang.Object

org.apache.shindig.gadgets.features.FeatureResourceLoader

Direct Known Subclasses:

BrowserSpecificFeatureResource.Loader

public class FeatureResourceLoader
extends Object

Class that loads FeatureResource objects used to populate JS feature code.

Constructor Summary

Constructors

Constructor and Description
FeatureResourceLoader(HttpFetcher fetcher, TimeSource timeSource, FeatureFileSystem fileSystem)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	fileHasChanged(FeatureFile file, long lastModified)
protected String	getFileContent(FeatureFile file)
protected String	getOptPath(String orig)
String	getResourceContent(String resource)
FeatureResource	load(Uri uri, Map<String,String> attribs) Primary, and only public, method of FeatureResourceLoader.
protected FeatureResource	loadFile(String path, Map<String,String> attribs)
protected FeatureResource	loadResource(String path, Map<String,String> attribs)
protected FeatureResource	loadUri(Uri uri, Map<String,String> attribs)
void	setSupportFileUpdates(int updateCheckFrequency)

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureResourceLoader

@Inject
public FeatureResourceLoader(HttpFetcher fetcher,
                            TimeSource timeSource,
                            FeatureFileSystem fileSystem)

Method Detail

setSupportFileUpdates

@Inject(optional=true)
public void setSupportFileUpdates(int updateCheckFrequency)

load

public FeatureResource load(Uri uri,
                   Map<String,String> attribs)
                     throws GadgetException

Primary, and only public, method of FeatureResourceLoader. Loads the resource keyed at the given uri, which was decorated with the provided list of attributes. The default implementation loads both file and res-schema resources using ResourceLoader, attempting to load optimized content for files named [file].js as [file].opt.js. Override this method to provide custom functionality. Basic loadFile, loadResource, and loadUri methods are kept protected for easy reuse.

Parameters:

uri - Uri of resource to be loaded.

attribs - Attributes decorating the resource in the corresponding feature.xml

Returns:

FeatureResource object providing content and debugContent loading capability.

Throws:

GadgetException - If any failure occurs during this process.

loadFile

protected FeatureResource loadFile(String path,
                       Map<String,String> attribs)
                            throws IOException

Throws:

IOException

getFileContent

protected String getFileContent(FeatureFile file)

loadResource

protected FeatureResource loadResource(String path,
                           Map<String,String> attribs)
                                throws IOException

Throws:

IOException

getResourceContent

public String getResourceContent(String resource)
                          throws IOException

Throws:

IOException

loadUri

protected FeatureResource loadUri(Uri uri,
                      Map<String,String> attribs)
                           throws IOException

Throws:

IOException - if failed to load uri (by derived classes)

getOptPath

protected String getOptPath(String orig)

fileHasChanged

protected boolean fileHasChanged(FeatureFile file,
                     long lastModified)