FsFalsePositiveController (TrueZIP Kernel 7.5.1 API)

java.lang.Object
- de.schlichtherle.truezip.fs.FsController<M>
- - de.schlichtherle.truezip.fs.FsModelController<M>
  - - de.schlichtherle.truezip.fs.FsDecoratingController<FsModel,FsController<?>>
    - - de.schlichtherle.truezip.fs.FsFalsePositiveController

```
@ThreadSafe
final class FsFalsePositiveController
extends FsDecoratingController<FsModel,FsController<?>>
```
Implements a chain of responsibility in order to resolve FsFalsePositiveExceptions thrown by the prospective file system provided to its constructor.
Whenever the controller for the prospective file system throws a FsFalsePositiveException, the method call is delegated to the controller for its parent file system in order to resolve the requested operation. If this method call fails with a second exception, then the IOException which is associated as the cause of the first exception gets rethrown unless the second exception is an FsControllerException. In this case the FsControllerException gets rethrown as is in order to enable the caller to resolve it.
This algorithm effectively achieves the following objectives:
1. False positive federated file systems (i.e. false positive archive files) get resolved correctly by accessing them as entities of the parent file system.
2. If the file system driver for the parent file system throws another exception, then it gets discarded and the exception initially thrown by the file system driver for the false positive archive file takes its place in order to provide the caller with a good indication of what went wrong in the first place.
3. Exceptions which are thrown by the TrueZIP Kernel itself identify themselves by the type FsControllerException. They are excempt from this masquerade in order to support resolving them by a more competent caller.
As an example consider accessing a RAES encrypted ZIP file: With the default driver configuration of the module TrueZIP ZIP.RAES, whenever a ZIP.RAES file gets mounted, the user is prompted for a password. If the user cancels the password prompting dialog, then an appropriate exception gets thrown. The target archive controller would then catch this exception and flag the archive file as a false positive by wrapping this exception in a FsFalsePositiveException. This class would then catch this false positive exception and try to resolve the issue by using the parent file system controller. Failing that, the initial exception would get rethrown in order to signal to the caller that the user had cancelled password prompting.
Author:

Christian Schlichtherle

See Also:
FsFalsePositiveException

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`FsFalsePositiveController.GetClosedIcon`
`private static class`	`FsFalsePositiveController.GetEntry`
`(package private) static class`	`FsFalsePositiveController.GetOpenIcon`
`private static interface`	`FsFalsePositiveController.IOOperation<T>`
`private static class`	`FsFalsePositiveController.IsExecutable`
`private static class`	`FsFalsePositiveController.IsReadable`
`private static class`	`FsFalsePositiveController.IsReadOnly`
`private static class`	`FsFalsePositiveController.IsWritable`
`private static class`	`FsFalsePositiveController.SetReadOnly`
`private static interface`	`FsFalsePositiveController.State`
`private class`	`FsFalsePositiveController.TryChild`
`private class`	`FsFalsePositiveController.UseParent`

Field Summary

Fields
Modifier and Type Field and Description

private FsController<?> parent

private FsPath path

private FsFalsePositiveController.State state
- Fields inherited from class de.schlichtherle.truezip.fs.FsDecoratingController
  delegate

Fields
Modifier and Type	Field and Description
`private FsController<?>`	`parent`
`private FsPath`	`path`
`private FsFalsePositiveController.State`	`state`

Constructor Summary

Constructors
Constructor and Description

FsFalsePositiveController(FsController<?> controller)
Constructs a new false positive file system controller.

Constructors
Constructor and Description
`FsFalsePositiveController(FsController<?> controller)` Constructs a new false positive file system controller.

Method Summary

