info.magnolia.resourceloader

Interface ResourceOrigin<P extends Resource>

Type Parameters:

P - the type of Resource this implementation of ResourceOrigin produces.

All Known Implementing Classes:

AbstractResourceOrigin, ClasspathResourceOrigin, FileSystemResourceOrigin, JcrResourceOrigin, LayeredResourceOrigin, LegacyClasspathResourceOrigin

public interface ResourceOrigin<P extends Resource>

Common interface for all resource file origins (e.g. file-system, classpath, JCR).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ResourceOrigin.ResourceNotFoundException Thrown when a given path can't be found.

Method Summary

Modifier and Type	Method and Description
P	getByPath(String path) Retrieves a Resource object based on the given path.
String	getName() Returns the name of this origin.
P	getRoot() Returns the Resource for this origin's declared root.
boolean	hasPath(String path)
ResourceChangeHandlerRegistration	registerResourceChangeHandler(ResourceChangeHandler changeHandler) Hook the underlying resource change monitoring mechanism (if any) to a provided handler.
void	traverseWith(ResourceVisitor visitor) Traverses this ResourceOrigin from the root, according to the given ResourceVisitor.
void	watchForChanges(ResourceVisitor visitor) Deprecated. since 5.4.6 - use registerResourceChangeHandler(ResourceChangeHandler) instead. Current method is less preferable to be used for resource changes monitoring because ResourceVisitor is not a suitable interface to communicate such changes. E.g. ResourceVisitor has no API to provide the context of the change (which ResourceOrigin the change has happened at, what was the type of the change etc). Also ResourceVisitor requires an instance of Resource - it is not usable to communicate deletion of resources.

Method Detail

getName

String getName()

Returns the name of this origin. This may be used to describe/differentiate origin instances, and generate i18n keys accordingly.

getRoot

P getRoot()

Returns the Resource for this origin's declared root.

traverseWith

void traverseWith(ResourceVisitor visitor)

Traverses this ResourceOrigin from the root, according to the given ResourceVisitor.

See Also:

ResourceVisitor, PredicatedResourceVisitor, ResourceTreeWalker

watchForChanges

@Deprecated
void watchForChanges(ResourceVisitor visitor)

Deprecated. since 5.4.6 - use registerResourceChangeHandler(ResourceChangeHandler) instead. Current method is less preferable to be used for resource changes monitoring because ResourceVisitor is not a suitable interface to communicate such changes. E.g. ResourceVisitor has no API to provide the context of the change (which ResourceOrigin the change has happened at, what was the type of the change etc). Also ResourceVisitor requires an instance of Resource - it is not usable to communicate deletion of resources.

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

See Also:

ResourceVisitor, PredicatedResourceVisitor

registerResourceChangeHandler

ResourceChangeHandlerRegistration registerResourceChangeHandler(ResourceChangeHandler changeHandler)

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

See Also:

ResourceOriginChange

getByPath

P getByPath(String path)

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.

Throws:

ResourceOrigin.ResourceNotFoundException - if the path does not exist in this ResourceOrigin

hasPath

boolean hasPath(String path)