Modifier and Type	Class and Description
pack-priv static class	CachedResource.CacheKey
private static class	CachedResource.DereferenceCallback

Modifier and Type	Field and Description
private final CachedResource.CacheKey	cacheKey
private final CachingResourceManager	cachingResourceManager
private final boolean	directory
private final ETag	eTag
private final Date	lastModifiedDate
private final String	lastModifiedDateString
private final String	name
private volatile long	nextMaxAgeCheck
private final Resource	underlyingResource

Access	Constructor and Description
public	CachedResource(final CachingResourceManager cachingResourceManager, final Resource underlyingResource, final String path)

Modifier and Type	Method and Description
public boolean	checkStillValid()
public String	getCacheKey() Implements io.undertow.server.handlers.resource.Resource.getCacheKey.
public Long	getContentLength() Implements io.undertow.server.handlers.resource.Resource.getContentLength.
public String	getContentType(final MimeMappings mimeMappings) Implements io.undertow.server.handlers.resource.Resource.getContentType. Return the resources content type.
public ETag	getETag() Implements io.undertow.server.handlers.resource.Resource.getETag.
public File	getFile() Implements io.undertow.server.handlers.resource.Resource.getFile.
public Path	getFilePath() Implements io.undertow.server.handlers.resource.Resource.getFilePath.
public Date	getLastModified() Implements io.undertow.server.handlers.resource.Resource.getLastModified.
public String	getLastModifiedString() Implements io.undertow.server.handlers.resource.Resource.getLastModifiedString.
public String	getName() Implements io.undertow.server.handlers.resource.Resource.getName.
public String	getPath() Implements io.undertow.server.handlers.resource.Resource.getPath.
public File	getResourceManagerRoot() Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRoot. Returns the resource manager root.
public Path	getResourceManagerRootPath() Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRootPath. Returns the resource manager root.
public URL	getUrl() Implements io.undertow.server.handlers.resource.Resource.getUrl.
public void	invalidate()
public boolean	isDirectory() Implements io.undertow.server.handlers.resource.Resource.isDirectory.
public boolean	isRangeSupported() Implements io.undertow.server.handlers.resource.RangeAwareResource.isRangeSupported. It is possible that some resources managers may only support range requests on a subset of their resources,
public List<Resource>	list() Implements io.undertow.server.handlers.resource.Resource.list.
public void	serve(final Sender The sender to use. sender, final HttpServerExchange The exchange exchange, final IoCallback completionCallback) Implements io.undertow.server.handlers.resource.Resource.serve. Serve the resource, and call the provided callback when complete.
public void	serveRange(Sender The sender to use. sender, HttpServerExchange The exchange exchange, long start, long end, IoCallback completionCallback) Implements io.undertow.server.handlers.resource.RangeAwareResource.serveRange. Serve the resource, and call the provided callback when complete.

cacheKey	back to summary
private final CachedResource.CacheKey cacheKey

cachingResourceManager	back to summary
private final CachingResourceManager cachingResourceManager

directory	back to summary
private final boolean directory

eTag	back to summary
private final ETag eTag

lastModifiedDate	back to summary
private final Date lastModifiedDate

lastModifiedDateString	back to summary
private final String lastModifiedDateString

name	back to summary
private final String name

nextMaxAgeCheck	back to summary
private volatile long nextMaxAgeCheck

underlyingResource	back to summary
private final Resource underlyingResource

CachedResource	back to summary
public CachedResource(final CachingResourceManager cachingResourceManager, final Resource underlyingResource, final String path)

Method Detail

checkStillValid	back to summary
public boolean checkStillValid()

getCacheKey	back to summary
public String getCacheKey() Implements io.undertow.server.handlers.resource.Resource.getCacheKey. Returns:String Doc from io.undertow.server.handlers.resource.Resource.getCacheKey. A string that uniquely identifies this resource Annotations @Override

getCacheKey

back to summary

public String getCacheKey()

Implements io.undertow.server.handlers.resource.Resource.getCacheKey.

Returns:String

Doc from io.undertow.server.handlers.resource.Resource.getCacheKey.

A string that uniquely identifies this resource

Annotations

@Override

getContentLength	back to summary
public Long getContentLength() Implements io.undertow.server.handlers.resource.Resource.getContentLength. Returns:Long Doc from io.undertow.server.handlers.resource.Resource.getContentLength. The content length, or null if it is unknown Annotations @Override

