Modifier and Type	Class and Description
public static class	PathResourceManager.Builder
public static interface	PathResourceManager.ETagFunction
private static class	PathResourceManager.SymlinkResult

Field Summary

Modifier and Type	Field and Description
private final boolean	allowResourceChangeListeners
protected volatile String	base
private final boolean	caseSensitive Check to validate caseSensitive issues for specific case-insensitive FS.
private static final boolean	DEFAULT_CHANGE_LISTENERS_ALLOWED
private static final long	DEFAULT_TRANSFER_MIN_SIZE
private final PathResourceManager.ETagFunction	eTagFunction
protected volatile FileSystem	fileSystem
private FileSystemWatcher	fileSystemWatcher
private final boolean	followLinks Check to allow follow symbolic links
private final List<ResourceChangeListener>	listeners
private static final Logger	log
private static final PathResourceManager.ETagFunction	NULL_ETAG_FUNCTION
private final TreeSet<String>	safePaths Used if followLinks == true.
private final long	transferMinSize Size to use direct FS to network transfer (if supported by OS/JDK) instead of read/write

Constructor Summary

Access	Constructor and Description
public	PathResourceManager(final Path base)
public	PathResourceManager(final Path base, long transferMinSize)
public	PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive)
public	PathResourceManager(final Path base, long transferMinSize, boolean followLinks, final String... safePaths)
protected	PathResourceManager(long transferMinSize, boolean caseSensitive, boolean followLinks, final String... safePaths)
protected	PathResourceManager(long transferMinSize, boolean caseSensitive, boolean followLinks, boolean allowResourceChangeListeners, final String... safePaths)
public	PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive, boolean followLinks, final String... safePaths)
public	PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive, boolean followLinks, boolean allowResourceChangeListeners, final String... safePaths)
private	PathResourceManager(PathResourceManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
public static PathResourceManager.Builder	builder()
public synchronized void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public Path	getBasePath()
protected PathResource	getFileResource(final Path file, final String path, final Path symlinkBase, String normalizedFile) Apply security check for case insensitive file systems.
public Resource	getResource(final String The path p) Implements io.undertow.server.handlers.resource.ResourceManager.getResource. Returns a resource for the given path.
private PathResourceManager.SymlinkResult	getSymlinkBase(final String base, final Path file) Returns true is some element of path inside base path is a symlink.
public long	getTransferMinSize()
private boolean	isFileSameCase(final Path file, String normalizeFile) Security check for case insensitive file systems.
public boolean	isResourceChangeListenerSupported() Implements io.undertow.server.handlers.resource.ResourceManager.isResourceChangeListenerSupported.
private boolean	isSymlinkSafe(final Path file) Security check for followSymlinks feature.
public synchronized void	registerResourceChangeListener(ResourceChangeListener The listener to register listener) Implements io.undertow.server.handlers.resource.ResourceManager.registerResourceChangeListener. Registers a resource change listener, if the underlying resource manager support it
public synchronized void	removeResourceChangeListener(ResourceChangeListener listener) Implements io.undertow.server.handlers.resource.ResourceManager.removeResourceChangeListener. Removes a resource change listener
public PathResourceManager	setBase(final Path base)
public PathResourceManager	setBase(final File base)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowResourceChangeListeners	back to summary
private final boolean allowResourceChangeListeners

base	back to summary
protected volatile String base

caseSensitive back to summary

caseSensitive	back to summary
private final boolean caseSensitive Check to validate caseSensitive issues for specific case-insensitive FS. See Also `io.undertow.server.handlers.resource.PathResourceManager#isFileSameCase(java.nio.file.Path, String)`

private final boolean caseSensitive

Check to validate caseSensitive issues for specific case-insensitive FS.

See Also: io.undertow.server.handlers.resource.PathResourceManager#isFileSameCase(java.nio.file.Path, String)

DEFAULT_CHANGE_LISTENERS_ALLOWED	back to summary
private static final boolean DEFAULT_CHANGE_LISTENERS_ALLOWED

DEFAULT_TRANSFER_MIN_SIZE	back to summary
private static final long DEFAULT_TRANSFER_MIN_SIZE

eTagFunction	back to summary
private final PathResourceManager.ETagFunction eTagFunction

fileSystem	back to summary
protected volatile FileSystem fileSystem

fileSystemWatcher	back to summary
private FileSystemWatcher fileSystemWatcher

followLinks	back to summary
private final boolean followLinks Check to allow follow symbolic links

listeners	back to summary
private final List<ResourceChangeListener> listeners

log	back to summary
private static final Logger log

NULL_ETAG_FUNCTION	back to summary
private static final PathResourceManager.ETagFunction NULL_ETAG_FUNCTION

safePaths	back to summary
private final TreeSet<String> safePaths Used if followLinks == true. Set of paths valid to follow symbolic links. If this is empty and followLinks it true then all links will be followed

transferMinSize	back to summary
private final long transferMinSize Size to use direct FS to network transfer (if supported by OS/JDK) instead of read/write

Constructor Detail

PathResourceManager	back to summary
public PathResourceManager(final Path base)

PathResourceManager	back to summary
public PathResourceManager(final Path base, long transferMinSize)

PathResourceManager	back to summary
public PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive)

