org.mule.extension.file.common.api.stream

Class AbstractNonFinalizableFileInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.mule.extension.file.common.api.stream.AbstractNonFinalizableFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class AbstractNonFinalizableFileInputStream
extends org.apache.commons.io.input.ProxyInputStream

Base class for InputStream instances returned by connectors which operate over a FileSystem.

It's a ProxyInputStream which also contains the concept of a PathLock which is released when the stream is closed or fully consumed. Also has the functionality of AutoCloseInputStream but without the Object.finalize() implementation.

Because in most implementations the actual reading of the stream requires initialising/maintaining a connection, instances are created through a LazyStreamSupplier. This allows such connection/resource to be provisioned lazily. This is very useful in cases such as FileSystem.list(FileConnectorConfig, String, boolean, Predicate). Being able to only lazily establish the connections, prevents the connector from opening many connections at the same time, at the risk that many of them might end up not being necessary at the same time.

Since:

1.0

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
AbstractNonFinalizableFileInputStream(LazyStreamSupplier streamSupplier, Lock lock)
AbstractNonFinalizableFileInputStream(LazyStreamSupplier streamSupplier, PathLock lock)

Method Summary

Modifier and Type	Method and Description
protected void	afterRead(int n) Automatically closes the stream if the end of stream was reached.
void	close() Closes the stream and invokes Lock.release() on the lock.
protected void	doClose()
boolean	isLocked()

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, beforeRead, handleIOException, mark, markSupported, read, read, read, reset, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractNonFinalizableFileInputStream

public AbstractNonFinalizableFileInputStream(LazyStreamSupplier streamSupplier,
                                             PathLock lock)

AbstractNonFinalizableFileInputStream

public AbstractNonFinalizableFileInputStream(LazyStreamSupplier streamSupplier,
                                             Lock lock)

Method Detail

afterRead

protected void afterRead(int n)
                  throws IOException

Automatically closes the stream if the end of stream was reached.

Overrides:

afterRead in class org.apache.commons.io.input.ProxyInputStream

Parameters:

n - number of bytes read, or -1 if no more bytes are available

Throws:

IOException - if the stream could not be closed

Since:

2.0

close

public final void close()
                 throws IOException

Closes the stream and invokes Lock.release() on the lock.

Because the actual stream is lazily opened, the possibility exists for this method being invoked before the streamSupplier is used. In such case, this method will not fail.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class org.apache.commons.io.input.ProxyInputStream

Throws:

IOException - in case of error

doClose

protected void doClose()
                throws IOException

Throws:

IOException

isLocked

public boolean isLocked()