getContentLength

back to summary

public Long getContentLength()

Implements io.undertow.server.handlers.resource.Resource.getContentLength.

Returns:Long

Doc from io.undertow.server.handlers.resource.Resource.getContentLength.

The content length, or null if it is unknown

Annotations

@Override

getContentType	back to summary
public String getContentType(final MimeMappings mimeMappings) Implements io.undertow.server.handlers.resource.Resource.getContentType. Doc from io.undertow.server.handlers.resource.Resource.getContentType. Return the resources content type. In most cases this will simply use the provided mime mappings, however in some cases the resource may have additional information as to the actual content type. Annotations @Override

getContentType

back to summary

public String getContentType(final MimeMappings mimeMappings)

Implements io.undertow.server.handlers.resource.Resource.getContentType.

Doc from io.undertow.server.handlers.resource.Resource.getContentType.

Return the resources content type. In most cases this will simply use the provided mime mappings, however in some cases the resource may have additional information as to the actual content type.

Annotations

@Override

getETag	back to summary
public ETag getETag() Implements io.undertow.server.handlers.resource.Resource.getETag. Returns:ETag Doc from io.undertow.server.handlers.resource.Resource.getETag. The resources etags Annotations @Override

getETag

back to summary

public ETag getETag()

Implements io.undertow.server.handlers.resource.Resource.getETag.

Returns:ETag

Doc from io.undertow.server.handlers.resource.Resource.getETag.

The resources etags

Annotations

@Override

getFile	back to summary
public File getFile() Implements io.undertow.server.handlers.resource.Resource.getFile. Returns:File Doc from io.undertow.server.handlers.resource.Resource.getFile. The underlying file that matches the resource. This may return null if the resource does not map to a file Annotations @Override

getFile

back to summary

public File getFile()

Implements io.undertow.server.handlers.resource.Resource.getFile.

Returns:File

Doc from io.undertow.server.handlers.resource.Resource.getFile.

The underlying file that matches the resource. This may return null if the resource does not map to a file

Annotations

@Override

getFilePath	back to summary
public Path getFilePath() Implements io.undertow.server.handlers.resource.Resource.getFilePath. Returns:Path Doc from io.undertow.server.handlers.resource.Resource.getFilePath. The underlying file that matches the resource. This may return null if the resource does not map to a file Annotations @Override

getFilePath

back to summary

public Path getFilePath()

Implements io.undertow.server.handlers.resource.Resource.getFilePath.

Returns:Path

Doc from io.undertow.server.handlers.resource.Resource.getFilePath.

The underlying file that matches the resource. This may return null if the resource does not map to a file

Annotations

@Override

getLastModified	back to summary
public Date getLastModified() Implements io.undertow.server.handlers.resource.Resource.getLastModified. Returns:Date Doc from io.undertow.server.handlers.resource.Resource.getLastModified. The last modified date of this resource, or null if this cannot be determined Annotations @Override

getLastModified

back to summary

public Date getLastModified()

Implements io.undertow.server.handlers.resource.Resource.getLastModified.

Returns:Date

Doc from io.undertow.server.handlers.resource.Resource.getLastModified.

The last modified date of this resource, or null if this cannot be determined

Annotations

@Override

getLastModifiedString	back to summary
public String getLastModifiedString() Implements io.undertow.server.handlers.resource.Resource.getLastModifiedString. Returns:String Doc from io.undertow.server.handlers.resource.Resource.getLastModifiedString. A string representation of the last modified date, or null if this cannot be determined Annotations @Override

getLastModifiedString

back to summary

public String getLastModifiedString()

Implements io.undertow.server.handlers.resource.Resource.getLastModifiedString.

Returns:String

Doc from io.undertow.server.handlers.resource.Resource.getLastModifiedString.

A string representation of the last modified date, or null if this cannot be determined

Annotations

@Override

getName	back to summary
public String getName() Implements io.undertow.server.handlers.resource.Resource.getName. Returns:String Doc from io.undertow.server.handlers.resource.Resource.getName. The name of the resource Annotations @Override

getName

back to summary

public String getName()

Implements io.undertow.server.handlers.resource.Resource.getName.

Returns:String

