de.schlichtherle.truezip.socket
Class ConcurrentInputShop<E extends Entry>

java.lang.Object
  de.schlichtherle.truezip.entry.DecoratingEntryContainer<E,I>
      de.schlichtherle.truezip.socket.DecoratingInputShop<E,InputShop<E>>
          de.schlichtherle.truezip.socket.ConcurrentInputShop<E>

Type Parameters:

E - The type of the entries.

All Implemented Interfaces:

EntryContainer<E>, InputService<E>, InputShop<E>, Closeable, Iterable<E>

Direct Known Subclasses:

FsDefaultArchiveController.Input

@ThreadSafe
public class ConcurrentInputShop<E extends Entry>
extends DecoratingInputShop<E,InputShop<E>>

Decorates an InputShop to add accounting and multithreading synchronization for all input streams or read only files created by the decorated input shop.

Author:

Christian Schlichtherle

See Also:

ConcurrentOutputShop

CLASS_NAME

private static final String CLASS_NAME

logger

private static final Logger logger

threads

private final Map<Closeable,Thread> threads

The pool of all open entry streams. This is implemented as a map where the keys are the streams and the value is the current thread. The weak hash map allows the garbage collector to pick up an entry stream if there are no more references to it. This reduces the likeliness of an InputBusyException in case a sloppy client application has forgot to close a stream before this input shop gets closed.

closed

private volatile boolean closed

ConcurrentInputShop

public ConcurrentInputShop(InputShop<E> input)

Constructs a concurrent input shop.

Parameters:

input - the shop to decorate.

Throws:

NullPointerException - if input is null.

waitCloseOthers

public final int waitCloseOthers(long timeout)

Waits until all entry input streams and read only files which have been opened by other threads get closed or a timeout occurs. If the current thread is interrupted while waiting, a warning message is logged using java.util.logging and this method returns.

Unless otherwise prevented, another thread could immediately open another stream upon return of this method. So there is actually no guarantee that really all streams are closed upon return of this method - use carefully!

Returns:

The number of all open streams.

threadStreams

private int threadStreams()

Returns the number of streams opened by the current thread.

closeAll

public final <E extends Exception> void closeAll(ExceptionHandler<IOException,E> handler)
                    throws E extends Exception

Closes and disconnects all entry input streams and read only file created by this concurrent input shop. Disconnecting means that any subsequent operation on the entry streams will throw an IOException, with the exception of their close() method.

Throws:

E extends Exception

close

public final void close()
                 throws IOException

Closes this concurrent output shop.

Specified by:

close in interface Closeable

Overrides:

close in class DecoratingInputShop<E extends Entry,InputShop<E extends Entry>>

Throws:

IllegalStateException - If any open input streams or read only files are detected.

IOException

See Also:

closeAll(de.schlichtherle.truezip.util.ExceptionHandler)

assertNotShopClosed

private void assertNotShopClosed()
                          throws IOException

Needs to be externally synchronized!

Throws:

IOException

getInputSocket

public final InputSocket<? extends E> getInputSocket(String name)

Description copied from interface: InputService

Returns an input socket for read access to the given entry.

Specified by:

getInputSocket in interface InputService<E extends Entry>

Overrides:

getInputSocket in class DecoratingInputShop<E extends Entry,InputShop<E extends Entry>>

Parameters:

name - a non-null entry name.

Returns:

An input socket for reading from the local target.