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) プロトコルハンドラは、リソースの取得後にこのメソッドを呼び出します。
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 - 要求ヘッダフィールド名と、現在の要求ヘッダを表すフィールド値のリストを対応付ける Map

戻り値:

キャッシュから利用できる場合は CacheResponse インスタンス、そうでない場合は null

例外:

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

IllegalArgumentException - 引数が 1 つでも null の場合

関連項目:

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

put

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

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

パラメータ:

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

conn - キャッシュに格納する応答のフェッチに使用される URLConnection インスタンス

戻り値:

キャッシュに格納される応答の記録用 CacheRequest。呼び出し側が応答をキャッシュに格納するつもりがない場合は null

例外:

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

IllegalArgumentException - 引数が 1 つでも null の場合