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

Class ZipResource

java.lang.Object
io.inverno.mod.base.resource.AbstractResource
io.inverno.mod.base.resource.AbstractAsyncResource
io.inverno.mod.base.resource.ZipResource
All Implemented Interfaces:
AsyncResource, Resource, AutoCloseable
Direct Known Subclasses:
JarResource
public class ZipResource extends AbstractAsyncResource

A Resource implementation that identifies resources by a URI of the form zip:file:/path/to/zip!/path/to/resource and looks up data in a zip file on the file system system.

A typical usage is: 


 ZipResource resource = new ZipResource(URI.create("zip:file:/path/to/zip!/path/to/resource"));
 ...
Since:
1.0
Author:
Jeremy Kuhn
See Also:

  • Field Details

    • SCHEME_ZIP

      public static final String SCHEME_ZIP
      The zip resource scheme
      See Also:

    • SCHEME_JAR

      public static final String SCHEME_JAR
      The jar resource scheme
      See Also:

    • zipUri

      protected final URI zipUri
      The URI of the ZIP file.

    • zipFsUri

      protected final URI zipFsUri
      The URI of the ZIP file system.

    • resourcePath

      protected final Path resourcePath
      The path to the resource in the ZIP file.

  • Constructor Details

    • ZipResource

      public ZipResource(URI uri) throws IllegalArgumentException

      Creates a zip resource with the specified URI.

      Parameters:
      uri - the resource URI
      Throws:
      IllegalArgumentException - if the specified URI does not designate a zip resource

    • ZipResource

      public ZipResource(URI uri, MediaTypeService mediaTypeService) throws IllegalArgumentException

      Creates a zip resource with the specified URI and media type service.

      Parameters:
      uri - the resource URI
      mediaTypeService - a media type service
      Throws:
      IllegalArgumentException - if the specified URI does not designate a zip resource

    • ZipResource

      protected ZipResource(URI uri, String scheme) throws IllegalArgumentException

      Creates a zip-like resource with the specified URI and scheme.

      Parameters:
      uri - the resource URI
      scheme - the visible resource scheme (ie. zip, jar...)
      Throws:
      IllegalArgumentException - if the specified URI does not designate a resource of the specified scheme

    • ZipResource

      protected ZipResource(URI uri, String scheme, MediaTypeService mediaTypeService) throws IllegalArgumentException

      Creates a zip-like resource with the specified URI, scheme and media type service.

      Parameters:
      uri - the resource URI
      scheme - the visible resource scheme (ie. zip, jar...)
      mediaTypeService - a media type service
      Throws:
      IllegalArgumentException - if the specified URI does not designate a resource of the specified scheme

  • Method Details

    • checkUri

      public static URI checkUri(URI uri) throws IllegalArgumentException

      Checks that the specified URI is a zip resource URI.

      Parameters:
      uri - the uri to check
      Returns:
      the uri if it is a zip resource URI
      Throws:
      IllegalArgumentException - if the specified URI does not designate a zip resource

    • setExecutor

      public void setExecutor(ExecutorService executor)
      Description copied from interface: AsyncResource

      Sets the executor service to use when reading or writing the resource asynchronously.

      Specified by:
      setExecutor in interface AsyncResource
      Overrides:
      setExecutor in class AbstractAsyncResource
      Parameters:
      executor - the executor service to set

    • 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

    • 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

    • 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

    • 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

    • read

      public Publisher<ByteBuf> read() throws NotReadableResourceException, ResourceException
      Description copied from interface: Resource

      Reads the resource in a reactive way.

      Specified by:
      read in interface Resource
      Overrides:
      read in class AbstractAsyncResource
      Returns:
      a stream of ByteBuf
      Throws:
      NotReadableResourceException - if the resource is not readable
      ResourceException - if there was an error reading the resource

    • write

      public Publisher<Integer> write(Publisher<ByteBuf> data, boolean append, boolean createParents) throws NotWritableResourceException, ResourceException
      Description copied from interface: Resource

      Writes content to the resource in a reactive way appending or not content to an existing resource and create or not missing parent directories.

      Specified by:
      write in interface Resource
      Overrides:
      write in class AbstractAsyncResource
      Parameters:
      data - the stream of data to write
      append - true to append content to an existing resource
      createParents - true to create missing parent directories
      Returns:
      a stream of integer emitting number of bytes written
      Throws:
      ResourceException - if there was an error writing to the resource
      NotWritableResourceException

    • 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()