Methods
Modifier and Type	Method and Description
`(package private) <T> T`	`call(FsFalsePositiveController.IOOperation<T> operation, FsEntryName name)`
`Icon`	`getClosedIcon()` Deprecated.
`FsEntry`	`getEntry(FsEntryName name)` Returns the file system entry for the given name or `null` if it doesn't exist.
`InputSocket<?>`	`getInputSocket(FsEntryName name, BitField<FsInputOption> options)` Returns an input socket for reading the contents of the file system entry addressed by the given name from the file system.
`Icon`	`getOpenIcon()` Deprecated.
`OutputSocket<?>`	`getOutputSocket(FsEntryName name, BitField<FsOutputOption> options, Entry template)` Returns an output socket for writing the contents of the entry addressed by the given name to the file system.
`FsController<?>`	`getParent()` Returns the controller for the parent file system or `null` if and only if this file system is not federated, i.e. not a member of another file system.
`private FsPath`	`getPath()`
`boolean`	`isExecutable(FsEntryName name)` Returns `false` if the named file system entry is not executable.
`boolean`	`isReadable(FsEntryName name)` Returns `false` if the named file system entry is not readable.
`boolean`	`isReadOnly()` Returns `true` if and only if the file system is read-only.
`boolean`	`isWritable(FsEntryName name)` Returns `false` if the named file system entry is not writable.
`void`	`mknod(FsEntryName name, Entry.Type type, BitField<FsOutputOption> options, Entry template)` Creates or replaces and finally links a chain of one or more entries for the given entry `name` into the file system.
`(package private) FsEntryName`	`resolveParent(FsEntryName name)`
`void`	`setReadOnly(FsEntryName name)` Sets the named file system entry as read-only.
`boolean`	`setTime(FsEntryName name, BitField<Entry.Access> types, long value, BitField<FsOutputOption> options)` Makes an attempt to set the last access time of all types in the given bit field for the file system entry with the given name.
`boolean`	`setTime(FsEntryName name, Map<Entry.Access,Long> times, BitField<FsOutputOption> options)` Makes an attempt to set the last access time of all types in the given map for the file system entry with the given name.
`<X extends IOException> void`	`sync(BitField<FsSyncOption> options, ExceptionHandler<? super FsSyncException,X> handler)` 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.
`void`	`unlink(FsEntryName name, BitField<FsOutputOption> options)` Removes the named file system entry from the file system.
`private void`	`unlinkRoot(FsFalsePositiveController.IOOperation<Void> operation)`

Methods inherited from class de.schlichtherle.truezip.fs.FsDecoratingController
toString

Methods inherited from class de.schlichtherle.truezip.fs.FsModelController
getModel, getMountPoint, isTouched, setTouched

Methods inherited from class de.schlichtherle.truezip.fs.FsController
equals, hashCode, sync, sync

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - parent
```
@CheckForNull
private FsController<?> parent
```
  - path
```
@CheckForNull
private FsPath path
```
  - state
```
private volatile FsFalsePositiveController.State state
```
- Constructor Detail
  - FsFalsePositiveController
```
FsFalsePositiveController(FsController<?> controller)
```
    Constructs a new false positive file system controller.
    
    Parameters:
    controller - the decorated file system controller.
- Method Detail
  - call
```
@Nullable
<T> T call(FsFalsePositiveController.IOOperation<T> operation,
                  FsEntryName name)
 throws IOException
```
    Throws:
    
    IOException
  - getClosedIcon
```
@Deprecated
public Icon getClosedIcon()
                   throws IOException
```
    Deprecated.
    
    Description copied from class: FsController
    
    Returns a nullable icon representing the "closed" state when displaying the (federated) file system represented by this controller in a GUI, e.g. a JTree.
    
    Overrides:
    
    getClosedIcon in class FsDecoratingController<FsModel,FsController<?>>
    
    Returns:
    The nullable icon.
    
    Throws:
    
    IOException - on any I/O failure.
  - getEntry
```
public FsEntry getEntry(FsEntryName name)
                 throws IOException
```
    Description copied from class: FsController
    
    Returns the file system entry for the given name or null if it doesn't exist. Modifying the returned entry does not show any effect on the file system and may result in an UnsupportedOperationException.
    
    Overrides:
    
    getEntry in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry.
    
    Returns:
    A file system entry or null if no file system entry exists for the given name.
    
    Throws:
    
    IOException - on any I/O failure.
  - getInputSocket
