info.magnolia.resourceloader.jcr

Class JcrResourceOrigin

java.lang.Object

info.magnolia.resourceloader.AbstractResourceOrigin<JcrResource>

info.magnolia.resourceloader.jcr.JcrResourceOrigin

All Implemented Interfaces:

ResourceOrigin<JcrResource>

public class JcrResourceOrigin
extends AbstractResourceOrigin<JcrResource>

A ResourceOrigin which loads resources from JCR.

Nested Class Summary

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

ResourceOrigin.ResourceNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
static String	BINARY_NODE_NAME
static String	BYPASS_PROPERTY
static String	RESOURCES_WORKSPACE
static String	TEXT_PROPERTY

Method Summary

Methods

Modifier and Type	Method and Description
protected InputStream	doOpenStream(JcrResource resource)
protected javax.jcr.Binary	getBinary(javax.jcr.Node resourceNode)
JcrResource	getByPath(String path) Retrieves a Resource object based on the given path.
protected Charset	getCharsetFor(JcrResource resource) Returns the preferred Charset to read the given Resource.
protected javax.jcr.Session	getJcrSession()
protected long	getLastModified(JcrResource resource)
protected String	getName(JcrResource resource)
protected JcrResource	getParent(JcrResource resource)
protected String	getPath(JcrResource resource)
JcrResource	getRoot() Returns the Resource for this origin's declared root.
boolean	hasPath(String path)
protected boolean	isBinaryResource(javax.jcr.Node node)
protected boolean	isBypassed(javax.jcr.Node node)
protected boolean	isDirectory(JcrResource resource)
protected boolean	isDirectory(javax.jcr.Node node)
protected boolean	isEditable(JcrResource resource)
protected boolean	isFile(JcrResource resource)
protected boolean	isFile(javax.jcr.Node node)
protected boolean	isResource(javax.jcr.Node node)
protected boolean	isTextResource(javax.jcr.Node resourceNode)
protected List<JcrResource>	listChildren(JcrResource resource)
protected JcrResource	newResource(javax.jcr.Node node)
protected Reader	openReader(JcrResource resource)
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, openStream, traverseWith

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCES_WORKSPACE

public static final String RESOURCES_WORKSPACE

See Also:

Constant Field Values

BINARY_NODE_NAME

public static final String BINARY_NODE_NAME

See Also:

Constant Field Values

TEXT_PROPERTY

public static final String TEXT_PROPERTY

See Also:

Constant Field Values

BYPASS_PROPERTY

public static final String BYPASS_PROPERTY

See Also:

Constant Field Values

Method Detail

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

getRoot

public JcrResource getRoot()

Description copied from interface: ResourceOrigin

Returns the Resource for this origin's declared root.

getByPath

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

Specified by:

isFile in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.isFile()

isDirectory

protected boolean isDirectory(JcrResource resource)

Specified by:

isDirectory in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.isDirectory()

isEditable

protected boolean isEditable(JcrResource resource)

Overrides:

isEditable in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.isEditable()

getPath

protected String getPath(JcrResource resource)

Specified by:

getPath in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.getPath()

getName

protected String getName(JcrResource resource)

Specified by:

getName in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.getName()

getLastModified

protected long getLastModified(JcrResource resource)

Specified by:

getLastModified in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.getLastModified()

listChildren

protected List<JcrResource> listChildren(JcrResource resource)

Specified by:

listChildren in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.listChildren()

getParent

protected JcrResource getParent(JcrResource resource)

Specified by:

getParent in class AbstractResourceOrigin<JcrResource>

See Also:

Resource.getParent()

openReader

protected Reader openReader(JcrResource resource)
                     throws IOException

Overrides:

openReader in class AbstractResourceOrigin<JcrResource>

Throws:

IOException

See Also:

Resource.openReader()

doOpenStream

protected InputStream doOpenStream(JcrResource resource)

Specified by:

doOpenStream in class AbstractResourceOrigin<JcrResource>

getCharsetFor

protected Charset getCharsetFor(JcrResource resource)

Description copied from class: AbstractResourceOrigin

Returns the preferred Charset to read the given Resource.

Specified by:

getCharsetFor in class AbstractResourceOrigin<JcrResource>

newResource

protected JcrResource newResource(javax.jcr.Node node)

getJcrSession

protected javax.jcr.Session getJcrSession()
                                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isResource

protected boolean isResource(javax.jcr.Node node)
                      throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getBinary

protected javax.jcr.Binary getBinary(javax.jcr.Node resourceNode)
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isTextResource

protected boolean isTextResource(javax.jcr.Node resourceNode)
                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isBinaryResource

protected boolean isBinaryResource(javax.jcr.Node node)
                            throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isFile

protected boolean isFile(javax.jcr.Node node)
                  throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isDirectory

protected boolean isDirectory(javax.jcr.Node node)
                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isBypassed

protected boolean isBypassed(javax.jcr.Node node)