org.dataone.client.types

Class AutoCloseHttpClientInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.AutoCloseInputStream

org.dataone.client.types.AutoCloseHttpClientInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class AutoCloseHttpClientInputStream
extends org.apache.commons.io.input.AutoCloseInputStream

Use this class to wrap input streams that come from HttpClients IFF if you plan to never use the HttpClient again. This extended class will automatically closes the input stream AS WELL AS the associated HttpClient once the last byte is read. Upon close, it also dereferences the HttpClient property to allow it to go out of scope and be eligible for garbage collection. (Note, other references to the HttpClient the application might have are still the user's responsibility).

Author:

rnahf

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
AutoCloseHttpClientInputStream(InputStream is, org.apache.http.client.HttpClient hc)

Method Summary

Modifier and Type	Method and Description
protected void	afterRead(int n)
void	close() Closes the proxied InputStream, and the HttpClient.
protected void	finalize()

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AutoCloseHttpClientInputStream

public AutoCloseHttpClientInputStream(InputStream is,
                                      org.apache.http.client.HttpClient hc)

Parameters:

is - - the InputStream being proxied

hc - - the disposable HttpClient from where the InpuStream came from

Method Detail

afterRead

protected void afterRead(int n)
                  throws IOException

Overrides:

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

Throws:

IOException

close

public void close()
           throws IOException

Closes the proxied InputStream, and the HttpClient. Also sets the HttpClient property to null to help dereference it.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

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

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class org.apache.commons.io.input.AutoCloseInputStream

Throws:

Throwable