Doc from io.undertow.server.handlers.resource.Resource.getName.

The name of the resource

Annotations

@Override

getPath	back to summary
public String getPath() Implements io.undertow.server.handlers.resource.Resource.getPath. Returns:String Doc from io.undertow.server.handlers.resource.Resource.getPath. The path from the resource manager root Annotations @Override

getPath

back to summary

public String getPath()

Implements io.undertow.server.handlers.resource.Resource.getPath.

Returns:String

Doc from io.undertow.server.handlers.resource.Resource.getPath.

The path from the resource manager root

Annotations

@Override

getResourceManagerRoot	back to summary
public File getResourceManagerRoot() Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRoot. Doc from io.undertow.server.handlers.resource.Resource.getResourceManagerRoot. Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource. Returns:File a file representing the resource manager root. This may return null if the resource does not map to a file Annotations @Override

getResourceManagerRoot

back to summary

public File getResourceManagerRoot()

Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRoot.

Doc from io.undertow.server.handlers.resource.Resource.getResourceManagerRoot.

Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource.

Returns:File

a file representing the resource manager root. This may return null if the resource does not map to a file

Annotations

@Override

getResourceManagerRootPath	back to summary
public Path getResourceManagerRootPath() Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRootPath. Doc from io.undertow.server.handlers.resource.Resource.getResourceManagerRootPath. Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource. Returns:Path a path representing the resource manager root. This may return null if the resource does not map to a file Annotations @Override

getResourceManagerRootPath

back to summary

public Path getResourceManagerRootPath()

Implements io.undertow.server.handlers.resource.Resource.getResourceManagerRootPath.

Doc from io.undertow.server.handlers.resource.Resource.getResourceManagerRootPath.

Returns the resource manager root. If the resource manager has multiple roots then this returns the one that is the parent of this resource.

Returns:Path

a path representing the resource manager root. This may return null if the resource does not map to a file

Annotations

@Override

getUrl	back to summary
public URL getUrl() Implements io.undertow.server.handlers.resource.Resource.getUrl. Returns:URL Doc from io.undertow.server.handlers.resource.Resource.getUrl. The URL of the resource Annotations @Override

getUrl

back to summary

public URL getUrl()

Implements io.undertow.server.handlers.resource.Resource.getUrl.

Returns:URL

Doc from io.undertow.server.handlers.resource.Resource.getUrl.

The URL of the resource

Annotations

@Override

invalidate	back to summary
public void invalidate()

isDirectory back to summary

isDirectory	back to summary
public boolean isDirectory() Implements io.undertow.server.handlers.resource.Resource.isDirectory. Returns:boolean Doc from io.undertow.server.handlers.resource.Resource.isDirectory. `true` if this resource represents a directory Annotations @Override

public boolean isDirectory()

Implements io.undertow.server.handlers.resource.Resource.isDirectory.

Returns:boolean

Doc from io.undertow.server.handlers.resource.Resource.isDirectory.

true if this resource represents a directory

Annotations

@Override

isRangeSupported back to summary

isRangeSupported	back to summary
public boolean isRangeSupported() Implements io.undertow.server.handlers.resource.RangeAwareResource.isRangeSupported. Doc from io.undertow.server.handlers.resource.RangeAwareResource.isRangeSupported. It is possible that some resources managers may only support range requests on a subset of their resources, Returns:boolean `true` if this resource supports range requests Annotations @Override

public boolean isRangeSupported()

Implements io.undertow.server.handlers.resource.RangeAwareResource.isRangeSupported.

Doc from io.undertow.server.handlers.resource.RangeAwareResource.isRangeSupported.

It is possible that some resources managers may only support range requests on a subset of their resources,

Returns:boolean

true if this resource supports range requests

Annotations

@Override

list	back to summary
public List<Resource> list() Implements io.undertow.server.handlers.resource.Resource.list. Returns:List<Resource> Doc from io.undertow.server.handlers.resource.Resource.list. a list of resources in this directory Annotations @Override

list

back to summary

public List<Resource> list()

Implements io.undertow.server.handlers.resource.Resource.list.

Returns:List<Resource>

Doc from io.undertow.server.handlers.resource.Resource.list.

a list of resources in this directory

Annotations

@Override

serve	back to summary
public void serve(final Sender sender, final HttpServerExchange exchange, final IoCallback completionCallback) Implements io.undertow.server.handlers.resource.Resource.serve. Doc from io.undertow.server.handlers.resource.Resource.serve. Serve the resource, and call the provided callback when complete. Parameters sender:Sender The sender to use. exchange:HttpServerExchange The exchange Annotations @Override

serve

back to summary

public void serve(final Sender sender, final HttpServerExchange exchange, final IoCallback completionCallback)

Implements io.undertow.server.handlers.resource.Resource.serve.

Doc from io.undertow.server.handlers.resource.Resource.serve.

Serve the resource, and call the provided callback when complete.

Parameters

sender:Sender: The sender to use.
exchange:HttpServerExchange: The exchange

Annotations

@Override

serveRange	back to summary
public void serveRange(Sender sender, HttpServerExchange exchange, long start, long end, IoCallback completionCallback) Implements io.undertow.server.handlers.resource.RangeAwareResource.serveRange. Doc from io.undertow.server.handlers.resource.RangeAwareResource.serveRange. Serve the resource, and call the provided callback when complete. Parameters sender:Sender The sender to use. exchange:HttpServerExchange The exchange Annotations @Override

serveRange

back to summary

public void serveRange(Sender sender, HttpServerExchange exchange, long start, long end, IoCallback completionCallback)

Implements io.undertow.server.handlers.resource.RangeAwareResource.serveRange.

Doc from io.undertow.server.handlers.resource.RangeAwareResource.serveRange.

Serve the resource, and call the provided callback when complete.

Parameters

sender:Sender: The sender to use.
exchange:HttpServerExchange: The exchange

Annotations

@Override

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

pack-priv final Class CachedResource.CacheKey

Class Inheritance

extends Object

java.lang.Object
io.undertow.server.handlers.resource.CachedResource.CacheKey

Field Summary

Modifier and Type	Field and Description
pack-priv final String	cacheKey
pack-priv final CachingResourceManager	manager

Constructor Summary

Access	Constructor and Description
pack-priv	CacheKey(CachingResourceManager manager, String cacheKey)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.

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

Field Detail

cacheKey	back to summary
pack-priv final String cacheKey

manager	back to summary
pack-priv final CachingResourceManager manager

Constructor Detail

CacheKey	back to summary
pack-priv CacheKey(CachingResourceManager manager, String cacheKey)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

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

private Class CachedResource.DereferenceCallback

Class Inheritance

extends Object
implements IoCallback

java.lang.Object
io.undertow.server.handlers.resource.CachedResource.DereferenceCallback

All Implemented Interfaces

io.undertow.io.IoCallback

Field Summary

Modifier and Type	Field and Description
private final IoCallback	callback
private final DirectBufferCache.CacheEntry	entry

Constructor Summary

Access	Constructor and Description
pack-priv	DereferenceCallback(DirectBufferCache.CacheEntry entry, final IoCallback callback)

Method Summary

Modifier and Type	Method and Description
public void	onComplete(final HttpServerExchange exchange, final Sender sender) Implements io.undertow.io.IoCallback.onComplete.
public void	onException(final HttpServerExchange exchange, final Sender sender, final IOException exception) Implements io.undertow.io.IoCallback.onException.

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

Field Detail

callback	back to summary
private final IoCallback callback

entry	back to summary
private final DirectBufferCache.CacheEntry entry

Constructor Detail

DereferenceCallback	back to summary
pack-priv DereferenceCallback(DirectBufferCache.CacheEntry entry, final IoCallback callback)

Method Detail

onComplete	back to summary
public void onComplete(final HttpServerExchange exchange, final Sender sender) Implements io.undertow.io.IoCallback.onComplete. Annotations @Override

onComplete

back to summary

public void onComplete(final HttpServerExchange exchange, final Sender sender)

Implements io.undertow.io.IoCallback.onComplete.

Annotations

@Override

onException	back to summary
public void onException(final HttpServerExchange exchange, final Sender sender, final IOException exception) Implements io.undertow.io.IoCallback.onException. Annotations @Override

onException

back to summary

public void onException(final HttpServerExchange exchange, final Sender sender, final IOException exception)

Implements io.undertow.io.IoCallback.onException.

Annotations

@Override

public Class CachedResource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class CachedResource.CacheKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CachedResource.DereferenceCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail