net.java.truevfs.comp.zipdriver

Class AbstractKeyController

java.lang.Object

net.java.truecommons.shed.UniqueObject

net.java.truevfs.kernel.spec.FsAbstractController

net.java.truevfs.kernel.spec.FsDecoratingController

net.java.truevfs.comp.zipdriver.AbstractKeyController

All Implemented Interfaces:

FsController

@Immutable
public abstract class AbstractKeyController
extends FsDecoratingController

This file system controller decorates another file system controller in order to manage the keys required for accessing encrypted ZIP files.

Author:

Christian Schlichtherle

Nested Class Summary

Nested classes/interfaces inherited from interface net.java.truevfs.kernel.spec.FsController

FsController.Factory<Context>

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractZipDriver<?>	driver

Fields inherited from class net.java.truevfs.kernel.spec.FsDecoratingController

controller

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractKeyController(FsController controller, AbstractZipDriver<?> driver) Constructs a new key manager controller.

Method Summary

Modifier and Type	Method and Description
void	checkAccess(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name, net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types) Checks if the file system node for the given name exists when constrained by the given access options and permits the given access types.
protected abstract Class<? extends IOException>	getKeyExceptionType()
protected abstract Class<?>	getKeyType()
FsNode	node(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Returns the file system node for the given name or null if it doesn't exist.
void	sync(net.java.truecommons.shed.BitField<FsSyncOption> options) Commits all unsynchronized changes to the contents of this file system to its parent file system, releases the associated resources (e.g.
void	unlink(net.java.truecommons.shed.BitField<FsAccessOption> options, FsNodeName name) Removes the named file system node from the file system.

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

getParent, input, make, output, setReadOnly, setTime, setTime, toString

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

getModel, getMountPoint, isMounted, setMounted

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

driver

protected final AbstractZipDriver<?> driver

Constructor Detail

AbstractKeyController

protected AbstractKeyController(FsController controller,
                                AbstractZipDriver<?> driver)

Constructs a new key manager controller.

Parameters:

controller - the non-null file system controller to decorate.

driver - the ZIP driver.

Method Detail

checkAccess

public void checkAccess(net.java.truecommons.shed.BitField<FsAccessOption> options,
                        FsNodeName name,
                        net.java.truecommons.shed.BitField<net.java.truecommons.cio.Entry.Access> types)
                 throws IOException

Description copied from interface: FsController

Checks if the file system node for the given name exists when constrained by the given access options and permits the given access types.

Specified by:

checkAccess in interface FsController

Overrides:

checkAccess in class FsDecoratingController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

types - the types of the desired access.

Throws:

IOException - on any I/O error.

getKeyExceptionType

protected abstract Class<? extends IOException> getKeyExceptionType()

getKeyType

protected abstract Class<?> getKeyType()

node

public final FsNode node(net.java.truecommons.shed.BitField<FsAccessOption> options,
                         FsNodeName name)
                  throws IOException

Description copied from interface: FsController

Returns the file system node for the given name or null if it doesn't exist. Modifying the returned node does not show any effect on the file system and should result in an UnsupportedOperationException.

Specified by:

node in interface FsController

Overrides:

node in class FsDecoratingController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Returns:

A file system node or null if no file system node exists for the given name.

Throws:

IOException - on any I/O error.

sync

public void sync(net.java.truecommons.shed.BitField<FsSyncOption> options)
          throws FsSyncException

Description copied from interface: FsController

Commits all unsynchronized changes to the contents of this file system to its parent file system, releases the associated resources (e.g. target archive files) for access by third parties (e.g. other processes), cleans up any temporary allocated resources (e.g. temporary files) and purges any cached data. Note that temporary resources may get allocated even if the federated file systems were accessed read-only. If this is not a federated file system, i.e. if its not a member of a parent file system, then nothing happens. Otherwise, the state of this file system controller is reset.

An implementation may ignore calls to this method if its stateless.

Specified by:

sync in interface FsController

Overrides:

sync in class FsDecoratingController

Parameters:

options - the options for synchronizing the file system.

Throws:

FsSyncWarningException - if only warning conditions apply. This implies that the respective parent file system has been synchronized with constraints, e.g. if an unclosed archive entry stream gets forcibly closed.

FsSyncException - if any error conditions apply.

unlink

public final void unlink(net.java.truecommons.shed.BitField<FsAccessOption> options,
                         FsNodeName name)
                  throws IOException

Description copied from interface: FsController

Removes the named file system node from the file system. If the named file system node is a directory, it must be empty.

Specified by:

unlink in interface FsController

Overrides:

unlink in class FsDecoratingController

Parameters:

options - the options for accessing the file system node.

name - the name of the file system node.

Throws:

IOException - on any I/O error.