com.iijgio.dag.http

Class HttpMethodReleaseInputStream

java.lang.Object

java.io.InputStream

com.iijgio.dag.http.HttpMethodReleaseInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpMethodReleaseInputStream
extends InputStream

HttpClientライブラリのHttpMethodオブジェクトから得られる入力ストリームをラップし 確実にストリームとHTTPコネクションを解放するためのユーティリティクラスです。

このInputStreamラッパは、呼び出し元がすべてのコンテンツをコネクションの入力ストリーム から読みだした後もしくは入力ストリームが閉じられた後、HTTPコネクションを確実に クリーンアップするために使われます。さらに、このクラスは、このオブジェクトの ファイナライズメソッドにおいても、リソースのリークを防ぐ最終手段として、コネクション を開放し、入力ストリームを閉じようとします。

重要! この入力ストリームでは、必要なクリーンアップ動作を確実にするため、 すべてのコンテンツを読み出すか、閉じる必要があります。

Constructor Summary

Constructors

Constructor and Description
HttpMethodReleaseInputStream(org.apache.http.HttpEntityEnclosingRequest httpMethod) Httpコネクションを表すHttpMethodオブジェクトをから InputStreamオブジェクトを構築します。 コネクションの入力ストリームが有効だった場合、このコンストラクタでは基となる InputStreamをInterruptableInputStreamにラップして、ストリームを有効にします もし、有効なコネクションが無かった場合、空のByteArrayInputStreamを 作成します。

Method Summary

Modifier and Type	Method and Description
int	available() 一般的なInputStreamのavailableメソッドですが、 ベースとなる入力ストリームでエラーが発生した場合に、releaseConnection() の 呼び出しを保証します。
void	close() 一般的なInputStreamのavailableメソッドですが、 ベースとなる入力ストリームが閉じられた場合、releaseConnection() の 呼び出しを保証します。
protected void	finalize() コネクションの確実なクリーンアップを保証するために、releaseConnection() をクラスのデストラクトの際にクリーンアップが行われていなかった場合に呼び出します
org.apache.http.HttpEntityEnclosingRequest	getHttpRequest() 実際のHTTPコネクションを含み管理するHTTPMethodオブジェクトを返します。
int	read() 一般的なInputStreamのreadメソッドですが、 入力ストリームをすべて読み込んだ場合に、releaseConnection() メソッドを呼び出します
int	read(byte[] b, int off, int len) 一般的なInputStreamのreadメソッドですが、 入力ストリームをすべて読み込んだ場合に、releaseConnection() メソッドを呼び出します
protected void	releaseConnection() HttpClientメソッドの正しい利用のため、必要なクリーンアップの一部として HttpMethodオブジェクトのConnectionを強制的に開放します。

Methods inherited from class java.io.InputStream

mark, markSupported, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpMethodReleaseInputStream

public HttpMethodReleaseInputStream(org.apache.http.HttpEntityEnclosingRequest httpMethod)

Httpコネクションを表すHttpMethodオブジェクトをから InputStreamオブジェクトを構築します。 コネクションの入力ストリームが有効だった場合、このコンストラクタでは基となる InputStreamをInterruptableInputStreamにラップして、ストリームを有効にします もし、有効なコネクションが無かった場合、空のByteArrayInputStreamを 作成します。

Parameters:

httpMethod - レスポンスのコンテンツをラップする基とするHTTPMethodオブジェクト

Method Detail

getHttpRequest

public org.apache.http.HttpEntityEnclosingRequest getHttpRequest()

実際のHTTPコネクションを含み管理するHTTPMethodオブジェクトを返します。

Returns:

データの入力ストリームを提供するHTTPMethodオブジェクト

releaseConnection

protected void releaseConnection()
                          throws IOException

HttpClientメソッドの正しい利用のため、必要なクリーンアップの一部として HttpMethodオブジェクトのConnectionを強制的に開放します。

Throws:

IOException - コネクションのリリースに失敗した場合

read

public int read()
         throws IOException

一般的なInputStreamのreadメソッドですが、 入力ストリームをすべて読み込んだ場合に、releaseConnection() メソッドを呼び出します

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

一般的なInputStreamのreadメソッドですが、 入力ストリームをすべて読み込んだ場合に、releaseConnection() メソッドを呼び出します

Overrides:

read in class InputStream

Throws:

IOException

available

public int available()
              throws IOException

一般的なInputStreamのavailableメソッドですが、 ベースとなる入力ストリームでエラーが発生した場合に、releaseConnection() の 呼び出しを保証します。

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

一般的なInputStreamのavailableメソッドですが、 ベースとなる入力ストリームが閉じられた場合、releaseConnection() の 呼び出しを保証します。

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

コネクションの確実なクリーンアップを保証するために、releaseConnection() をクラスのデストラクトの際にクリーンアップが行われていなかった場合に呼び出します

この最終手段としてのクリーンアップは、ユーザがこのクラスの入力ストリームデータを 全て読み出さなかった場合や、オブジェクトのデストラクトの前に入力ストリームを 閉じた場合にのみ必要とされます このメソッドは、強制クリーンアップが必要であり、ユーザにストリームを閉じるよう 注意するため、ログに警告メッセージを記録します。

Overrides:

finalize in class Object

Throws:

Throwable