Package io.undertow.server.handlers.resource

Class CachingResourceManager

java.lang.Object

io.undertow.server.handlers.resource.CachingResourceManager

All Implemented Interfaces:

ResourceManager, Closeable, AutoCloseable

public class CachingResourceManager
extends Object
implements ResourceManager

Author:

Stuart Douglas

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_AGE_NO_CACHING	Max age 0, indicating that entries expire upon creation and are not retained;
static final int	MAX_AGE_NO_EXPIRY	Mage age -1, this force manager to retain entries until underlying resource manager indicate that entries expired/changed

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

EMPTY_RESOURCE_MANAGER

Constructor Summary

Constructors

Constructor	Description
CachingResourceManager(int metadataCacheSize, long maxFileSize, DirectBufferCache dataCache, ResourceManager underlyingResourceManager, int maxAge)

Method Summary

Modifier and Type	Method	Description
void	close()
int	getMaxAge()
long	getMaxFileSize()
CachedResource	getResource(String p)	Returns a resource for the given path.
void	invalidate()
void	invalidate(String path)
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

Methods inherited from class java.lang.Object

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

Field Details

MAX_AGE_NO_CACHING

public static final int MAX_AGE_NO_CACHING

Max age 0, indicating that entries expire upon creation and are not retained;

See Also:

• Constant Field Values

MAX_AGE_NO_EXPIRY

public static final int MAX_AGE_NO_EXPIRY

Mage age -1, this force manager to retain entries until underlying resource manager indicate that entries expired/changed

See Also:

• Constant Field Values

Constructor Details

CachingResourceManager

public CachingResourceManager(int metadataCacheSize,
 long maxFileSize,
 DirectBufferCache dataCache,
 ResourceManager underlyingResourceManager,
 int maxAge)

Method Details

getResource

public CachedResource getResource(String p)
                           throws IOException

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.

Throws:

IOException

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

invalidate

public void invalidate(String path)

invalidate

public void invalidate()

getMaxFileSize

public long getMaxFileSize()

getMaxAge

public int getMaxAge()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException