Constructor Detail

• AbstractZipDriver

  public AbstractZipDriver()

Method Detail

• check

  public boolean check(E local,
              @WillNotClose
              ZipInputService<E> input)

  Whether or not the content of the given entry shall get checked/authenticated when reading it. If this method returns true and the check fails, then an IOException gets thrown.

  Parameters:

  local - the entry to test.

  input - the origin of the entry.

  Returns:

  entry.isEncrypted().

• decorate

  public FsController decorate(FsController controller)

  The implementation in the class ZipDriver decorates the given controller with a package private controller which keeps track of the AES PBE parameters. This should pool overridden in order to return just controller if and only if you are overriding zipCryptoParameters(FsModel, Charset), too, and do not want to use the locatable key manager to resolve passwords, e.g. for WinZip AES encryption.

  Overrides:

  decorate in class FsArchiveDriver<E extends AbstractZipDriverEntry>

• fileSystemUri

  public URI fileSystemUri(FsModel model,
                  String name)

  A template method for resolving the resource URI which is required to look up the KeyProvider for the entry with the given name in the file system with the given model.

  The implementation in the class ZipDriver ignores the given entry name and just returns the expression mountPointUri(model) in order to lookup the same key provider for all entries in a ZIP file.

  An alternative implementation in a sub-class could return the expression mountPointUri(model).resolve("/" + name) instead.

  Parameters:

  model - the file system model.

  name - the entry name.

  Returns:

  The URI for looking up a KeyProvider.

• getKeyManagerMap

  public net.java.truecommons.key.spec.KeyManagerMap getKeyManagerMap()

  Returns the map of key managers for accessing protected resources (encryption).

  This is an immutable property - multiple calls must return the same object.

  Returns:

  KeyManagerMapLocator.SINGLETON, as by the implementation in the class ZipDriver.

• getLevel

  public int getLevel()

  The implementation in the class ZipDriver returns Deflater#BEST_COMPRESSION.

  Specified by:

  getLevel in interface ZipOutputStreamParameters

  Returns:

  Deflater#BEST_COMPRESSION

• getMethod

  public int getMethod()

  The implementation in the class ZipDriver returns ZipEntry#DEFLATED.

  Specified by:

  getMethod in interface ZipOutputStreamParameters

  Returns:

  ZipEntry#DEFLATED

• getOverheadSize

  public int getOverheadSize()

  The implementation in the class ZipDriver returns Maps#OVERHEAD_SIZE.

  Specified by:

  getOverheadSize in interface ZipOutputStreamParameters

  Returns:

  Maps#OVERHEAD_SIZE

• getPool

  public net.java.truecommons.cio.IoBufferPool getPool()

  The implementation in the class AbstractZipDriver returns IoBufferPoolLocator.SINGLETON.get().

  Specified by:

  getPool in class FsArchiveDriver<E extends AbstractZipDriverEntry>

• getPostambled

  public boolean getPostambled()

  The implementation in the class ZipDriver returns false.

  Specified by:

  getPostambled in interface ZipFileParameters<E extends AbstractZipDriverEntry>

  Returns:

  false

• getPreambled

  public boolean getPreambled()

  The implementation in the class ZipDriver returns false.

  Specified by:

  getPreambled in interface ZipFileParameters<E extends AbstractZipDriverEntry>

  Returns:

  false

• getRedundantContentSupport

  public boolean getRedundantContentSupport()

  Overrides:

  getRedundantContentSupport in class FsArchiveDriver<E extends AbstractZipDriverEntry>

  Returns:

  The implementation in the class ZipDriver returns true because when reading a ZIP file sequentially, each ZIP entry should "override" any previously read ZIP entry with an equal name. This holds true even if the central directory is used to access the ZIP entries in random order.

• getRedundantMetaDataSupport

  public boolean getRedundantMetaDataSupport()

  Overrides:

  getRedundantMetaDataSupport in class FsArchiveDriver<E extends AbstractZipDriverEntry>

  Returns:

  The implementation in the class ZipDriver returns true because when reading a ZIP file sequentially, each ZIP entry should "override" any previously read ZIP entry with an equal name. This holds true even if the central directory is used to access the ZIP entries in random order.

• mountPointUri

  public URI mountPointUri(FsModel model)

  A template method for resolving the resource URI which is required to look up the KeyProvider for the mount point of the file system with the given model.

  The implementation in the class ZipDriver returns the expression model.getMountPoint().toHierarchicalUri() in order to improve the readability of the URI in comparison to the expression model.getMountPoint().getUri().

  Parameters:

  model - the file system model.

  Returns:

  The URI which represents the file system model's mount point.

  See Also:

  #TRUEZIP-72

• newEntry

  public E newEntry(net.java.truecommons.shed.BitField<FsAccessOption> options,
           String name,
           net.java.truecommons.cio.Entry.Type type,
           @CheckForNull
           net.java.truecommons.cio.Entry template)

  Specified by:

  newEntry in class FsArchiveDriver<E extends AbstractZipDriverEntry>

