getProperties()メソッド
説明
変更可能なプロパティマップを取得します。
構文
public abstract Map<String,Object> getProperties()
パラメタ
ありません。
戻り値
プロパティマップを返します。
注意事項
-
戻り値のプロパティマップにはプロパティを追加または変更できます。追加または変更できるプロパティについては,「25.1.1 サポートするプロパティとフィーチャ」を参照してください。プロパティについては「11.4.3 プロパティとフィーチャの設定」も参照してください。
getProperties()メソッドの使用例を次に示します。
// Clientオブジェクトを生成する
Client client = Client.create();
// HTTPリクエストを生成する
ClientRequest cRequest = ClientRequest.create().build(new URI("http://test.com/"), "GET");
// 読み込みタイムアウト値を設定する
cRequest.getProperties().put(ClientConfig.PROPERTY_READ_TIMEOUT, 10000);
try{
// HTTPレスポンスをClientResponseオブジェクトとして受信する
ClientResponse cResponse = client.handle(cRequest);
} catch(ClientHandlerException e){
// 適切な処理を実行する
}この例では,ClientRequestオブジェクトを生成したあと,ClientRequestオブジェクトのgetProperties()メソッドで変更可能なプロパティマップを取得し,読み込みタイムアウト値を10,000ミリ秒に設定しています。次に,そのClientRequestオブジェクトを指定してClientクラスのhandleメソッドを呼び出します。ClientRequestオブジェクトのプロパティはClientオブジェクトにコピーされます。ClientResponseオブジェクトとしてHTTPレスポンスを受信するとき,完全に読み込まれるまでに読み込みタイムアウトが発生した場合,エラーとなり(KDJJ18888-E),SocketTimeoutExceptionをラップしたClientHandlerExceptionがスローされます。