Package org.eclipse.jetty.util.resource

Class FileResource

  • All Implemented Interfaces:
    Closeable, AutoCloseable, ResourceFactory
    @Deprecated
public class FileResource
extends Resource
    Deprecated.
    Use PathResource
    File Resource. Handle resources of implied or explicit file type. This class can check for aliasing in the filesystem (eg case insensitivity). By default this is turned on, or it can be controlled by calling the static method @see FileResource#setCheckAliases(boolean)

    • Method Detail

      • isSame

        public boolean isSame​(Resource resource)
        Deprecated.
        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 to Object.equals(Object), however for resources types that support aliasing, this maybe some other check (e.g. Files.isSameFile(Path, Path)).
        Overrides:
        isSame in class Resource
        Parameters:
        resource - The resource to check
        Returns:
        true if the passed resource represents the same resource.

      • addPath

        public Resource addPath​(String path)
                 throws IOException
        Deprecated.
        Description copied from class: Resource
        Returns the resource contained inside the current resource with the given name.
        Specified by:
        addPath in class Resource
        Parameters:
        path - The path segment to add, which is not encoded. The path may be non canonical, but if so then the resulting Resource will return true from Resource.isAlias().
        Returns:
        the Resource for the resolved path within this Resource.
        Throws:
        IOException - if unable to resolve the path
        MalformedURLException - if the resolution of the path fails because the input path parameter is malformed, or a relative path attempts to access above the root resource.

      • getAlias

        public URI getAlias()
        Deprecated.
        Overrides:
        getAlias in class Resource
        Returns:
        The canonical Alias of this resource or null if none.

      • exists

        public boolean exists()
        Deprecated.
        Returns true if the resource exists.
        Specified by:
        exists in class Resource
        Returns:
        true if the represented resource exists.

      • lastModified

        public long lastModified()
        Deprecated.
        Returns the last modified time
        Specified by:
        lastModified in class Resource
        Returns:
        the last modified time as milliseconds since unix epoch

      • isDirectory

        public boolean isDirectory()
        Deprecated.
        Returns true if the resource is a container/directory.
        Specified by:
        isDirectory in class Resource
        Returns:
        true if the represented resource is a container/directory. if the resource is not a file, resources ending with "/" are considered directories.

      • length

        public long length()
        Deprecated.
        Return the length of the resource
        Specified by:
        length in class Resource
        Returns:
        the length of the resource

      • getName

        public String getName()
        Deprecated.
        Returns the name of the resource
        Specified by:
        getName in class Resource
        Returns:
        the name of the resource

      • getFile

        public File getFile()
        Deprecated.
        Returns an File representing the given resource or NULL if this is not possible.
        Specified by:
        getFile in class Resource
        Returns:
        an File representing the given resource or NULL if this is not possible.

      • getReadableByteChannel

        public ReadableByteChannel getReadableByteChannel()
                                           throws IOException
        Deprecated.
        Description copied from class: Resource
        Readable ByteChannel for the resource.
        Specified by:
        getReadableByteChannel in class Resource
        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.

      • delete

        public boolean delete()
               throws SecurityException
        Deprecated.
        Deletes the given resource
        Specified by:
        delete in class Resource
        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

      • renameTo

        public boolean renameTo​(Resource dest)
                 throws SecurityException
        Deprecated.
        Rename the given resource
        Specified by:
        renameTo in class Resource
        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

      • list

        public String[] list()
        Deprecated.
        Returns a list of resources contained in the given resource
        Specified by:
        list in class Resource
        Returns:
        a list of resource names contained in the given resource, or null. Note: The resource names are not URL encoded.

      • equals

        public boolean equals​(Object o)
        Deprecated.
        Overrides:
        equals in class Object
        Parameters:
        o - the object to compare against this instance
        Returns:
        true of the object o is a FileResource pointing to the same file as this resource.

      • hashCode

        public int hashCode()
        Deprecated.
        Overrides:
        hashCode in class Object
        Returns:
        the hashcode.

      • copyTo

        public void copyTo​(File destination)
            throws IOException
        Deprecated.
        Description copied from class: Resource
        Copy the Resource to the new destination file.

        Will not replace existing destination file.

        Overrides:
        copyTo in class Resource
        Parameters:
        destination - the destination file to create
        Throws:
        IOException - if unable to copy the resource

      • close

        public void close()
        Deprecated.
        Description copied from class: Resource
        Release any temporary resources held by the resource.
        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
        Specified by:
        close in class Resource

      • getURL

        public URL getURL()
        Deprecated.
        Description copied from class: Resource
        URL representing the resource.
        Specified by:
        getURL in class Resource
        Returns:
        a URL representing the given resource

      • getURI

        public URI getURI()
        Deprecated.
        Description copied from class: Resource
        URI representing the resource.
        Overrides:
        getURI in class Resource
        Returns:
        an URI representing the given resource