nablarch.fw.messaging.realtime.http.client

クラス HttpProtocolBasicClient

java.lang.Object

nablarch.fw.messaging.realtime.http.client.HttpProtocolBasicClient

すべての実装されたインタフェース:

HttpProtocolClient

@Published(tag="architect")
public class HttpProtocolBasicClient
extends Object
implements HttpProtocolClient

Http接続用クライアント。

作成者:

TIS

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
HttpProtocolBasicClient() コンストラクタ

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected HttpURLConnection	createHttpConnection(String targetUrl, nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum method, Map<List> headerInfo) HttpURLConnectionを作成する。
HttpResult	execute(nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod, String url, Map<List> headerInfo, Map urlParams, HttpOutputStreamWriter writer, HttpInputStreamReader reader) HTTP通信を行う。
protected String	paramStringBuilder(Map paramData) URLにパラメータを文字列として埋め込む場合の文字列を作成して返却する。
void	setAccept(String accept) 受け入れるデータ種別を設定する。
void	setConnectTimeout(int connectTimeout) 接続タイムアウトを設定する。
void	setContentType(String contentType) コンテンツタイプを設定する。
void	setProxyInfo(String url, int port) プロキシ情報を設定する。
void	setQueryStringEncoding(String queryStringEncoding) パラメータをエンコードする際に使用する文字コードを設定する。
void	setReadTimeout(int readTimeout) 読み取りタイムアウトを設定する。
void	setSslContext(SSLContext sslContext) SSLContextを設定する。

コンストラクタの詳細

HttpProtocolBasicClient

public HttpProtocolBasicClient()

コンストラクタ

メソッドの詳細

setProxyInfo

public void setProxyInfo(String url,
                         int port)

プロキシ情報を設定する。

定義:

setProxyInfo インタフェース内 HttpProtocolClient

パラメータ:

url - プロキシURL

port - ポート番号

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

接続タイムアウトを設定する。

定義:

setConnectTimeout インタフェース内 HttpProtocolClient

パラメータ:

connectTimeout - 接続タイムアウト

setReadTimeout

public void setReadTimeout(int readTimeout)

読み取りタイムアウトを設定する。

定義:

setReadTimeout インタフェース内 HttpProtocolClient

パラメータ:

readTimeout - 読み取りタイムアウト

setContentType

public void setContentType(String contentType)

コンテンツタイプを設定する。

定義:

setContentType インタフェース内 HttpProtocolClient

パラメータ:

contentType - コンテンツタイプ

setAccept

public void setAccept(String accept)

受け入れるデータ種別を設定する。

定義:

setAccept インタフェース内 HttpProtocolClient

パラメータ:

accept - 受け入れるデータ種別

setSslContext

public void setSslContext(SSLContext sslContext)

SSLContextを設定する。

定義:

setSslContext インタフェース内 HttpProtocolClient

パラメータ:

sslContext - SSLContext

setQueryStringEncoding

public void setQueryStringEncoding(String queryStringEncoding)

パラメータをエンコードする際に使用する文字コードを設定する。

定義:

setQueryStringEncoding インタフェース内 HttpProtocolClient

パラメータ:

queryStringEncoding - 文字コード

execute

public HttpResult execute(nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                          String url,
                          Map<List> headerInfo,
                          Map urlParams,
                          HttpOutputStreamWriter writer,
                          HttpInputStreamReader reader)
                   throws HttpMessagingException

HTTP通信を行う。

定義:

execute インタフェース内 HttpProtocolClient

パラメータ:

httpMethod - HTTPメソッド

url - 接続先

headerInfo - HttpHeadderに渡す情報

urlParams - URLパラメータ。送信するパラメータがない場合は、null可。

writer - StreamWritter。送信するBody部が存在しない場合は、null可。

reader - 応答の読み込みに使用するreader

戻り値:

レスポンスコード

例外:

HttpMessagingException - 何らかの理由(接続タイムアウト、ソケットの予期せぬclose等)で通信が失敗した場合に送出される。

createHttpConnection

protected HttpURLConnection createHttpConnection(String targetUrl,
                                                 nablarch.fw.messaging.realtime.http.client.HttpProtocolClient.HttpRequestMethodEnum method,
                                                 Map<List> headerInfo)

HttpURLConnectionを作成する。

パラメータ:

targetUrl - 接続先

method - 接続メソッド

headerInfo - HttpHeadderに渡す情報

戻り値:

HttpURLConnection

例外:

IOException - 接続例外

paramStringBuilder

protected String paramStringBuilder(Map paramData)

URLにパラメータを文字列として埋め込む場合の文字列を作成して返却する。

パラメータ:

paramData - 作成元パラメータ

戻り値:

作成結果