public class ClientConfiguration extends Object
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_USER_AGENT
クライアントクラスの送信するUserAgent文字列のデフォルト値です
|
Constructor and Description |
---|
ClientConfiguration() |
ClientConfiguration(ClientConfiguration other) |
Modifier and Type | Method and Description |
---|---|
int |
getConnectionTimeout()
コネクションの確立時の関するタイムアウト値(ミリ秒)を返します
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
int |
getConnectionValidateAfterInactivity()
HTTPコネクションを回収するまでの時間(ミリ秒)を取得します。
|
int |
getMaxConnections()
許可するHTTPの最大接続数を返します。
|
int |
getMaxErrorRetry()
リトライ可能なエラー(サービスからの5xx レスポンスなど)に対する
最大リトライ回数を返します。
|
Protocol |
getProtocol()
IIJ GIOストレージ&アナリシスサービス APIへ接続する際に使用するプロトコル
(HTTP/HTTPS) を取得します
|
String |
getProxyDomain()
NTLMプロキシを設定するための任意のWindowsドメイン名を返します。
Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
String |
getProxyHost()
接続の際に使用するProxy hostを返します。(オプション)
|
String |
getProxyHostWeb() |
String |
getProxyPassword()
接続の際に使用するProxyの認証パスワード返します。(オプション)
|
String |
getProxyPasswordWeb() |
int |
getProxyPort()
接続の際に使用するProxy portを返します。(オプション)
|
int |
getProxyPortWeb() |
String |
getProxyUsername()
接続の際に使用するProxyの認証ユーザを返します。(オプション)
|
String |
getProxyUsernameWeb() |
String |
getProxyWorkstation()
NTLMプロキシサポートを設定するための任意のWindowsワークステーション名を返します。
Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
int[] |
getSocketBufferSizeHints()
低レベルのTCPの送信/受信バッファサイズのヒント値を返します。
このパラメタは拡張オプションで、パフォーマンスのさらなる向上のため
低レベルのTCPパラメタのチューニングを行ないたいユーザのために
容易されています。
|
int |
getSocketTimeout()
データ転送やコネクションの確立、コネクションクローズなどのSocket
操作に関するタイムアウト値(ミリ秒)を返します。
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
String |
getUserAgent()
すべてのリクエストで送信するUserAgent文字列を返します。
|
boolean |
isExpectContinueEnabled()
リクエストヘッダに
Expect: 100-continue を付与する場合は true を返します。 |
void |
setConnectionTimeout(int connectionTimeout)
コネクションの確立時の関するタイムアウト値(ミリ秒)を設定します
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
void |
setConnectionValidateAfterInactivity(int connectionValidateAfterInactivity)
HTTPコネクションを回収するまでの時間(ミリ秒)を指定します。(デフォルト: 1000)
|
void |
setExpectContinueEnabled(boolean enable)
リクエストヘッダに
Expect: 100-continue を付与するかどうかを指定します。(デフォルト: false) |
void |
setMaxConnections(int maxConnections)
許可するHTTPの最大接続数を設定します。
|
void |
setMaxErrorRetry(int maxErrorRetry)
リトライ可能なエラー(サービスからの5xx レスポンスなど)に対する
最大リトライ回数を設定します。
|
void |
setProtocol(Protocol protocol)
IIJ GIOストレージ&アナリシスサービス APIへ接続する際に使用するプロトコル
(HTTP/HTTPS) を設定します
|
void |
setProxyDomain(String proxyDomain)
NTLMプロキシを設定するための任意のWindowsドメイン名を設定します。
Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
void |
setProxyHost(String proxyHost)
接続の際に使用するProxy hostを設定します。(オプション)
|
void |
setProxyHostWeb(String proxyHostWeb) |
void |
setProxyPassword(String proxyPassword)
接続の際に使用するProxyの認証パスワードを設定します。(オプション)
|
void |
setProxyPasswordWeb(String proxyPasswordWeb) |
void |
setProxyPort(int proxyPort)
接続の際に使用するProxy hostを設定します。(オプション)
|
void |
setProxyPortWeb(int proxyPortWeb) |
void |
setProxyUsername(String proxyUsername)
接続の際に使用するProxyの認証ユーザを設定します。(オプション)
|
void |
setProxyUsernameWeb(String proxyUsernameWeb) |
void |
setProxyWorkstation(String proxyWorkstation)
NTLMプロキシサポートを設定するための任意のWindowsワークステーション名を設定します。
Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
void |
setSocketBufferSizeHints(int socketSendBufferSizeHint,
int socketReceiveBufferSizeHint)
低レベルのTCPの送信/受信バッファサイズのヒント値を設定します。
このパラメタは拡張オプションで、パフォーマンスのさらなる向上のため
低レベルのTCPパラメタのチューニングを行ないたいユーザのために
容易されています。
|
void |
setSocketTimeout(int socketTimeout)
データ転送やコネクションの確立、コネクションクローズなどのSocket
操作に関するタイムアウト値(ミリ秒)を設定します。
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
void |
setUserAgent(String userAgent)
すべてのリクエストで送信するUserAgent文字列を設定します。
|
ClientConfiguration |
withConnectionTimeout(int connectionTimeout)
コネクションの確立時の関するタイムアウト値(ミリ秒)を設定し
更新した自オブジェクトを返します
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
ClientConfiguration |
withMaxConnections(int maxConnections)
許可するHTTPの最大接続数を設定し、更新した自オブジェクトを返します。
|
ClientConfiguration |
withMaxErrorRetry(int maxErrorRetry)
リトライ可能なエラー(サービスからの5xx レスポンスなど)に対する
最大リトライ回数を設定し、更新したClientConfiguration オブジェクトを
返します
|
ClientConfiguration |
withProtocol(Protocol protocol)
IIJ GIOストレージ&アナリシスサービス APIへ接続する際に使用するプロトコル
(HTTP/HTTPS) を設定し、設定を更新した自オブジェクトを
返します
|
ClientConfiguration |
withProxyDomain(String proxyDomain)
NTLMプロキシを設定するための任意のWindowsドメイン名を設定し、
追加の連鎖したメソッド呼び出しのため更新したClientConfigurationオブジェクトへの
参照を返します。Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
ClientConfiguration |
withProxyHost(String proxyHost)
接続の際に使用するProxy host(オプション)を設定し、更新した
自オブジェクトを返します
|
ClientConfiguration |
withProxyPassword(String proxyPassword)
接続の際に使用するProxyの認証パスワード(オプション)を設定し
設定を更新した自オブジェクトを返します
|
ClientConfiguration |
withProxyPort(int proxyPort)
接続の際に使用するProxy port(オプション)を設定し、更新した
自オブジェクトを返します
|
ClientConfiguration |
withProxyUsername(String proxyUsername)
接続の際に使用するProxyの認証ユーザ(オプション)を設定し
設定を更新した自オブジェクトを返します
|
ClientConfiguration |
withProxyWorkstation(String proxyWorkstation)
NTLMプロキシサポートを設定するための任意のWindowsワークステーション名を設定し、
追加の連鎖したメソッド呼び出しのため更新したClientConfigurationオブジェクトへの
参照を返します。Windows NTLMプロキシを使っていない場合、このフィールドは不要です。
|
ClientConfiguration |
withSocketBufferSizeHints(int socketSendBufferSizeHint,
int socketReceiveBufferSizeHint)
低レベルのTCPの送信/受信バッファサイズのヒント値を設定し
更新した自オブジェクトを返します
このパラメタは拡張オプションで、パフォーマンスのさらなる向上のため
低レベルのTCPパラメタのチューニングを行ないたいユーザのために
容易されています。
|
ClientConfiguration |
withSocketTimeout(int socketTimeout)
データ転送やコネクションの確立、コネクションクローズなどのSocket
操作に関するタイムアウト値(ミリ秒)を設定し、更新した
自オブジェクトを返します
値が0の場合は無限のタイムアウト値を意味し、タイムアウトしません。
|
ClientConfiguration |
withUserAgent(String userAgent)
すべてのリクエストで送信するUserAgent文字列を設定し、更新した
自オブジェクトを返します。
|
public static final String DEFAULT_USER_AGENT
public ClientConfiguration()
public ClientConfiguration(ClientConfiguration other)
public Protocol getProtocol()
初期設定ではセキュリティ強化のため、すべてのリクエストでHTTPSを使用 します。
なお、エンドポイントのURLの一部としてプロトコルが指定されていた場合は、
この設定は上書きされます
IIJGIOWebServiceClient.setEndpoint(String)
.
public void setProtocol(Protocol protocol)
初期設定ではセキュリティ強化のため、すべてのリクエストでHTTPSを使用 します。
なお、エンドポイントのURLの一部としてプロトコルが指定されていた場合は、
この設定は上書きされます
IIJGIOWebServiceClient.setEndpoint(String)
.
protocol
- IIJ GIOストレージ&アナリシスサービス APIへ接続する際に使用するプロトコルpublic ClientConfiguration withProtocol(Protocol protocol)
初期設定ではセキュリティ強化のため、すべてのリクエストでHTTPSを使用 します。
なお、エンドポイントのURLの一部としてプロトコルが指定されていた場合は、
この設定は上書きされます
IIJGIOWebServiceClient.setEndpoint(String)
.
protocol
- IIJ GIOストレージ&アナリシスサービス APIへ接続する際に使用するプロトコルpublic int getMaxConnections()
public void setMaxConnections(int maxConnections)
maxConnections
- 許可するHTTPの最大接続数public ClientConfiguration withMaxConnections(int maxConnections)
maxConnections
- 許可するHTTPの最大接続数public String getUserAgent()
public void setUserAgent(String userAgent)
userAgent
- リクエストで送信されるUserAgent文字列public ClientConfiguration withUserAgent(String userAgent)
userAgent
- リクエストで送信されるUserAgent文字列public String getProxyHost()
public void setProxyHost(String proxyHost)
proxyHost
- 接続の際に使用するProxy hostpublic ClientConfiguration withProxyHost(String proxyHost)
proxyHost
- 接続の際に使用するProxy hostpublic int getProxyPort()
public void setProxyPort(int proxyPort)
proxyPort
- 接続の際に使用するProxy portpublic ClientConfiguration withProxyPort(int proxyPort)
proxyPort
- 接続の際に使用するProxy portpublic String getProxyUsername()
public void setProxyUsername(String proxyUsername)
proxyUsername
- 接続の際に使用するProxyの認証ユーザpublic ClientConfiguration withProxyUsername(String proxyUsername)
proxyUsername
- 接続の際に使用するProxyの認証ユーザpublic String getProxyPassword()
public void setProxyPassword(String proxyPassword)
proxyPassword
- 接続の際に使用するProxyの認証パスワードpublic ClientConfiguration withProxyPassword(String proxyPassword)
proxyPassword
- 接続の際に使用するProxyの認証パスワードpublic String getProxyDomain()
public void setProxyDomain(String proxyDomain)
proxyDomain
- NTLMプロキシを設定するための任意のWindowsドメイン名public ClientConfiguration withProxyDomain(String proxyDomain)
proxyDomain
- NTLMプロキシを設定するための任意のWindowsドメイン名public String getProxyWorkstation()
public void setProxyWorkstation(String proxyWorkstation)
proxyWorkstation
- NTLMプロキシサポートを設定するための任意のWindowsワークステーション名public ClientConfiguration withProxyWorkstation(String proxyWorkstation)
proxyWorkstation
- NTLMプロキシサポートを設定するための任意のWindowsワークステーション名public int getMaxErrorRetry()
public void setMaxErrorRetry(int maxErrorRetry)
maxErrorRetry
- リトライ可能なエラーに対する最大リトライ回数public ClientConfiguration withMaxErrorRetry(int maxErrorRetry)
maxErrorRetry
- リトライ可能なエラーに対する最大リトライ回数public int getSocketTimeout()
Socket.getSoTimeout()
public void setSocketTimeout(int socketTimeout)
socketTimeout
- Socket操作に対するタイムアウト値(ミリ秒)Socket.setSoTimeout(int)
public ClientConfiguration withSocketTimeout(int socketTimeout)
socketTimeout
- Socket操作に対するタイムアウト値(ミリ秒)Socket.setSoTimeout(int)
public int getConnectionTimeout()
Socket.connect(java.net.SocketAddress)
public void setConnectionTimeout(int connectionTimeout)
connectionTimeout
- コネクション確立時のタイムアウト値(ミリ秒)Socket.connect(java.net.SocketAddress)
public ClientConfiguration withConnectionTimeout(int connectionTimeout)
connectionTimeout
- コネクション確立時のタイムアウト値(ミリ秒)Socket.connect(java.net.SocketAddress)
public int[] getSocketBufferSizeHints()
この値はヒント値であり、バッファサイズそのものではない点に 留意してください。
public void setSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint)
この値はヒント値であり、バッファサイズを直接指定する訳ではない点に 留意してください。
socketSendBufferSizeHint
- TCP送信バッファサイズヒント(バイト数)socketReceiveBufferSizeHint
- TCP受信バッファサイズヒント(バイト数)public ClientConfiguration withSocketBufferSizeHints(int socketSendBufferSizeHint, int socketReceiveBufferSizeHint)
この値はヒント値であり、バッファサイズを直接指定する訳ではない点に 留意してください。
socketSendBufferSizeHint
- TCP送信バッファサイズヒント(バイト数)socketReceiveBufferSizeHint
- TCP受信バッファサイズヒント(バイト数)public String getProxyHostWeb()
public void setProxyHostWeb(String proxyHostWeb)
public int getProxyPortWeb()
public void setProxyPortWeb(int proxyPortWeb)
public String getProxyUsernameWeb()
public void setProxyUsernameWeb(String proxyUsernameWeb)
public String getProxyPasswordWeb()
public void setProxyPasswordWeb(String proxyPasswordWeb)
public boolean isExpectContinueEnabled()
Expect: 100-continue
を付与する場合は true を返します。public void setExpectContinueEnabled(boolean enable)
Expect: 100-continue
を付与するかどうかを指定します。(デフォルト: false)enable
- true
の場合は Expect ヘッダを付与します。public int getConnectionValidateAfterInactivity()
指定した時間の間にHTTP接続に対して操作を行わない場合は自動的にその接続を開放します。
これは、GET ObjectなどのリクエストでInputStreamをクローズしていないHTTPコネクションを回収するための仕組みです。
public void setConnectionValidateAfterInactivity(int connectionValidateAfterInactivity)
指定した時間の間にHTTP接続に対して操作を行わない場合は自動的にその接続を開放します。
これは、GET ObjectなどのリクエストでInputStreamをクローズしていないHTTPコネクションを回収するための仕組みです。
Copyright © 2018. All rights reserved.