net.java.truevfs.comp.zipdriver

Class AbstractZipDriver<E extends AbstractZipDriverEntry>

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsDriver

net.java.truevfs.kernel.spec.FsArchiveDriver<E>

net.java.truevfs.comp.zipdriver.AbstractZipDriver<E>

Type Parameters:

E - the type of the ZIP driver entries.

All Implemented Interfaces:

net.java.truevfs.comp.zip.ZipCharsetParameters, net.java.truevfs.comp.zip.ZipEntryFactory<E>, net.java.truevfs.comp.zip.ZipFileParameters<E>, net.java.truevfs.comp.zip.ZipOutputStreamParameters, net.java.truevfs.comp.zip.ZipParameters, net.java.truevfs.kernel.spec.FsController.Factory<net.java.truevfs.kernel.spec.FsManager>, net.java.truevfs.kernel.spec.FsModel.Factory<net.java.truevfs.kernel.spec.FsManager>

Direct Known Subclasses:

JarDriver, ZipDriver

@Immutable
public abstract class AbstractZipDriver<E extends AbstractZipDriverEntry>
extends net.java.truevfs.kernel.spec.FsArchiveDriver<E>
implements net.java.truevfs.comp.zip.ZipOutputStreamParameters, net.java.truevfs.comp.zip.ZipFileParameters<E>

An abstract archive driver for the ZIP file format.

Sub-classes must be thread-safe and should be immutable!

Constructor Summary

Constructors

Constructor and Description
AbstractZipDriver()

Method Summary

