Class PathResource
- All Implemented Interfaces:
Closeable
,AutoCloseable
,ResourceFactory
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Path
private final boolean
private static final LinkOption[]
private static final Logger
private static final LinkOption[]
private final Path
private final URI
Fields inherited from class org.eclipse.jetty.util.resource.Resource
__defaultUseCaches, _associate
-
Constructor Summary
ConstructorsModifierConstructorDescriptionPathResource
(File file) Construct a new PathResource from a File object.PathResource
(URI uri) Construct a new PathResource from a URI object.PathResource
(URL url) Create a new PathResource from a provided URL object.PathResource
(Path path) Construct a new PathResource from a Path object.private
PathResource
(PathResource parent, String childPath) Construct a new PathResource from a parent PathResource and child sub path -
Method Summary
Modifier and TypeMethodDescriptionReturns the resource contained inside the current resource with the given name.private void
assertValidPath
(Path path) private final Path
void
close()
Release any temporary resources held by the resource.void
Copy the Resource to the new destination file.boolean
delete()
Deletes the given resourceboolean
boolean
exists()
getAlias()
The Alias as a Path.getFile()
File representing the given resource.Input stream to the resourcegetName()
The name of the resource.getPath()
Readable ByteChannel for the resource.getURI()
URI representing the resource.getURL()
URL representing the resource.int
hashCode()
boolean
isAlias()
boolean
boolean
boolean
Return true if the passed Resource represents the same resource as the Resource.static boolean
isSameName
(Path pathA, Path pathB) Test if the paths are the same name.long
Time resource was last modified.long
length()
Length of the resource.String[]
list()
list of resource names contained in the given resource.boolean
Rename the given resourceprivate void
skipTo
(SeekableByteChannel channel, ByteBuffer buffer, long skipTo) toString()
void
writeTo
(OutputStream outputStream, long start, long count) Methods inherited from class org.eclipse.jetty.util.resource.Resource
encode, finalize, getAllResources, getAssociate, getDefaultUseCaches, getListHTML, getListHTML, getResource, getWeakETag, getWeakETag, isContainedIn, newClassPathResource, newClassPathResource, newResource, newResource, newResource, newResource, newResource, newResource, newResource, newSystemResource, release, setAssociate, setDefaultUseCaches, toURL
-
Field Details
-
LOG
-
NO_FOLLOW_LINKS
-
FOLLOW_LINKS
-
path
-
alias
-
uri
-
belongsToDefaultFileSystem
private final boolean belongsToDefaultFileSystem
-
-
Constructor Details
-
PathResource
Construct a new PathResource from a File object.An invocation of this convenience constructor of the form.
new PathResource(file);
behaves in exactly the same way as the expression
new PathResource(file.toPath());
- Parameters:
file
- the file to use
-
PathResource
Construct a new PathResource from a Path object.- Parameters:
path
- the path to use
-
PathResource
Construct a new PathResource from a parent PathResource and child sub path- Parameters:
parent
- the parent path resourcechildPath
- the child sub path
-
PathResource
Construct a new PathResource from a URI object.Must be an absolute URI using the
file
scheme.- Parameters:
uri
- the URI to build this PathResource from.- Throws:
IOException
- if unable to construct the PathResource from the URI.
-
PathResource
Create a new PathResource from a provided URL object.An invocation of this convenience constructor of the form.
new PathResource(url);
behaves in exactly the same way as the expression
new PathResource(url.toURI());
- Parameters:
url
- the url to attempt to create PathResource from- Throws:
IOException
- if URL doesn't point to a location that can be transformed to a PathResourceURISyntaxException
- if the provided URL was malformed
-
-
Method Details
-
checkAliasPath
-
isSameName
Test if the paths are the same name.If the real path is not the same as the absolute path then we know that the real path is the alias for the provided path.
For OS's that are case insensitive, this should return the real (on-disk / case correct) version of the path.
We have to be careful on Windows and OSX.
Assume we have the following scenario:
Path a = new File("foo").toPath(); Files.createFile(a); Path b = new File("FOO").toPath();
There now exists a file called
foo
on disk. Using Windows or OSX, with a Path reference ofFOO
,Foo
,fOO
, etc.. means the following| OSX | Windows | Linux -----------------------+---------+------------+--------- Files.exists(a) | True | True | True Files.exists(b) | True | True | False Files.isSameFile(a,b) | True | True | False a.equals(b) | False | True | False
See the javadoc for Path.equals() for details about this FileSystem behavior difference
We also cannot rely on a.compareTo(b) as this is roughly equivalent in implementation to a.equals(b)
-
isSame
Description copied from class:Resource
Return true if the passed Resource represents the same resource as the Resource. For many resource types, this is equivalent toObject.equals(Object)
, however for resources types that support aliasing, this maybe some other check (e.g.Files.isSameFile(Path, Path)
). -
addPath
Description copied from class:Resource
Returns the resource contained inside the current resource with the given name.- Specified by:
addPath
in classResource
- Parameters:
subpath
- The path segment to add, which is not encoded- Returns:
- the Resource for the resolved path within this Resource.
- Throws:
IOException
- if unable to resolve the path
-
assertValidPath
-
close
public void close()Description copied from class:Resource
Release any temporary resources held by the resource. -
delete
Description copied from class:Resource
Deletes the given resource- Specified by:
delete
in classResource
- Returns:
- true if resource was found and successfully deleted, false if resource didn't exist or was unable to be deleted.
- Throws:
SecurityException
- if unable to delete due to permissions
-
equals
-
exists
public boolean exists() -
getFile
Description copied from class:Resource
File representing the given resource.- Specified by:
getFile
in classResource
- Returns:
- an File representing the given resource or NULL if this is not possible.
- Throws:
IOException
- if unable to get the resource due to permissions
-
getPath
- Returns:
- the
Path
of the resource
-
getInputStream
Description copied from class:Resource
Input stream to the resource- Specified by:
getInputStream
in classResource
- Returns:
- an input stream to the resource
- Throws:
IOException
- if unable to open the input stream
-
getName
Description copied from class:Resource
The name of the resource. -
getReadableByteChannel
Description copied from class:Resource
Readable ByteChannel for the resource.- Specified by:
getReadableByteChannel
in classResource
- Returns:
- an readable bytechannel to the resource or null if one is not available.
- Throws:
IOException
- if unable to open the readable bytechannel for the resource.
-
newSeekableByteChannel
- Throws:
IOException
-
getURI
Description copied from class:Resource
URI representing the resource. -
getURL
Description copied from class:Resource
URL representing the resource. -
hashCode
public int hashCode() -
isContainedIn
- Specified by:
isContainedIn
in classResource
- Throws:
MalformedURLException
-
isDirectory
public boolean isDirectory()- Specified by:
isDirectory
in classResource
- Returns:
- true if the represented resource is a container/directory. if the resource is not a file, resources ending with "/" are considered directories.
-
lastModified
public long lastModified()Description copied from class:Resource
Time resource was last modified.- Specified by:
lastModified
in classResource
- Returns:
- the last modified time as milliseconds since unix epoch
-
length
public long length()Description copied from class:Resource
Length of the resource. -
isAlias
public boolean isAlias() -
getAliasPath
The Alias as a Path.Note: this cannot return the alias as a DIFFERENT path in 100% of situations, due to Java's internal Path/File normalization.
- Returns:
- the alias as a path.
-
getAlias
-
list
Description copied from class:Resource
list of resource names contained in the given resource. Ordering is unspecified, so callers may wish to sort the return value to ensure deterministic behavior. -
renameTo
Description copied from class:Resource
Rename the given resource- Specified by:
renameTo
in classResource
- Parameters:
dest
- the destination name for the resource- Returns:
- true if the resource was renamed, false if the resource didn't exist or was unable to be renamed.
- Throws:
SecurityException
- if unable to rename due to permissions
-
copyTo
Description copied from class:Resource
Copy the Resource to the new destination file.Will not replace existing destination file.
- Overrides:
copyTo
in classResource
- Parameters:
destination
- the destination file to create- Throws:
IOException
- if unable to copy the resource
-
writeTo
- Overrides:
writeTo
in classResource
- Parameters:
outputStream
- the output stream to write tostart
- First byte to writecount
- Bytes to write or -1 for all of them.- Throws:
IOException
- if unable to copy the Resource to the output
-
skipTo
- Throws:
IOException
-
toString
-