java.net

クラス ResponseCache

java.lang.Object

java.net.ResponseCache

public abstract class ResponseCache
extends Object

URLConnection のキャッシュの実装を表します。そのようなクラスのインスタンスをシステムに登録するには、ResponseCache.setDefault(ResponseCache) を実行します。システムがこのオブジェクトを呼び出す目的は、次のとおりです。

• 外部リソースから取得されたリソースデータをキャッシュ内に格納します。
• キャッシュに格納された可能性のある、要求されたリソースの取得を試みます。

ResponseCache 実装は、キャッシュすべきリソースとそのキャッシュ期間を決定します。要求されたリソースがキャッシュから取得不可能な場合、プロトコルハンドラはそのリソースを元の場所から取得します。 URLConnection#useCaches の設定によって、プロトコルがキャッシュ内の応答を使用できるかどうかが決まります。 HTTP キャッシュ処理の詳細については、「RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1」を参照してください。

導入されたバージョン:

1.5

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ResponseCache()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
abstract CacheResponse	get(URI uri, String rqstMethod, Map<String,List<String>> rqstHeaders) 要求 URI、要求メソッド、および要求ヘッダーに基づいて、キャッシュ内の応答を取得します。
static ResponseCache	getDefault() システム全体の応答キャッシュを取得します。
abstract CacheRequest	put(URI uri, URLConnection conn) プロトコルハンドラがリソースの取得完了後にこのメソッドを呼び出し、ResponseCache がそのリソースをキャッシュ内に格納すべきかどうかを決定します。
static void	setDefault(ResponseCache responseCache) システム全体のキャッシュを設定 (または設定解除) します。

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

ResponseCache

public ResponseCache()

メソッドの詳細

getDefault

public static ResponseCache getDefault()

システム全体の応答キャッシュを取得します。

戻り値:

システム全体の ResponseCache

例外:

SecurityException - セキュリティーマネージャーがインストールされていて、それが NetPermission(「getResponseCache」) を拒否した場合

導入されたバージョン:

1.5

関連項目:

setDefault(ResponseCache)

setDefault

public static void setDefault(ResponseCache responseCache)

システム全体のキャッシュを設定 (または設定解除) します。 注: 標準でないプロトコルハンドラは、この設定を無視する可能性があります。

パラメータ:

responseCache − 応答キャッシュ。キャッシュを設定解除する場合は null。

例外:

SecurityException - セキュリティーマネージャーがインストールされていて、それが NetPermission(「setResponseCache」) を拒否した場合

導入されたバージョン:

1.5

関連項目:

getDefault()

get

public abstract CacheResponse get(URI uri,
                String rqstMethod,
                Map<String,List<String>> rqstHeaders)
                           throws IOException

要求 URI、要求メソッド、および要求ヘッダーに基づいて、キャッシュ内の応答を取得します。通常、プロトコルハンドラは、ネットワークリソースの取得要求を送信する前に、このメソッドを呼び出します。キャッシュ内の応答が返された場合、そのリソースが代わりに使用されます。

パラメータ:

uri - 要求されたネットワークリソースの参照に使用される URI

rqstMethod − 要求メソッドを表す String

rqstHeaders - 現在の要求ヘッダーを表す、要求ヘッダーフィールド名からフィールド値のリストへのマップ

戻り値:

キャッシュから取得可能な場合は CacheResponse インスタンス。それ以外の場合は null

例外:

IOException - 入出力エラーが発生した場合

IllegalArgumentException - 引数のいずれかが null の場合

関連項目:

URLConnection.setUseCaches(boolean), URLConnection.getUseCaches(), URLConnection.setDefaultUseCaches(boolean), URLConnection.getDefaultUseCaches()

put

public abstract CacheRequest put(URI uri,
               URLConnection conn)
                          throws IOException

プロトコルハンドラがリソースの取得完了後にこのメソッドを呼び出し、ResponseCache がそのリソースをキャッシュ内に格納すべきかどうかを決定します。リソースがキャッシュに格納される場合、put() は、OutputStream を含む CacheRequest オブジェクトを返します。プロトコルハンドラはこれを使ってリソースをキャッシュ内に書き込みます。リソースがキャッシュに格納されない場合、put は null を返します。

パラメータ:

uri - 要求されたネットワークリソースの参照に使用される URI

conn − キャッシュ対象の応答の取得に使用される URLConnection インスタンス

戻り値:

キャッシュ対象の応答を記録するための CacheRequest。null が返された場合、それは、呼び出し元が応答をキャッシュに格納するつもりがないことを示す。

例外:

IOException - 入出力エラーが発生した場合

IllegalArgumentException - 引数のいずれかが null の場合