Modifier and Type	Method and Description
boolean	check(E local, ZipInputService<E> input) Whether or not the content of the given entry shall get checked/authenticated when reading it.
net.java.truevfs.kernel.spec.FsController	decorate(net.java.truevfs.kernel.spec.FsController controller)
java.net.URI	fileSystemUri(net.java.truevfs.kernel.spec.FsModel model, java.lang.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.
net.java.truecommons.key.spec.KeyManagerMap	getKeyManagerMap() Returns the map of key managers for accessing protected resources (encryption).
int	getLevel()
int	getMethod()
int	getOverheadSize()
net.java.truecommons.cio.IoBufferPool	getPool()
boolean	getPostambled()
boolean	getPreambled()
boolean	getRedundantContentSupport()
boolean	getRedundantMetaDataSupport()
java.net.URI	mountPointUri(net.java.truevfs.kernel.spec.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.
E	newEntry(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption> options, java.lang.String name, net.java.truecommons.cio.Entry.Type type, net.java.truecommons.cio.Entry template)
abstract E	newEntry(java.lang.String name) Returns a new ZIP driver entry with the given name.
abstract E	newEntry(java.lang.String name, net.java.truevfs.comp.zip.ZipEntry template) Returns a new ZIP driver entry with the given name and all other properties copied from the given template.
protected ZipInputService<E>	newInput(net.java.truevfs.kernel.spec.FsModel model, net.java.truevfs.kernel.spec.FsInputSocketSource source)
protected net.java.truecommons.cio.OutputService<E>	newOutput(net.java.truevfs.kernel.spec.FsModel model, net.java.truevfs.kernel.spec.FsOutputSocketSink sink, net.java.truecommons.cio.InputService<E> input)
protected ZipInputService<E>	newZipInput(net.java.truevfs.kernel.spec.FsModel model, net.java.truevfs.kernel.spec.FsInputSocketSource source)
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).
protected net.java.truevfs.kernel.spec.FsOutputSocketSink	sink(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption> options, net.java.truevfs.kernel.spec.FsController controller, net.java.truevfs.kernel.spec.FsNodeName name) This implementation transforms options in the following way before it forwards the call to controller: FsAccessOption.STORE is set.
protected net.java.truevfs.comp.zip.ZipCryptoParameters	zipCryptoParameters(net.java.truevfs.kernel.spec.FsModel model, java.nio.charset.Charset charset) Returns the ZIP crypto parameters for the given file system model and character set or null if not available.

Methods inherited from class net.java.truevfs.kernel.spec.FsArchiveDriver

checkEncodable, getCharset, isArchiveDriver, newController, newEntry, newInput, newOutput, normalize, source, toString

Methods inherited from class net.java.truevfs.kernel.spec.FsDriver

decorate, newModel

Methods inherited from class net.java.truecommons.shed.UniqueObject

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.java.truevfs.comp.zip.ZipCharsetParameters

getCharset

Constructor Detail

AbstractZipDriver

public AbstractZipDriver()

Method Detail

getPool

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

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

Specified by:

getPool in class net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

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.

zipCryptoParameters

@CheckForNull
protected net.java.truevfs.comp.zip.ZipCryptoParameters zipCryptoParameters(net.java.truevfs.kernel.spec.FsModel model,
                                                                                          java.nio.charset.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.

mountPointUri

public java.net.URI mountPointUri(net.java.truevfs.kernel.spec.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

fileSystemUri

public java.net.URI fileSystemUri(net.java.truevfs.kernel.spec.FsModel model,
                                  java.lang.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.

getRedundantContentSupport

public boolean getRedundantContentSupport()

Overrides:

getRedundantContentSupport in class net.java.truevfs.kernel.spec.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 net.java.truevfs.kernel.spec.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.

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

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 safe 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).

getPreambled

public boolean getPreambled()

The implementation in the class ZipDriver returns false.

Specified by:

getPreambled in interface net.java.truevfs.comp.zip.ZipFileParameters<E extends AbstractZipDriverEntry>

Returns:

false

getPostambled

public boolean getPostambled()

The implementation in the class ZipDriver returns false.

Specified by:

getPostambled in interface net.java.truevfs.comp.zip.ZipFileParameters<E extends AbstractZipDriverEntry>

Returns:

false

getOverheadSize

public int getOverheadSize()

The implementation in the class ZipDriver returns Maps#OVERHEAD_SIZE.

Specified by:

getOverheadSize in interface net.java.truevfs.comp.zip.ZipOutputStreamParameters

Returns:

Maps#OVERHEAD_SIZE

getMethod

public int getMethod()

The implementation in the class ZipDriver returns ZipEntry#DEFLATED.

Specified by:

getMethod in interface net.java.truevfs.comp.zip.ZipOutputStreamParameters

Returns:

ZipEntry#DEFLATED

getLevel

public int getLevel()

The implementation in the class ZipDriver returns Deflater#BEST_COMPRESSION.

Specified by:

getLevel in interface net.java.truevfs.comp.zip.ZipOutputStreamParameters

Returns:

Deflater#BEST_COMPRESSION

decorate

public net.java.truevfs.kernel.spec.FsController decorate(net.java.truevfs.kernel.spec.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, e.g. the encryption passwords. This method should be overridden in order to return just controller if and only if you are overriding zipCryptoParameters(FsModel, Charset), too, and do not want to use a locatable key manager to resolve passwords for WinZip AES encryption.

Overrides:

decorate in class net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

newInput

protected final ZipInputService<E> newInput(net.java.truevfs.kernel.spec.FsModel model,
                                            net.java.truevfs.kernel.spec.FsInputSocketSource source)
                                     throws java.io.IOException

Specified by:

newInput in class net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

Throws:

java.io.IOException

newZipInput

@CreatesObligation
protected ZipInputService<E> newZipInput(net.java.truevfs.kernel.spec.FsModel model,
                                                            net.java.truevfs.kernel.spec.FsInputSocketSource source)
                                                     throws java.io.IOException

Throws:

java.io.IOException

newOutput

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

Specified by:

newOutput in class net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

Throws:

java.io.IOException

sink

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

This implementation transforms 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 be 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 net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

newEntry

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

Specified by:

newEntry in class net.java.truevfs.kernel.spec.FsArchiveDriver<E extends AbstractZipDriverEntry>

newEntry

public abstract E newEntry(java.lang.String name)

Returns a new ZIP driver entry with the given name.

Specified by:

newEntry in interface net.java.truevfs.comp.zip.ZipEntryFactory<E extends AbstractZipDriverEntry>

Parameters:

name - the entry name.

Returns:

A new abstract ZIP driver entry.

newEntry

public abstract E newEntry(java.lang.String name,
                           net.java.truevfs.comp.zip.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.