IIJGIOWebServiceClient (iijgio-dag-client-all 1.2.4 API)

java.lang.Object
- com.iijgio.dag.IIJGIOWebServiceClient

Direct Known Subclasses:

StorageClient
```
public abstract class IIJGIOWebServiceClient
extends Object
```
IIJ GIOストレージ＆アナリシスサービス用Web Serviceクライアントのための基底クラスです
エンドポイントなど、IIJ GIOストレージ＆アナリシスサービス SDKのクライアントの基本的な設定を定義しています。

Field Summary

Fields
Modifier and Type	Field and Description
`protected HttpClient`	`client` サービスへの接続に使用するより低レベルなHTTP クライアント
`protected ClientConfiguration`	`clientConfiguration` クライアントの設定オブジェクト
`protected URI`	`endpoint` クライアントの接続先となるサービスのエンドポイント
`protected List<RequestHandler>`	`requestHandlers` Optional request handlers for additional request processing.
`protected int`	`timeOffset` Optional offset (in seconds) to use when signing requests
`protected boolean`	`virtualHostEndpointEnabled` リソースの指定方法としてバーチャルホスト形式を使用するかどうか

Constructor Summary

Constructors
Constructor and Description
`IIJGIOWebServiceClient(ClientConfiguration clientConfiguration)` 特定のクライアント設定を使いIIJGIOWebServiceClientオブジェクトを生成します

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRequestHandler(RequestHandler requestHandler)` リクエスト・ハンドラーをリクエストのライフサイクルの一部として実行される登録済みハンドラーのリストへ追加します。
`protected <T> HttpRequest`	`convertToHttpRequest(Request<T> request, HttpMethodName methodName)` Deprecated.
`protected ExecutionContext`	`createExecutionContext()` Deprecated. by `createExecutionContext(IIJGIOWebServiceRequest)`. このメソッドは後方互換性のためだけの理由で存在しています。その理由はこのクラスの古いバージョンでコンパイルされたクライアントが実行時に`NoSuchMethodError`にならないようにするためです。しかしながら、このメソッドを呼ぶことはたとえリクエストレベルで指定されてもリクエスト・メトリック・コントローラを無視し無効にします。サービスクライアントやIIJ GIOストレージ＆アナリシスサービス SDKレベルで指定されたリクエスト・メトリック・コントローラはまだ高く評価されます。
`protected ExecutionContext`	`createExecutionContext(IIJGIOWebServiceRequest req)`
`protected String`	`getServiceAbbreviation()` このサービスに対するサービスの略称を返します。リージョンによるサービス・エンドポイントを特定するために使用されます。
`int`	`getTimeOffset()` このクライアントに対して、時間オフセットに任意の値を取得します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。
`boolean`	`isVirtualHostEndpointEnabled()` リソースの指定方法としてバーチャルホスト形式を使用するかどうかを返します。
`void`	`removeRequestHandler(RequestHandler requestHandler)` リクエスト・ハンドラーをリクエストのライフサイクルの一部として実行される登録済みハンドラーのリストから削除します。
`void`	`setEndpoint(String endpoint)` エンドポイントを上書き設定します。リージョンの切り替えなどに使用できます。
`void`	`setRegion(Region region)` `setEndpoint(String)`に代わるもので、このクライアントのサービス・コールのためのリージョンのエンドポイントを設定します。呼び出し側はどのIIJ GIOストレージ＆アナリシスサービスのリージョンで動作させたいかを制御するためにこのメソッドを使用できます。
`void`	`setTimeOffset(int timeOffset)` このクライアントに対して、時間オフセットに任意の値を設定します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。
`void`	`setVirtualHostEndpointEnabled(boolean enable)` リソースの指定方法としてバーチャルホスト形式を使用の有無を設定します。
`void`	`shutdown()` クライアントをシャットダウンし、すべてのリソースを開放します。これはオプションメソッドであり、明示的にリソースの開放を行ないたい場合以外が呼ぶ必要はありません。クライアントを一旦シャットダウンすると、それ以降のリクエストは行えなくなります
`IIJGIOWebServiceClient`	`withTimeOffset(int timeOffset)` このクライアントに対して、時間オフセットに任意の値を設定します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - clientConfiguration
```
protected final ClientConfiguration clientConfiguration
```
    クライアントの設定オブジェクト
  - client
```
protected final HttpClient client
```
    サービスへの接続に使用するより低レベルなHTTP クライアント
  - requestHandlers
```
protected final List<RequestHandler> requestHandlers
```
    Optional request handlers for additional request processing.
  - endpoint
```
protected URI endpoint
```
    クライアントの接続先となるサービスのエンドポイント
  - virtualHostEndpointEnabled
```
protected boolean virtualHostEndpointEnabled
```
    リソースの指定方法としてバーチャルホスト形式を使用するかどうか
  - timeOffset
```
protected int timeOffset
```
    Optional offset (in seconds) to use when signing requests
- Constructor Detail
  - IIJGIOWebServiceClient
```
public IIJGIOWebServiceClient(ClientConfiguration clientConfiguration)
```
    特定のクライアント設定を使いIIJGIOWebServiceClientオブジェクトを生成します
    
    Parameters:
    
    clientConfiguration - このクライアントで使うクライアント設定オブジェクト
- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
                 throws IllegalArgumentException
```
    エンドポイントを上書き設定します。リージョンの切り替えなどに使用できます。
    呼び出す際は、エンドポイントのFQDN(例: storage-dag.iijgio.com)やプロトコルを含んだURL(例: https://storage-dag.iijgio.com)を指定できます URLではなくFQDNを指定した場合、クライアント設定ClientConfigurationのプロトコル設定が使用されます。デフォルト値はHTTPSです。
    
    Parameters:
    
    endpoint - エンドポイントのFQDN(例: storage-dag.iijgio.com) または URL(例: https://storage-dag.iijgio.com)
    
    Throws:
    
    IllegalArgumentException - エンドポイント設定に問題があった場合
  - setRegion
```
public void setRegion(Region region)
               throws IllegalArgumentException
```
    setEndpoint(String)に代わるもので、このクライアントのサービス・コールのためのリージョンのエンドポイントを設定します。呼び出し側はどのIIJ GIOストレージ＆アナリシスサービスのリージョンで動作させたいかを制御するためにこのメソッドを使用できます。
    このメソッドはスレッドセーフではありません。クライアントが生成され、いかなるサービス・リクエストが作成される前に、リージョンは設定されなくてはなりません。その後、それを変更すると、トランジットや再試行時にサービス・リクエストの競合状態を生み出すことになります。
    デフォルトでは、全リージョンの全サービス・エンドポイントはHTTPSプロトコルを使用します。 HTTPを代わりに使用するためには、生成時にClientConfiguration内でそれを指定してください。
    
    Parameters:
    
    region - このクライアントが通信するリージョン。所定のリージョンにアクセスするためには Region.getRegion(com.iijgio.dag.regions.Regions)を参照してください。
    
    Throws:
    
    IllegalArgumentException - 所定のリージョンがnullの場合、またはこのサービスが所定のリージョンで利用できない場合。 Region.isServiceSupported(String)を参照してください。
    
    See Also:
    
    Region.getRegion(com.iijgio.dag.regions.Regions), Region.createClient(Class, com.iijgio.dag.auth.IIJGIOCredentialsProvider, ClientConfiguration)
  - getServiceAbbreviation
```
protected String getServiceAbbreviation()
```
    このサービスに対するサービスの略称を返します。リージョンによるサービス・エンドポイントを特定するために使用されます。
    
    Returns:
    
    サービスの略称
    
    See Also:
    
    ServiceAbbreviations
  - isVirtualHostEndpointEnabled
```
public boolean isVirtualHostEndpointEnabled()
```
    リソースの指定方法としてバーチャルホスト形式を使用するかどうかを返します。
    
    Returns:
    
    バーチャルホスト形式が有効の場合 true を返します。
  - setVirtualHostEndpointEnabled
```
public void setVirtualHostEndpointEnabled(boolean enable)
```
    リソースの指定方法としてバーチャルホスト形式を使用の有無を設定します。
    バーチャルホスト形式の場合は、バケット名をホスト部で指定し、HTTPのHostヘッダーには「{BucketName}.{Endpoint}」と設定され、
    使用しない場合は、バケット名はURLのパス部で指定し、HTTPのHostヘッダーには「{Endpoint}」が設定されます。
    （BucketName: 対象とするバケット名, Endpoint: REST APIのエンドポイント）
    
    Parameters:
    
    enable - バーチャルホスト形式を使用にする場合は true そうでない場合は false をセットします。
  - shutdown
```
public void shutdown()
```
    クライアントをシャットダウンし、すべてのリソースを開放します。これはオプションメソッドであり、明示的にリソースの開放を行ないたい場合以外が呼ぶ必要はありません。クライアントを一旦シャットダウンすると、それ以降のリクエストは行えなくなります
  - convertToHttpRequest
```
@Deprecated
protected <T> HttpRequest convertToHttpRequest(Request<T> request,
                                                           HttpMethodName methodName)
```
    Deprecated.
    
    RequestオブジェクトをHttpRequestオブジェクトに変換します Requestのすべてのヘッダ・パラメタ等はHttpRequestに反映されます
    
    Type Parameters:
    
    T - 変換するリクエストオブジェクトの型
    
    Parameters:
    
    request - 変換するリクエストオブジェクト
    
    methodName - 変換したオブジェクトで使用するHTTPメソッド (GET, PUT, DELETE, HEAD)
    
    Returns:
    
    Requestオブジェクトを基に生成された HttpRequestオブジェクト
    
    See Also:
    
    Request
  - addRequestHandler
```
public void addRequestHandler(RequestHandler requestHandler)
```
    リクエスト・ハンドラーをリクエストのライフサイクルの一部として実行される登録済みハンドラーのリストへ追加します。
    
    Parameters:
    
    requestHandler - 現在のリクエスト・ハンドラーのリストに追加する新しいハンドラー
  - removeRequestHandler
```
public void removeRequestHandler(RequestHandler requestHandler)
```
    リクエスト・ハンドラーをリクエストのライフサイクルの一部として実行される登録済みハンドラーのリストから削除します。
    
    Parameters:
    
    requestHandler - 現在のリクエスト・ハンドラーのリストから削除するハンドラー
  - createExecutionContext
```
protected final ExecutionContext createExecutionContext(IIJGIOWebServiceRequest req)
```
  - createExecutionContext
```
@Deprecated
protected final ExecutionContext createExecutionContext()
```
    Deprecated. by createExecutionContext(IIJGIOWebServiceRequest).
    このメソッドは後方互換性のためだけの理由で存在しています。その理由はこのクラスの古いバージョンでコンパイルされたクライアントが実行時にNoSuchMethodErrorにならないようにするためです。しかしながら、このメソッドを呼ぶことはたとえリクエストレベルで指定されてもリクエスト・メトリック・コントローラを無視し無効にします。サービスクライアントやIIJ GIOストレージ＆アナリシスサービス SDKレベルで指定されたリクエスト・メトリック・コントローラはまだ高く評価されます。
    
    Returns:
    
    コンテキスト
  - withTimeOffset
```
public IIJGIOWebServiceClient withTimeOffset(int timeOffset)
```
    このクライアントに対して、時間オフセットに任意の値を設定します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。
    
    Parameters:
    
    timeOffset - このクライアントに対する時間オフセット（秒）の任意の値
    
    Returns:
    
    更新されたWEBサービスクライアント
  - getTimeOffset
```
public int getTimeOffset()
```
    このクライアントに対して、時間オフセットに任意の値を取得します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。
    
    Returns:
    
    このクライアントに対する時間オフセット（秒）の任意の値
  - setTimeOffset
```
public void setTimeOffset(int timeOffset)
```
    このクライアントに対して、時間オフセットに任意の値を設定します。この値はこのクライアントを通して全てのリクエストに適用されます。値は、秒単位で、正数は現時刻が「早い」、負数は「遅い」というニュアンスになります。
    
    Parameters:
    
    timeOffset - このクライアントに対する時間オフセット（秒）の任意の値

Class IIJGIOWebServiceClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

clientConfiguration

client

requestHandlers

endpoint

virtualHostEndpointEnabled

timeOffset

Constructor Detail

IIJGIOWebServiceClient

Method Detail

setEndpoint

setRegion

getServiceAbbreviation

isVirtualHostEndpointEnabled

setVirtualHostEndpointEnabled

shutdown

convertToHttpRequest

addRequestHandler

removeRequestHandler

createExecutionContext

createExecutionContext

withTimeOffset

getTimeOffset

setTimeOffset