net.java.truevfs.driver.sfx

Class ReadOnlySfxDriver

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<ZipDriverEntry>

net.java.truevfs.comp.zipdriver.ZipDriver

net.java.truevfs.driver.sfx.ReadOnlySfxDriver

All Implemented Interfaces:

ZipCharsetParameters, ZipEntryFactory<ZipDriverEntry>, ZipFileParameters<ZipDriverEntry>, ZipOutputStreamParameters, ZipParameters, FsController.Factory<FsManager>, FsModel.Factory<FsManager>

Direct Known Subclasses:

CheckedReadOnlySfxDriver

@Immutable
public class ReadOnlySfxDriver
extends ZipDriver

An archive driver which reads Self Executable (SFX/EXE) ZIP files, but doesn't support to create or update them because this would spoil the SFX code in its preamble.

Subclasses must be thread-safe and should be immutable!

Author:

Christian Schlichtherle

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	SFX_CHARSET The character set for entry names and comments, which is the default character set.

Fields inherited from class net.java.truevfs.comp.zipdriver.ZipDriver

ZIP_CHARSET

Constructor Summary

Constructors

Constructor and Description
ReadOnlySfxDriver()

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file.
boolean	getPreambled() Returns the flag for supporting preambles.
net.java.truecommons.cio.OutputService<ZipDriverEntry>	newOutput(FsModel model, net.java.truecommons.shed.BitField<FsAccessOption> options, FsController controller, FsNodeName name, net.java.truecommons.cio.InputService<ZipDriverEntry> input) This method gets called by an archive controller in order to create a new output service for its target archive file.

Methods inherited from class net.java.truevfs.comp.zipdriver.ZipDriver

newEntry, newEntry

Methods inherited from class net.java.truevfs.comp.zipdriver.AbstractZipDriver

check, decorate, fileSystemUri, getKeyManagerMap, getLevel, getMethod, getOverheadSize, getPool, getPostambled, getRedundantContentSupport, getRedundantMetaDataSupport, mountPointUri, newEntry, newInput, newOutput, newZipInput, rdc, sink, zipCryptoParameters

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

checkEncodable, isArchiveDriver, newController, newEntry, newInput, 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

Field Detail

SFX_CHARSET

public static final Charset SFX_CHARSET

The character set for entry names and comments, which is the default character set.

Constructor Detail

ReadOnlySfxDriver

public ReadOnlySfxDriver()

Method Detail

getCharset

public Charset getCharset()

Returns the character set to use for encoding character based meta data such as entry names or file comments to binary data when writing an archive file. Depending on the archive file format, this may get used for decoding binary data when reading an archive file, too.

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

Specified by:

getCharset in interface ZipCharsetParameters

Overrides:

getCharset in class ZipDriver

Returns:

SFX_CHARSET.

getPreambled

public final boolean getPreambled()

Returns the flag for supporting preambles. If this method returns true, then a ZIP file is allowed to contain arbitrary data as its preamble before the actual ZIP file data. Self Extracting Archives typically use a preamble to store the application code that is required to extract the ZIP file contents.

If this method returns false, then a ZIP file must start with either a Local File Header (LFH) signature, a ZIP64 End Of Central Directory Record (EOCDR) signature or an End Of Central Directory Record (EOCDR) signature.

The implementation in the class ZipDriver returns false.

The implementation in the class ZipDriver returns true.

Specified by:

getPreambled in interface ZipFileParameters<ZipDriverEntry>

Overrides:

getPreambled in class AbstractZipDriver<ZipDriverEntry>

Returns:

true

newOutput

public final net.java.truecommons.cio.OutputService<ZipDriverEntry> newOutput(FsModel model,
                                                                              net.java.truecommons.shed.BitField<FsAccessOption> options,
                                                                              FsController controller,
                                                                              FsNodeName name,
                                                                              @CheckForNull @WillNotClose
                                                                              net.java.truecommons.cio.InputService<ZipDriverEntry> input)
                                                                       throws IOException

Description copied from class: FsArchiveDriver

This method gets called by an archive controller in order to create a new output service for its target archive file.

The implementation in FsArchiveDriver simply forwards the call to FsArchiveDriver.sink(net.java.truecommons.shed.BitField<net.java.truevfs.kernel.spec.FsAccessOption>, net.java.truevfs.kernel.spec.FsController, net.java.truevfs.kernel.spec.FsNodeName) and FsArchiveDriver.newOutput(FsModel, FsOutputSocketSink, InputService).

Overrides:

newOutput in class FsArchiveDriver<ZipDriverEntry>

Parameters:

model - the file system model for the target archive file.

options - the options for accessing the target archive file in the parent file system.

controller - the controller for the parent file system with the target archive file.

name - the node name of the target archive file in the parent file system.

input - the nullable InputService for the target archive file. If not null, then the target archive file is going to get updated. This parameter is guaranteed to be the product of this driver's factory method FsArchiveDriver.newInput(FsModel, BitField, FsController, FsNodeName).

Returns:

A new output service for writing the target archive file. Note that this service does not need to be thread-safe!

Throws:

IOException - on any I/O error.