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 serves resources collected from the web application classpath. Classpath file/folder hierarchy is provided by the classpath service which also acts as a delegate for most of this origin's calls.

See Also:

ClasspathService, ClasspathResource

Nested Class Summary

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

ResourceOrigin.ResourceNotFoundException

Constructor Summary

Constructors

Constructor and Description
ClasspathResourceOrigin(String name, ClasspathService classpathService)

Method Summary

Modifier and Type	Method and Description
protected InputStream	doOpenStream(ClasspathResource resource)
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.
boolean	hasPath(String path)
protected void	initializeResourceChangeMonitoring() Start monitoring underlying resource changes.
protected boolean	isDirectory(ClasspathResource resource)
protected boolean	isFile(ClasspathResource resource)
protected List<ClasspathResource>	listChildren(ClasspathResource resource)

Methods inherited from class info.magnolia.resourceloader.AbstractResourceOrigin

dispatchResourceChange, getName, isEditable, openReader, openStream, registerResourceChangeHandler, traverseWith, watchForChanges

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathResourceOrigin

public ClasspathResourceOrigin(String name,
                               ClasspathService classpathService)

Method Detail

initializeResourceChangeMonitoring

protected void initializeResourceChangeMonitoring()

Description copied from class: AbstractResourceOrigin

Start monitoring underlying resource changes.

Overrides:

initializeResourceChangeMonitoring in class AbstractResourceOrigin<ClasspathResource>

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>

getRoot

public ClasspathResource getRoot()

Description copied from interface: ResourceOrigin

Returns the Resource for this origin's declared root.

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)