Module io.inverno.mod.base
Package io.inverno.mod.base.resource

Class PathResource

java.lang.Object
io.inverno.mod.base.resource.AbstractResource
io.inverno.mod.base.resource.AbstractAsyncResource
io.inverno.mod.base.resource.PathResource
All Implemented Interfaces:
AsyncResource, Resource, AutoCloseable
public class PathResource extends AbstractAsyncResource

A Resource implementation that identifies resources by a path and looks up data on the file system.

A typical usage is: 


 PathResource resource = new PathResource(Path.of("/path/to/resource"));
 ...
Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Constructor Details

    • PathResource

      public PathResource(Path path)

      Creates a path resource with the specified path.

      Parameters:
      path - the resource path

    • PathResource

      public PathResource(Path path, MediaTypeService mediaTypeService)

      Creates a path resource with the specified path and media type service.

      Parameters:
      path - the resource path
      mediaTypeService - the media type service

  • Method Details

    • getURI

      public URI getURI()
      Description copied from interface: Resource

      Returns the resource URI.

      Returns:
      the resource URI

    • getFilename

      public String getFilename() throws ResourceException
      Description copied from interface: Resource

      Returns the resource file name.

      Returns:
      the resource file name
      Throws:
      ResourceException - if there was an error resolving the resource file name

    • getMediaType

      public String getMediaType() throws ResourceException
      Description copied from interface: Resource

      Returns the resource media type.

      Specified by:
      getMediaType in interface Resource
      Overrides:
      getMediaType in class AbstractResource
      Returns:
      the resource media type or null if it couldn't be determined
      Throws:
      ResourceException - if there was an error resolving the resource media type

    • exists

      public Optional<Boolean> exists() throws ResourceException
      Description copied from interface: Resource

      Determines whether the resource exists.

      Returns:
      an optional returning true if the resource exists, false otherwise or an empty optional if existence couldn't be determined
      Throws:
      ResourceException - if there was an error determining resource existence

    • lastModified

      public Optional<FileTime> lastModified() throws ResourceException
      Description copied from interface: Resource

      Returns the resource last modified time stamp.

      Returns:
      an optional returning the resource last modified time stamp or an empty optional if it couldn't be determined
      Throws:
      ResourceException - if there was an error resolving resource last modified time stamp

    • isFile

      public Optional<Boolean> isFile() throws ResourceException
      Description copied from interface: Resource

      Determines whether this resource represents a file.

      A file resource is a resource that can be accessed through a FileChannel.

      Returns:
      an optional returning true if the resource is a file, false otherwise or an empty optional if it couldn't be determined
      Throws:
      ResourceException - if there was an error determining whether the resource is a file

    • size

      public Optional<Long> size() throws ResourceException
      Description copied from interface: Resource

      Returns the resource content size.

      Returns:
      an optional returning the resource content size or an empty optional if it couldn't be determined
      Throws:
      ResourceException - if there was an error resolving resource content size

    • openReadableByteChannel

      public Optional<ReadableByteChannel> openReadableByteChannel() throws ResourceException
      Description copied from interface: Resource

      Opens a readable byte channel to the resource.

      The caller is responsible for closing the channel to prevent resource leak.

      Returns:
      an optional returning a readable byte channel or an empty optional if the resource is not readable
      Throws:
      ResourceException - if there was an error opening the readable byte channel

    • openWritableByteChannel

      public Optional<WritableByteChannel> openWritableByteChannel(boolean append, boolean createParents) throws ResourceException
      Description copied from interface: Resource

      Opens a writable byte channel to the resource that will append or not content to an existing resource and create or not missing parent directories.

      The caller is responsible for closing the channel to prevent resource leak.

      Parameters:
      append - true to append content to an existing resource
      createParents - true to create missing parent directories
      Returns:
      an optional returning a writable byte channel or an empty optional if the resource is not writable
      Throws:
      ResourceException - if there was an error opening the writable byte channel

    • delete

      public boolean delete() throws ResourceException
      Description copied from interface: Resource

      Deletes the resource.

      Returns:
      true if the resource had been deleted, false otherwise
      Throws:
      ResourceException - if there was an error deleting to the resource

    • resolve

      public Resource resolve(Path path) throws ResourceException
      Description copied from interface: Resource

      Resolves the specified URI against the resource URI as defined by Path.resolve(Path).

      Parameters:
      path - the path to resolve
      Returns:
      a new resource resulting from the resolution of the specified path against the resource
      Throws:
      ResourceException - if there was an error resolving the resource

    • close

      public void close()