Class PathResource
java.lang.Object
io.undertow.server.handlers.resource.PathResource
- All Implemented Interfaces:
RangeAwareResource
,Resource
- Direct Known Subclasses:
FileResource
A path resource
- Author:
- Stuart Douglas
-
Constructor Summary
ConstructorsConstructorDescriptionPathResource
(Path file, PathResourceManager manager, String path) PathResource
(Path file, PathResourceManager manager, String path, ETag eTag) -
Method Summary
Modifier and TypeMethodDescriptiongetContentType
(MimeMappings mimeMappings) Return the resources content type.getETag()
getFile()
getName()
getPath()
Returns the resource manager root.Returns the resource manager root.getUrl()
boolean
boolean
It is possible that some resources managers may only support range requests on a subset of their resources,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.
-
Constructor Details
-
PathResource
-
PathResource
-
-
Method Details
-
getPath
-
getLastModified
- Specified by:
getLastModified
in interfaceResource
- Returns:
- The last modified date of this resource, or null if this cannot be determined
-
getLastModifiedString
- Specified by:
getLastModifiedString
in interfaceResource
- Returns:
- A string representation of the last modified date, or null if this cannot be determined
-
getETag
-
getName
-
isDirectory
public boolean isDirectory()- Specified by:
isDirectory
in interfaceResource
- Returns:
true
if this resource represents a directory
-
list
-
getContentType
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 interfaceResource
-
serve
Description copied from interface:Resource
Serve the resource, and call the provided callback when complete. -
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 interfaceRangeAwareResource
- Parameters:
sender
- The sender to use.exchange
- The exchange
-
getContentLength
- Specified by:
getContentLength
in interfaceResource
- Returns:
- The content length, or null if it is unknown
-
getCacheKey
- Specified by:
getCacheKey
in interfaceResource
- Returns:
- A string that uniquely identifies this resource
-
getFile
-
getFilePath
- Specified by:
getFilePath
in interfaceResource
- Returns:
- The underlying file that matches the resource. This may return null if the resource does not map to a 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 interfaceResource
- Returns:
- a file representing the resource manager root. This may return null if the resource does not map to a file
-
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 interfaceResource
- Returns:
- a path representing the resource manager root. This may return null if the resource does not map to a file
-
getUrl
-
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 interfaceRangeAwareResource
- Returns:
true
if this resource supports range requests
-