com.iijgio.dag.http

Class HttpClient

java.lang.Object

com.iijgio.dag.http.HttpClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpClient
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor and Description
HttpClient(ClientConfiguration config) 新たに、IIJ GIOストレージ＆アナリシスサービス クライアントオブジェクトを、 設定とリクエスト・メトリック・コレクターを指定して 構築します。 (例えば 最大試行回数, プロキシ設定など).

Method Summary

Modifier and Type	Method and Description
void	addRequestEventListener(SendRequestEventListener requestEventListener) リクエストイベントリスナを追加します
void	addResponseEventListener(ReceiveResponseEventListener responseEventListener) レスポンスイベントリスナを追加します
void	close() このHTTP Clientオブジェクトをシャットダウンし、すべてのリソースをクローズします。 これはオプションメソッドで、通常は呼び出す必要はありませんが、明示的にリソースを クローズしたい場合にしようできます。 一旦シャットダウンすると、クライアントは以降リクエストを発行することは出来ません
<T> T	execute(Request<?> request, HttpResponseHandler<IIJGIOWebServiceResponse<T>> responseHandler, HttpResponseHandler<IIJGIOServiceException> errorResponseHandler, ExecutionContext executionContext) リクエストを実行し、結果を返します。
protected void	finalize()
ResponseMetadata	getResponseMetadataForRequest(IIJGIOWebServiceRequest request) 実行されたリクエストに対する追加のレスポンスメタデータを返します。 レスポンスメタデータは操作に対する標準的な結果の一部ではなく、解析用として 用いられるもので、主にトラブルシューティングに使われます
boolean	isClockSkewError(IIJGIOServiceException exception) 指定した例外が clock skew errorであれば、trueを返します。
static boolean	isRequestEntityTooLargeException(IIJGIOServiceException ase) 指定した例外がrequest entity too large errorであれば、trueを返します。
static boolean	isThrottlingException(IIJGIOServiceException ase) 指定した例外がThrottling（絞り）例外であれば、trueを返します。
void	shutdown() このHTTP Clientオブジェクトをシャットダウンし、すべてのリソースをクローズします。 これはオプションメソッドで、通常は呼び出す必要はありませんが、明示的にリソースを クローズしたい場合にしようできます。 一旦シャットダウンすると、クライアントは以降リクエストを発行することは出来ません

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpClient

public HttpClient(ClientConfiguration config)

新たに、IIJ GIOストレージ＆アナリシスサービス クライアントオブジェクトを、 設定とリクエスト・メトリック・コレクターを指定して 構築します。 (例えば 最大試行回数, プロキシ設定など).

Parameters:

config - このクライアントのIIJ GIOストレージ＆アナリシスサービス との 通信に関する設定(プロキシ設定、リトライ回数など)

Method Detail

isThrottlingException

public static boolean isThrottlingException(IIJGIOServiceException ase)

指定した例外がThrottling（絞り）例外であれば、trueを返します。

Parameters:

ase - The exception to test.

Returns:

True if the exception resulted from a throttling error message from a service, otherwise false.

isRequestEntityTooLargeException

public static boolean isRequestEntityTooLargeException(IIJGIOServiceException ase)

指定した例外がrequest entity too large errorであれば、trueを返します。

Parameters:

ase - The exception to test.

Returns:

True if the exception resulted from a request entity too large error message from a service, otherwise false.

getResponseMetadataForRequest

public ResponseMetadata getResponseMetadataForRequest(IIJGIOWebServiceRequest request)

実行されたリクエストに対する追加のレスポンスメタデータを返します。 レスポンスメタデータは操作に対する標準的な結果の一部ではなく、解析用として 用いられるもので、主にトラブルシューティングに使われます

Parameters:

request - メタデータの取得対象となる実行済みの IIJGIOWebServiceRequest オブジェクト

Returns:

指定されたリクエストに対するメタデータ。リクエストに対するレスポンス メタデータが無効な場合はnull

execute

public <T> T execute(Request<?> request,
                     HttpResponseHandler<IIJGIOWebServiceResponse<T>> responseHandler,
                     HttpResponseHandler<IIJGIOServiceException> errorResponseHandler,
                     ExecutionContext executionContext)
              throws IIJGIOClientException

リクエストを実行し、結果を返します。

Type Parameters:

T - リクエストの結果の型

Parameters:

request - リモートサーバに送信するIIJGIOWebServiceリクエスト

responseHandler - リモートサーバからの成功レスポンスを受信するレスポンスハンドラー

errorResponseHandler - リモートサーバからの失敗レスポンスを受信するレスポンスハンドラー

executionContext - このWEBサービス呼び出しのコンテキストについての追加情報

Returns:

リクエストの結果

Throws:

IIJGIOClientException

close

public void close()

このHTTP Clientオブジェクトをシャットダウンし、すべてのリソースをクローズします。 これはオプションメソッドで、通常は呼び出す必要はありませんが、明示的にリソースを クローズしたい場合にしようできます。 一旦シャットダウンすると、クライアントは以降リクエストを発行することは出来ません

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

このHTTP Clientオブジェクトをシャットダウンし、すべてのリソースをクローズします。 これはオプションメソッドで、通常は呼び出す必要はありませんが、明示的にリソースを クローズしたい場合にしようできます。 一旦シャットダウンすると、クライアントは以降リクエストを発行することは出来ません

isClockSkewError

public boolean isClockSkewError(IIJGIOServiceException exception)

指定した例外が clock skew errorであれば、trueを返します。

Parameters:

exception - The exception to test.

Returns:

True if the exception resulted from a clock skews error message from a service, otherwise false.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

addRequestEventListener

public void addRequestEventListener(SendRequestEventListener requestEventListener)

リクエストイベントリスナを追加します

Parameters:

requestEventListener - 追加するリクエストイベントリスナ

addResponseEventListener

public void addResponseEventListener(ReceiveResponseEventListener responseEventListener)

レスポンスイベントリスナを追加します

Parameters:

responseEventListener - 追加するレスポンスイベントリスナ