```
public InputSocket<?> getInputSocket(FsEntryName name,
                            BitField<FsInputOption> options)
```
    Description copied from class: FsController
    
    Returns an input socket for reading the contents of the file system entry addressed by the given name from the file system.
    
    Overrides:
    
    getInputSocket in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    options - the input options.
    
    Returns:
    An InputSocket.
  - getOpenIcon
```
@Deprecated
public Icon getOpenIcon()
                 throws IOException
```
    Deprecated.
    
    Description copied from class: FsController
    
    Returns a nullable icon representing the "open" state when displaying the (federated) file system represented by this controller in a GUI, e.g. a JTree.
    
    Overrides:
    
    getOpenIcon in class FsDecoratingController<FsModel,FsController<?>>
    
    Returns:
    The nullable icon.
    
    Throws:
    
    IOException - on any I/O failure.
  - getOutputSocket
```
public OutputSocket<?> getOutputSocket(FsEntryName name,
                              BitField<FsOutputOption> options,
                              @CheckForNull
                              Entry template)
```
    Description copied from class: FsController
    
    Returns an output socket for writing the contents of the entry addressed by the given name to the file system. If template is not null, then the output entry shall have as many of its properties copied as reasonable, e.g. the last modification time.
    
    Overrides:
    
    getOutputSocket in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - a file system entry name.
    options - a bit field of output options.
    template - a nullable template for the properties of the output entry.
    
    Returns:
    An OutputSocket.
  - getParent
```
public FsController<?> getParent()
```
    Description copied from class: FsController
    
    Returns the controller for the parent file system or null if and only if this file system is not federated, i.e. not a member of another file system. Multiple invocations must return the same object.
    
    Overrides:
    
    getParent in class FsDecoratingController<FsModel,FsController<?>>
    
    Returns:
    The nullable controller for the parent file system.
  - getPath
```
private FsPath getPath()
```
  - isExecutable
```
public boolean isExecutable(FsEntryName name)
                     throws IOException
```
    Description copied from class: FsController
    
    Returns false if the named file system entry is not executable.
    The implementation in the class FsController always returns false.
    
    Overrides:
    
    isExecutable in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry.
    
    Returns:
    false if the named file system entry is not executable.
    
    Throws:
    
    IOException - on any I/O failure.
  - isReadable
```
public boolean isReadable(FsEntryName name)
                   throws IOException
```
    Description copied from class: FsController
    
    Returns false if the named file system entry is not readable.
    
    Overrides:
    
    isReadable in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry.
    
    Returns:
    false if the named file system entry is not readable.
    
    Throws:
    
    IOException - on any I/O failure.
  - isReadOnly
```
public boolean isReadOnly()
                   throws IOException
```
    Description copied from class: FsController
    
    Returns true if and only if the file system is read-only.
    
    Overrides:
    
    isReadOnly in class FsDecoratingController<FsModel,FsController<?>>
    
    Returns:
    true if and only if the file system is read-only.
    
    Throws:
    
    IOException - on any I/O failure.
  - isWritable
```
public boolean isWritable(FsEntryName name)
                   throws IOException
```
    Description copied from class: FsController
    
    Returns false if the named file system entry is not writable.
    
    Overrides:
    
    isWritable in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry.
    
    Returns:
    false if the named file system entry is not writable.
    
    Throws:
    
    IOException - on any I/O failure.
  - mknod
```
public void mknod(FsEntryName name,
         Entry.Type type,
         BitField<FsOutputOption> options,
         @CheckForNull
         Entry template)
           throws IOException
```
    Description copied from class: FsController
    
    Creates or replaces and finally links a chain of one or more entries for the given entry name into the file system.
    Overrides:
    
    mknod in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    type - the file system entry type.
    options - the file system output options. If FsOutputOption.CREATE_PARENTS is set, any missing parent directories will be created and linked into the file system with its last modification time set to the system's current time.
    template - if not null, then the file system entry at the end of the chain shall inherit as much properties from this entry as possible - with the exception of its name and type.
    
    Throws:
    IOException - on any I/O failure, including but not limited to these reasons:
    
    The file system is read only.
    name contains characters which are not supported by the file system.
    The entry already exists and either the option FsOutputOption.EXCLUSIVE is set or the entry is a directory.
    The entry exists as a different type.
    A parent entry exists but is not a directory.
    A parent entry is missing and createParents is false.
  - resolveParent
```
FsEntryName resolveParent(FsEntryName name)
```
  - setReadOnly
```
public void setReadOnly(FsEntryName name)
                 throws IOException
```
    Description copied from class: FsController
    
    Sets the named file system entry as read-only. This method will fail for typical federated (archive) file system controller implementations because they do not support it.
    
    Overrides:
    
    setReadOnly in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the name of the file system entry.
    
    Throws:
    
    IOException - on any I/O failure or if this operation is not supported.
  - setTime
```
public boolean setTime(FsEntryName name,
              BitField<Entry.Access> types,
              long value,
              BitField<FsOutputOption> options)
                throws IOException
```
    Description copied from class: FsController
    
    Makes an attempt to set the last access time of all types in the given bit field for the file system entry with the given name. If false is returned or an IOException is thrown, then still some of the last access times may have been set. Whether or not this is an atomic operation is specific to the implementation.
    
    Overrides:
    
    setTime in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    types - the access types.
    value - the last access time.
    options - the file system output options.
    
    Returns:
    true if and only if setting the access time for all types in types succeeded.
    
    Throws:
    
    IOException - on any I/O failure.
  - setTime
```
public boolean setTime(FsEntryName name,
              Map<Entry.Access,Long> times,
              BitField<FsOutputOption> options)
                throws IOException
```
    Description copied from class: FsController
    
    Makes an attempt to set the last access time of all types in the given map for the file system entry with the given name. If false is returned or an IOException is thrown, then still some of the last access times may have been set. Whether or not this is an atomic operation is specific to the implementation.
    
    Overrides:
    
    setTime in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    times - the access times.
    options - the file system output options.
    
    Returns:
    true if and only if setting the access time for all types in times succeeded.
    
    Throws:
    
    IOException - on any I/O failure.
  - sync
```
public <X extends IOException> void sync(BitField<FsSyncOption> options,
                                ExceptionHandler<? super FsSyncException,X> handler)
          throws IOException
```
    Description copied from class: 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.
    
    Overrides:
    
    sync in class FsDecoratingController<FsModel,FsController<?>>
    
    Type Parameters:
    X - The type of the IOException to throw at the discretion of the exception handler.
    Parameters:
    options - a bit field of synchronization options.
    handler - the exception handling strategy for consuming input FsSyncExceptions and mapping them to output IOExceptions.
    
    Throws:
    
    IOException - on any other (not necessarily I/O related) failure.
  - unlink
```
public void unlink(FsEntryName name,
          BitField<FsOutputOption> options)
            throws IOException
```
    Description copied from class: FsController
    
    Removes the named file system entry from the file system. If the named file system entry is a directory, it must be empty.
    
    Overrides:
    
    unlink in class FsDecoratingController<FsModel,FsController<?>>
    
    Parameters:
    name - the file system entry name.
    options - output options for this operation.
    
    Throws:
    
    IOException - on any I/O failure.
  - unlinkRoot
```
private void unlinkRoot(FsFalsePositiveController.IOOperation<Void> operation)
                 throws IOException
```
    Throws:
    
    IOException

Class FsFalsePositiveController

Nested Class Summary

Field Summary

Fields inherited from class de.schlichtherle.truezip.fs.FsDecoratingController

Constructor Summary

Method Summary

Methods inherited from class de.schlichtherle.truezip.fs.FsDecoratingController

Methods inherited from class de.schlichtherle.truezip.fs.FsModelController

Methods inherited from class de.schlichtherle.truezip.fs.FsController

Methods inherited from class java.lang.Object

Field Detail

parent

path

state

Constructor Detail

FsFalsePositiveController

Method Detail

call

getClosedIcon

getEntry

getInputSocket

getOpenIcon

getOutputSocket

getParent

getPath

isExecutable

isReadable

isReadOnly

isWritable

mknod

resolveParent

setReadOnly

setTime

setTime

sync

unlink

unlinkRoot