info.magnolia.resourceloader.file

Class FileSystemResourceOrigin

java.lang.Object

info.magnolia.resourceloader.AbstractResourceOrigin<FileSystemResource>

info.magnolia.resourceloader.file.FileSystemResourceOrigin

All Implemented Interfaces:

ResourceOrigin<FileSystemResource>

public class FileSystemResourceOrigin
extends AbstractResourceOrigin<FileSystemResource>

A ResourceOrigin which loads resources on the file system.

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	RESOURCES_DIR_PROPERTY

Method Summary

Modifier and Type	Method and Description
protected ExclusionsFilter	buildExclusionsFilter() Builds exclusion filter, if present uses magnolia.resources.filesystem.observation.excludedDirectories property for defining excluded root directories.
protected InputStream	doOpenStream(FileSystemResource resource)
protected boolean	existsAndAllowed(Path filePath)
FileSystemResource	getByPath(String path) Retrieves a Resource object based on the given path.
protected Charset	getCharsetFor(FileSystemResource resource) Returns the preferred Charset to read the given Resource.
protected long	getLastModified(FileSystemResource resource)
protected String	getName(FileSystemResource resource)
protected FileSystemResource	getParent(FileSystemResource resource)
protected String	getPath(FileSystemResource resource)
protected Path	getPath(String path)
FileSystemResource	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(FileSystemResource resource)
protected boolean	isFile(FileSystemResource resource)
protected List<FileSystemResource>	listChildren(FileSystemResource resource)
protected FileSystemResource	newResource(Path path) Create a Resource out of a relative path.
String	parseResourcePath(Path realPath) Relativize a real path against this origin's root path and normalize it.
protected Path	validateRootPath(String path)

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

Field Detail

RESOURCES_DIR_PROPERTY

public static final String RESOURCES_DIR_PROPERTY

See Also:

Constant Field Values

Method Detail

buildExclusionsFilter

protected ExclusionsFilter buildExclusionsFilter()

Builds exclusion filter, if present uses magnolia.resources.filesystem.observation.excludedDirectories property for defining excluded root directories. Otherwise falls back to default list of excluded directories.

getRoot

public FileSystemResource getRoot()

Description copied from interface: ResourceOrigin

Returns the Resource for this origin's declared root.

getByPath

public FileSystemResource 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)

initializeResourceChangeMonitoring

protected void initializeResourceChangeMonitoring()

Description copied from class: AbstractResourceOrigin

Start monitoring underlying resource changes.

Overrides:

initializeResourceChangeMonitoring in class AbstractResourceOrigin<FileSystemResource>

isFile

protected boolean isFile(FileSystemResource resource)

Specified by:

isFile in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.isFile()

isDirectory

protected boolean isDirectory(FileSystemResource resource)

Specified by:

isDirectory in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.isDirectory()

getPath

protected String getPath(FileSystemResource resource)

Specified by:

getPath in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.getPath()

parseResourcePath

public String parseResourcePath(Path realPath)

Relativize a real path against this origin's root path and normalize it.

Parameters:

realPath - path in file system

Returns:

corresponding string path to the resource in this origin

getName

protected String getName(FileSystemResource resource)

Specified by:

getName in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.getName()

getLastModified

protected long getLastModified(FileSystemResource resource)

Specified by:

getLastModified in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.getLastModified()

listChildren

protected List<FileSystemResource> listChildren(FileSystemResource resource)

Specified by:

listChildren in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.listChildren()

getParent

protected FileSystemResource getParent(FileSystemResource resource)

Specified by:

getParent in class AbstractResourceOrigin<FileSystemResource>

See Also:

Resource.getParent()

doOpenStream

protected InputStream doOpenStream(FileSystemResource resource)
                            throws IOException

Specified by:

doOpenStream in class AbstractResourceOrigin<FileSystemResource>

Throws:

IOException

getCharsetFor

protected Charset getCharsetFor(FileSystemResource resource)

Description copied from class: AbstractResourceOrigin

Returns the preferred Charset to read the given Resource.

Specified by:

getCharsetFor in class AbstractResourceOrigin<FileSystemResource>

validateRootPath

protected Path validateRootPath(String path)

getPath

protected Path getPath(String path)

existsAndAllowed

protected boolean existsAndAllowed(Path filePath)

newResource

protected FileSystemResource newResource(Path path)

Create a Resource out of a relative path.

Parameters:

path - expected to be a relative path under the rootPath