• newEntry

  public abstract E newEntry(String name)

  Returns a new ZIP driver entry with the given name.

  Specified by:

  newEntry in interface ZipEntryFactory<E extends AbstractZipDriverEntry>

  Parameters:

  name - the entry name.

  Returns:

  A new abstract ZIP driver entry.

• newEntry

  public abstract E newEntry(String name,
           ZipEntry template)

  Returns a new ZIP driver entry with the given name and all other properties copied from the given template.

  Parameters:

  name - the entry name.

  template - the template entry.

  Returns:

  A new ZIP driver entry.

• newInput

  protected final ZipInputService<E> newInput(FsModel model,
                            FsInputSocketSource source)
                                                                      throws IOException

  Specified by:

  newInput in class FsArchiveDriver<E extends AbstractZipDriverEntry>

  Throws:

  IOException

• newOutput

  @CreatesObligation
  protected net.java.truecommons.cio.OutputService<E> newOutput(FsModel model,
                                                                      FsOutputSocketSink sink,
                                                                      @CheckForNull@WillNotClose
                                                                      net.java.truecommons.cio.InputService<E> input)
                                                                                        throws IOException

  Specified by:

  newOutput in class FsArchiveDriver<E extends AbstractZipDriverEntry>

  Throws:

  IOException

• newZipInput

  @CreatesObligation
  protected ZipInputService<E> newZipInput(FsModel model,
                                                 FsInputSocketSource source)
                                                                   throws IOException

  Throws:

  IOException

• rdc

  protected boolean rdc(AbstractZipDriverEntry input,
            AbstractZipDriverEntry output)

  Returns true if and only if the content of the given input target entry is eligible for Raw Data Copying (RDC). This method gets called twice (once on each side of a copy operation) and should return false unless both target entries can mutually agree on transferring raw (unprocessed) content. Note that it is an error to compare the properties of the target entries because this method may get called before the output target entry gets mutated to compare equal with the input target entry!

  The implementation in the class ZipDriver returns !local.isEncrypted() && !remote.isEncrypted() in order to cover the typical case that the cipher keys of both targets are not the same. Note that there is no secure way to explicitly test for this.

  Parameters:

  input - the input target entry for copying the contents.

  output - the output target entry for copying the contents.

  Returns:

  Whether the content to get copied from the input target entry to the output target entry is eligible for Raw Data Copying (RDC).

• rdc

  public final boolean rdc(@WillNotClose
            ZipInputService<E> input,
            E local,
            AbstractZipDriverEntry peer)

• rdc

  public final boolean rdc(@WillNotClose
            ZipOutputService<E> output,
            E local,
            AbstractZipDriverEntry peer)

• sink

  protected FsOutputSocketSink sink(net.java.truecommons.shed.BitField<FsAccessOption> options,
                        FsController controller,
                        FsNodeName name)

  This implementation modifies options in the following way before it forwards the call to controller:

  1. FsAccessOption.STORE is set.
  2. If FsAccessOption.GROW is set, then FsAccessOption.APPEND gets set, too, and FsAccessOption.CACHE gets cleared.

  The resulting output socket is then wrapped in a private nested class for an upcast in newOutput(net.java.truevfs.kernel.spec.FsModel, net.java.truevfs.kernel.spec.FsOutputSocketSink, net.java.truecommons.cio.InputService<E>). Thus, when overriding this method, newOutput(net.java.truevfs.kernel.spec.FsModel, net.java.truevfs.kernel.spec.FsOutputSocketSink, net.java.truecommons.cio.InputService<E>) should get overridden, too. Otherwise, a class cast exception will pool thrown in newOutput(net.java.truevfs.kernel.spec.FsModel, net.java.truevfs.kernel.spec.FsOutputSocketSink, net.java.truecommons.cio.InputService<E>).

  Overrides:

  sink in class FsArchiveDriver<E extends AbstractZipDriverEntry>

• zipCryptoParameters

  @CheckForNull
  protected ZipCryptoParameters zipCryptoParameters(FsModel model,
                                                     Charset charset)

  Returns the ZIP crypto parameters for the given file system model and character set or null if not available. To enable the use of this method when writing an archive entry with the client APIs, you must use FsAccessOption.ENCRYPT.

  The implementation in the class ZipDriver returns new KeyManagerZipCryptoParameters(this, model, charset).

  Parameters:

  model - the file system model.

  charset - charset the character set used for encoding entry names and the file comment in the ZIP file.

  Returns:

  The ZIP crypto parameters for the given file system model and character set or null if not available.

• zipCryptoParameters

  @CheckForNull
  public final ZipCryptoParameters zipCryptoParameters(ZipInputService<E> input)

• zipCryptoParameters

  @CheckForNull
  public final ZipCryptoParameters zipCryptoParameters(ZipOutputService<E> output)