PathResourceManager	back to summary
public PathResourceManager(final Path base, long transferMinSize, boolean followLinks, final String... safePaths)

PathResourceManager	back to summary
protected PathResourceManager(long transferMinSize, boolean caseSensitive, boolean followLinks, final String... safePaths)

PathResourceManager	back to summary
protected PathResourceManager(long transferMinSize, boolean caseSensitive, boolean followLinks, boolean allowResourceChangeListeners, final String... safePaths)

PathResourceManager	back to summary
public PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive, boolean followLinks, final String... safePaths)

PathResourceManager	back to summary
public PathResourceManager(final Path base, long transferMinSize, boolean caseSensitive, boolean followLinks, boolean allowResourceChangeListeners, final String... safePaths)

PathResourceManager	back to summary
private PathResourceManager(PathResourceManager.Builder builder)

Method Detail

builder	back to summary
public static PathResourceManager.Builder builder()

close back to summary

close	back to summary
public synchronized void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public synchronized void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

getBasePath	back to summary
public Path getBasePath()

getFileResource	back to summary
protected PathResource getFileResource(final Path file, final String path, final Path symlinkBase, String normalizedFile) throws IOException Apply security check for case insensitive file systems.

getResource	back to summary
public Resource getResource(final String p) Implements io.undertow.server.handlers.resource.ResourceManager.getResource. Doc from io.undertow.server.handlers.resource.ResourceManager.getResource. Returns a resource for the given path. It is the responsibility of the called to make sure that the path in Canonicalised. Parameters p:String The path Returns:Resource The resource representing the path, or null if no resource was found.

getResource

back to summary

public Resource getResource(final String p)

Implements io.undertow.server.handlers.resource.ResourceManager.getResource.

Doc from io.undertow.server.handlers.resource.ResourceManager.getResource.

Returns a resource for the given path. It is the responsibility of the called to make sure that the path in Canonicalised.

Parameters

p:String: The path

Returns:Resource

The resource representing the path, or null if no resource was found.

getSymlinkBase	back to summary
private PathResourceManager.SymlinkResult getSymlinkBase(final String base, final Path file) Returns true is some element of path inside base path is a symlink.

getTransferMinSize	back to summary
public long getTransferMinSize()

isFileSameCase	back to summary
private boolean isFileSameCase(final Path file, String normalizeFile) throws IOException Security check for case insensitive file systems. We make sure the case of the filename matches the case of the request. This is only a check for case sensitivity, not for non canonical . and ../ which are allowed. For example: file.getName() == "page.jsp" && file.getCanonicalFile().getName() == "page.jsp" should return true file.getName() == "page.jsp" && file.getCanonicalFile().getName() == "page.JSP" should return false file.getName() == "./page.jsp" && file.getCanonicalFile().getName() == "page.jsp" should return true

isFileSameCase

back to summary

private boolean isFileSameCase(final Path file, String normalizeFile) throws IOException

Security check for case insensitive file systems. We make sure the case of the filename matches the case of the request. This is only a check for case sensitivity, not for non canonical . and ../ which are allowed. For example: file.getName() == "page.jsp" && file.getCanonicalFile().getName() == "page.jsp" should return true file.getName() == "page.jsp" && file.getCanonicalFile().getName() == "page.JSP" should return false file.getName() == "./page.jsp" && file.getCanonicalFile().getName() == "page.jsp" should return true

isResourceChangeListenerSupported back to summary

isResourceChangeListenerSupported	back to summary
public boolean isResourceChangeListenerSupported() Implements io.undertow.server.handlers.resource.ResourceManager.isResourceChangeListenerSupported. Returns:boolean Doc from io.undertow.server.handlers.resource.ResourceManager.isResourceChangeListenerSupported. `true` if a resource change listener is supported Annotations @Override

public boolean isResourceChangeListenerSupported()

Implements io.undertow.server.handlers.resource.ResourceManager.isResourceChangeListenerSupported.

Returns:boolean

Doc from io.undertow.server.handlers.resource.ResourceManager.isResourceChangeListenerSupported.

true if a resource change listener is supported

Annotations

@Override

isSymlinkSafe	back to summary
private boolean isSymlinkSafe(final Path file) throws IOException Security check for followSymlinks feature. Only follows those symbolink links defined in safePaths.

