io.undertow.server.handlers.resource

Class FileResourceManager

java.lang.Object

io.undertow.server.handlers.resource.FileResourceManager

All Implemented Interfaces:

ResourceManager, Closeable, AutoCloseable

public class FileResourceManager
extends Object
implements ResourceManager

Serves files from the file system.

Field Summary

Fields inherited from interface io.undertow.server.handlers.resource.ResourceManager

EMPTY_RESOURCE_MANAGER

Constructor Summary

Constructors

Constructor and Description
FileResourceManager(File base, long transferMinSize)
FileResourceManager(File base, long transferMinSize, boolean caseSensitive)
FileResourceManager(File base, long transferMinSize, boolean caseSensitive, boolean followLinks, String... safePaths)
FileResourceManager(File base, long transferMinSize, boolean followLinks, String... safePaths)

Method Summary

Modifier and Type	Method and Description
void	close()
File	getBase()
Resource	getResource(String p) Returns a resource for the given path.
long	getTransferMinSize()
boolean	isResourceChangeListenerSupported()
void	registerResourceChangeListener(ResourceChangeListener listener) Registers a resource change listener, if the underlying resource manager support it
void	removeResourceChangeListener(ResourceChangeListener listener) Removes a resource change listener
FileResourceManager	setBase(File base)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileResourceManager

public FileResourceManager(File base,
                           long transferMinSize)

FileResourceManager

public FileResourceManager(File base,
                           long transferMinSize,
                           boolean caseSensitive)

FileResourceManager

public FileResourceManager(File base,
                           long transferMinSize,
                           boolean followLinks,
                           String... safePaths)

FileResourceManager

public FileResourceManager(File base,
                           long transferMinSize,
                           boolean caseSensitive,
                           boolean followLinks,
                           String... safePaths)

Method Detail

getBase

public File getBase()

setBase

public FileResourceManager setBase(File base)

getResource

public Resource getResource(String p)

Description copied from interface: ResourceManager

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

Specified by:

getResource in interface ResourceManager

Parameters:

p - The path

Returns:

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

isResourceChangeListenerSupported

public boolean isResourceChangeListenerSupported()

Specified by:

isResourceChangeListenerSupported in interface ResourceManager

Returns:

true if a resource change listener is supported

registerResourceChangeListener

public void registerResourceChangeListener(ResourceChangeListener listener)

Description copied from interface: ResourceManager

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

Specified by:

registerResourceChangeListener in interface ResourceManager

Parameters:

listener - The listener to register

removeResourceChangeListener

public void removeResourceChangeListener(ResourceChangeListener listener)

Description copied from interface: ResourceManager

Removes a resource change listener

Specified by:

removeResourceChangeListener in interface ResourceManager

getTransferMinSize

public long getTransferMinSize()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException