info.magnolia.resourceloader.layered

Class LayeredResourceOrigin

java.lang.Object

info.magnolia.resourceloader.AbstractResourceOrigin<LayeredResource>

info.magnolia.resourceloader.layered.LayeredResourceOrigin

All Implemented Interfaces:

ResourceOrigin<LayeredResource>

public class LayeredResourceOrigin
extends AbstractResourceOrigin<LayeredResource>

An implementation of ResourceOrigin which aggregates other instances of ResourceOrigin; resources located on the same path will be served from the foremost ResourceOrigin, but resources that exist only on one path will always be served.

Nested Class Summary

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

ResourceOrigin.ResourceNotFoundException

Method Summary

Modifier and Type	Method and Description
protected InputStream	doOpenStream(LayeredResource resource)
LayeredResource	getByPath(String path) Retrieves a Resource object based on the given path.
protected Charset	getCharsetFor(LayeredResource resource) Overridden to throw an exception; since we override openReader(LayeredResource), this method used in AbstractResourceOrigin.openReader(info.magnolia.resourceloader.AbstractResource) should never be called.
protected long	getLastModified(LayeredResource resource)
protected String	getName(LayeredResource resource)
protected LayeredResource	getParent(LayeredResource resource)
protected String	getPath(LayeredResource resource)
LayeredResource	getRoot() Returns the Resource for this origin's declared root.
boolean	hasPath(String path)
protected boolean	isDirectory(LayeredResource resource)
protected boolean	isEditable(LayeredResource resource)
protected boolean	isFile(LayeredResource resource)
protected List<LayeredResource>	listChildren(LayeredResource resource)
protected LayeredResource	newLayeredResource(List<Resource> resources)
protected Reader	openReader(LayeredResource resource)
ResourceChangeHandlerRegistration	registerResourceChangeHandler(ResourceChangeHandler changeHandler) Hook the underlying resource change monitoring mechanism (if any) to a provided handler.

Methods inherited from class info.magnolia.resourceloader.AbstractResourceOrigin

dispatchResourceChange, getName, initializeResourceChangeMonitoring, openStream, traverseWith, watchForChanges

Methods inherited from class java.lang.Object

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

Method Detail

getRoot

public LayeredResource getRoot()

Description copied from interface: ResourceOrigin

Returns the Resource for this origin's declared root.

registerResourceChangeHandler

public ResourceChangeHandlerRegistration registerResourceChangeHandler(ResourceChangeHandler changeHandler)

Description copied from interface: ResourceOrigin

Hook the underlying resource change monitoring mechanism (if any) to a provided handler.

Specified by:

registerResourceChangeHandler in interface ResourceOrigin<LayeredResource>

Overrides:

registerResourceChangeHandler in class AbstractResourceOrigin<LayeredResource>

See Also:

ResourceOriginChange

getByPath

public LayeredResource 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(LayeredResource resource)

Specified by:

isFile in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.isFile()

isDirectory

protected boolean isDirectory(LayeredResource resource)

Specified by:

isDirectory in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.isDirectory()

isEditable

protected boolean isEditable(LayeredResource resource)

Overrides:

isEditable in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.isEditable()

getPath

protected String getPath(LayeredResource resource)

Specified by:

getPath in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.getPath()

getName

protected String getName(LayeredResource resource)

Specified by:

getName in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.getName()

getLastModified

protected long getLastModified(LayeredResource resource)

Specified by:

getLastModified in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.getLastModified()

listChildren

protected List<LayeredResource> listChildren(LayeredResource resource)

Specified by:

listChildren in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.listChildren()

getParent

protected LayeredResource getParent(LayeredResource resource)

Specified by:

getParent in class AbstractResourceOrigin<LayeredResource>

See Also:

Resource.getParent()

doOpenStream

protected InputStream doOpenStream(LayeredResource resource)
                            throws IOException

Specified by:

doOpenStream in class AbstractResourceOrigin<LayeredResource>

Throws:

IOException

openReader

protected Reader openReader(LayeredResource resource)
                     throws IOException

Overrides:

openReader in class AbstractResourceOrigin<LayeredResource>

Throws:

IOException

See Also:

Resource.openReader()

getCharsetFor

protected Charset getCharsetFor(LayeredResource resource)

Overridden to throw an exception; since we override openReader(LayeredResource), this method used in AbstractResourceOrigin.openReader(info.magnolia.resourceloader.AbstractResource) should never be called.

Specified by:

getCharsetFor in class AbstractResourceOrigin<LayeredResource>

newLayeredResource

protected LayeredResource newLayeredResource(List<Resource> resources)