registerResourceChangeListener	back to summary
public synchronized void registerResourceChangeListener(ResourceChangeListener listener) Implements io.undertow.server.handlers.resource.ResourceManager.registerResourceChangeListener. Doc from io.undertow.server.handlers.resource.ResourceManager.registerResourceChangeListener. Registers a resource change listener, if the underlying resource manager support it Parameters listener:ResourceChangeListener The listener to register Annotations @Override

registerResourceChangeListener

back to summary

public synchronized void registerResourceChangeListener(ResourceChangeListener listener)

Implements io.undertow.server.handlers.resource.ResourceManager.registerResourceChangeListener.

Doc from io.undertow.server.handlers.resource.ResourceManager.registerResourceChangeListener.

Registers a resource change listener, if the underlying resource manager support it

Parameters

listener:ResourceChangeListener: The listener to register

Annotations

@Override

removeResourceChangeListener	back to summary
public synchronized void removeResourceChangeListener(ResourceChangeListener listener) Implements io.undertow.server.handlers.resource.ResourceManager.removeResourceChangeListener. Doc from io.undertow.server.handlers.resource.ResourceManager.removeResourceChangeListener. Removes a resource change listener Annotations @Override

removeResourceChangeListener

back to summary

public synchronized void removeResourceChangeListener(ResourceChangeListener listener)

Implements io.undertow.server.handlers.resource.ResourceManager.removeResourceChangeListener.

Doc from io.undertow.server.handlers.resource.ResourceManager.removeResourceChangeListener.

Removes a resource change listener

Annotations

@Override

setBase	back to summary
public PathResourceManager setBase(final Path base)

setBase	back to summary
public PathResourceManager setBase(final File base)

io.undertow.server.handlers.resource back to summary

public final Class PathResourceManager.Builder

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.resource.PathResourceManager.Builder

Field Summary

Modifier and Type	Field and Description
private boolean	allowResourceChangeListeners
private Path	base
private boolean	caseSensitive
private PathResourceManager.ETagFunction	eTagFunction
private boolean	followLinks
private String[]	safePaths
private long	transferMinSize

Constructor Summary

Access	Constructor and Description
private	Builder()

Method Summary

Modifier and Type	Method and Description
public ResourceManager	build()
public PathResourceManager.Builder	setAllowResourceChangeListeners(boolean allowResourceChangeListeners)
public PathResourceManager.Builder	setBase(Path base)
public PathResourceManager.Builder	setCaseSensitive(boolean caseSensitive)
public PathResourceManager.Builder	setETagFunction(PathResourceManager.ETagFunction eTagFunction)
public PathResourceManager.Builder	setFollowLinks(boolean followLinks)
public PathResourceManager.Builder	setSafePaths(String[] safePaths)
public PathResourceManager.Builder	setTransferMinSize(long transferMinSize)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allowResourceChangeListeners	back to summary
private boolean allowResourceChangeListeners

base	back to summary
private Path base

caseSensitive	back to summary
private boolean caseSensitive

eTagFunction	back to summary
private PathResourceManager.ETagFunction eTagFunction

followLinks	back to summary
private boolean followLinks

safePaths	back to summary
private String[] safePaths

transferMinSize	back to summary
private long transferMinSize

Constructor Detail

Builder	back to summary
private Builder()

Method Detail

build	back to summary
public ResourceManager build()

setAllowResourceChangeListeners	back to summary
public PathResourceManager.Builder setAllowResourceChangeListeners(boolean allowResourceChangeListeners)

setBase	back to summary
public PathResourceManager.Builder setBase(Path base)

setCaseSensitive	back to summary
public PathResourceManager.Builder setCaseSensitive(boolean caseSensitive)

setETagFunction	back to summary
public PathResourceManager.Builder setETagFunction(PathResourceManager.ETagFunction eTagFunction)

setFollowLinks	back to summary
public PathResourceManager.Builder setFollowLinks(boolean followLinks)

setSafePaths	back to summary
public PathResourceManager.Builder setSafePaths(String[] safePaths)

setTransferMinSize	back to summary
public PathResourceManager.Builder setTransferMinSize(long transferMinSize)

io.undertow.server.handlers.resource back to summary

public Interface PathResourceManager.ETagFunction

Method Summary

Modifier and Type	Method and Description
public ETag	Returns: ETag representing the provided path, or null generate(Path Path for which to generate an ETag path) Generates an `ETag` for the provided `Path`.

Method Detail

generate back to summary

public ETag generate(Path path)

Generates an ETag for the provided Path.

Parameters

path:Path: Path for which to generate an ETag

Returns:ETag

ETag representing the provided path, or null

public Class PathResourceManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class PathResourceManager.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface PathResourceManager.ETagFunction

Method Summary

Method Detail

private Class PathResourceManager.SymlinkResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail