Package io.undertow.server.handlers.resource

Class PathResource

java.lang.Object

io.undertow.server.handlers.resource.PathResource

All Implemented Interfaces:

RangeAwareResource, Resource

Direct Known Subclasses:

FileResource

public class PathResource
extends java.lang.Object
implements RangeAwareResource

A path resource

Author:

Stuart Douglas

Constructor Summary

Constructors

Constructor	Description
PathResource(java.nio.file.Path file, PathResourceManager manager, java.lang.String path)
PathResource(java.nio.file.Path file, PathResourceManager manager, java.lang.String path, ETag eTag)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PathResource

public PathResource(java.nio.file.Path file,
                    PathResourceManager manager,
                    java.lang.String path,
                    ETag eTag)

PathResource

public PathResource(java.nio.file.Path file,
                    PathResourceManager manager,
                    java.lang.String path)

Method Detail

getPath

public java.lang.String getPath()

Specified by:

getPath in interface Resource

Returns:

The path from the resource manager root

getLastModified

public java.util.Date getLastModified()

Specified by:

getLastModified in interface Resource

Returns:

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

getLastModifiedString

public java.lang.String getLastModifiedString()

Specified by:

getLastModifiedString in interface Resource

Returns:

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

getETag

public ETag getETag()

Specified by:

getETag in interface Resource

Returns:

The resources etags

getName

public java.lang.String getName()

Specified by:

getName in interface Resource

Returns:

The name of the resource

isDirectory

public boolean isDirectory()

Specified by:

isDirectory in interface Resource

Returns:

true if this resource represents a directory

list

public java.util.List<Resource> list()

Specified by:

list in interface Resource

Returns:

a list of resources in this directory

getContentType

public java.lang.String getContentType(MimeMappings mimeMappings)

Description copied from interface: Resource

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.

Specified by:

getContentType in interface Resource

serve

public void serve(Sender sender,
                  HttpServerExchange exchange,
                  IoCallback callback)

Description copied from interface: Resource

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

Specified by:

serve in interface Resource

Parameters:

sender - The sender to use.

exchange - The exchange

serveRange

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

Description copied from interface: RangeAwareResource

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

Specified by:

serveRange in interface RangeAwareResource

Parameters:

sender - The sender to use.

exchange - The exchange

getContentLength

public java.lang.Long getContentLength()

Specified by:

getContentLength in interface Resource

Returns:

The content length, or null if it is unknown

getCacheKey

public java.lang.String getCacheKey()

Specified by:

getCacheKey in interface Resource

Returns:

A string that uniquely identifies this resource

getFile

public java.io.File getFile()

Specified by:

getFile in interface Resource

Returns:

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

getFilePath

public java.nio.file.Path getFilePath()

Specified by:

getFilePath in interface Resource

Returns:

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

getResourceManagerRoot

public java.io.File getResourceManagerRoot()

Description copied from interface: Resource

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

Specified by:

getResourceManagerRoot in interface Resource

Returns:

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

getResourceManagerRootPath

public java.nio.file.Path getResourceManagerRootPath()

Description copied from interface: Resource

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

Specified by:

getResourceManagerRootPath in interface Resource

Returns:

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

getUrl

public java.net.URL getUrl()

Specified by:

getUrl in interface Resource

Returns:

The URL of the resource

isRangeSupported

public boolean isRangeSupported()

Description copied from interface: RangeAwareResource

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

Specified by:

isRangeSupported in interface RangeAwareResource

Returns:

true if this resource supports range requests