info.magnolia.resourceloader.classpath

Class ClasspathResourceOrigin

java.lang.Object

info.magnolia.resourceloader.AbstractResourceOrigin<ClasspathResource>

info.magnolia.resourceloader.classpath.ClasspathResourceOrigin

All Implemented Interfaces:

ResourceOrigin<ClasspathResource>

Direct Known Subclasses:

LegacyClasspathResourceOrigin

public class ClasspathResourceOrigin
extends AbstractResourceOrigin<ClasspathResource>

A ResourceOrigin which loads resources from the classpath.

Because the classpath does actually not know about folders but only about classes, this origin constructs a virtual folder/file structure of ClasspathResources.
For this to work the origin relies on the following assumptions:

• There is only one root path and it is "/"
• All paths begin with "/"
• Paths to folders never end with "/"
• File or folder names do not contain "/"

Nested Class Summary

Nested classes/interfaces inherited from interface info.magnolia.resourceloader.ResourceOrigin

ResourceOrigin.ResourceNotFoundException

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<URL>	classpathUrls()
protected void	collectResources()
protected ClasspathResource	createResourcesFor(String resourcePath)
protected InputStream	doOpenStream(ClasspathResource resource)
protected String[]	excludedPackages()
protected String[]	excludedResourcesExtensions()
protected String[]	excludedUrlExtensions()
protected String	extensionsPattern(String[] extensions)
ClasspathResource	getByPath(String path) Retrieves a Resource object based on the given path.
protected Charset	getCharsetFor(ClasspathResource resource) Returns the preferred Charset to read the given Resource.
protected long	getLastModified(ClasspathResource resource)
protected String	getName(ClasspathResource resource)
protected ClasspathResource	getParent(ClasspathResource resource)
protected String	getPath(ClasspathResource resource)
ClasspathResource	getRoot() Returns the Resource for this origin's declared root.
protected URL	getUrl(ClasspathResource resource)
boolean	hasPath(String path)
protected boolean	isDirectory(ClasspathResource resource)
protected boolean	isFile(ClasspathResource resource)
protected List<ClasspathResource>	listChildren(ClasspathResource resource)
protected ClasspathResource	newClasspathResource(String path, boolean isFile)
protected String	observedResourcesPattern()
protected com.google.common.base.Predicate<String>	resourcesFilter()
protected com.google.common.base.Predicate<? super URL>	urlsFilter()
protected String	validatePath(String resource) Verifies the given path is as-expected by this origin, and "prepares" it.
void	watchForChanges(ResourceVisitor visitor) Sets up observation for this origin, and hooks it to the given callback ResourceVisitor.

Methods inherited from class info.magnolia.resourceloader.AbstractResourceOrigin

getName, isEditable, openReader, openStream, traverseWith

Methods inherited from class java.lang.Object

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

Method Detail

getRoot

public ClasspathResource getRoot()

Description copied from interface: ResourceOrigin

Returns the Resource for this origin's declared root.

watchForChanges

public void watchForChanges(ResourceVisitor visitor)

Description copied from interface: ResourceOrigin

Sets up observation for this origin, and hooks it to the given callback ResourceVisitor.

See Also:

ResourceVisitor, PredicatedResourceVisitor

observedResourcesPattern

protected String observedResourcesPattern()

getByPath

public ClasspathResource getByPath(String path)

Description copied from interface: ResourceOrigin

Retrieves a Resource object based on the given path. The given path may or may not start with a leading /, but will always be considered relative to whatever root path this origin uses; for the user of this class, such paths should thus be considered absolute, depending on the implementation, they may be relative to some other path. Directory traversal navigation should be prohibited by implementations for security reasons.

hasPath

public boolean hasPath(String path)

isFile

protected boolean isFile(ClasspathResource resource)

Specified by:

isFile in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.isFile()

isDirectory

protected boolean isDirectory(ClasspathResource resource)

Specified by:

isDirectory in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.isDirectory()

getPath

protected String getPath(ClasspathResource resource)

Specified by:

getPath in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.getPath()

getName

protected String getName(ClasspathResource resource)

Specified by:

getName in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.getName()

getLastModified

protected long getLastModified(ClasspathResource resource)

Specified by:

getLastModified in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.getLastModified()

listChildren

protected List<ClasspathResource> listChildren(ClasspathResource resource)

Specified by:

listChildren in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.listChildren()

getParent

protected ClasspathResource getParent(ClasspathResource resource)

Specified by:

getParent in class AbstractResourceOrigin<ClasspathResource>

See Also:

Resource.getParent()

doOpenStream

protected InputStream doOpenStream(ClasspathResource resource)
                            throws IOException

Specified by:

doOpenStream in class AbstractResourceOrigin<ClasspathResource>

Throws:

IOException

getCharsetFor

protected Charset getCharsetFor(ClasspathResource resource)

Description copied from class: AbstractResourceOrigin

Returns the preferred Charset to read the given Resource.

Specified by:

getCharsetFor in class AbstractResourceOrigin<ClasspathResource>

getUrl

protected URL getUrl(ClasspathResource resource)

collectResources

protected void collectResources()

classpathUrls

protected Collection<URL> classpathUrls()

urlsFilter

protected com.google.common.base.Predicate<? super URL> urlsFilter()

resourcesFilter

protected com.google.common.base.Predicate<String> resourcesFilter()

extensionsPattern

protected String extensionsPattern(String[] extensions)

excludedUrlExtensions

protected String[] excludedUrlExtensions()

excludedResourcesExtensions

protected String[] excludedResourcesExtensions()

excludedPackages

protected String[] excludedPackages()

createResourcesFor

protected ClasspathResource createResourcesFor(String resourcePath)

newClasspathResource

protected ClasspathResource newClasspathResource(String path,
                                     boolean isFile)

validatePath

protected String validatePath(String resource)

Verifies the given path is as-expected by this origin, and "prepares" it.