nablarch.fw.messaging.realtime.http.client

Class HttpProtocolBasicClient

java.lang.Object

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

All Implemented Interfaces:

HttpProtocolClient

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

Http接続用クライアント。

Nested Class Summary

Nested classes/interfaces inherited from interface nablarch.fw.messaging.realtime.http.client.HttpProtocolClient

HttpProtocolClient.HttpRequestMethodEnum

Constructor Summary

Constructors

Constructor and Description
HttpProtocolBasicClient() コンストラクタ

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpProtocolBasicClient

public HttpProtocolBasicClient()

コンストラクタ

Method Detail

setProxyInfo

public void setProxyInfo(java.lang.String url,
                         int port)

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

Specified by:

setProxyInfo in interface HttpProtocolClient

Parameters:

url - プロキシURL

port - ポート番号

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

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

Specified by:

setConnectTimeout in interface HttpProtocolClient

Parameters:

connectTimeout - 接続タイムアウト

setReadTimeout

public void setReadTimeout(int readTimeout)

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

Specified by:

setReadTimeout in interface HttpProtocolClient

Parameters:

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

setContentType

public void setContentType(java.lang.String contentType)

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

Specified by:

setContentType in interface HttpProtocolClient

Parameters:

contentType - コンテンツタイプ

setAccept

public void setAccept(java.lang.String accept)

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

Specified by:

setAccept in interface HttpProtocolClient

Parameters:

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

setSslContext

public void setSslContext(javax.net.ssl.SSLContext sslContext)

SSLContextを設定する。

Specified by:

setSslContext in interface HttpProtocolClient

Parameters:

sslContext - SSLContext

setQueryStringEncoding

public void setQueryStringEncoding(java.lang.String queryStringEncoding)

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

Specified by:

setQueryStringEncoding in interface HttpProtocolClient

Parameters:

queryStringEncoding - 文字コード

execute

public HttpResult execute(HttpProtocolClient.HttpRequestMethodEnum httpMethod,
                          java.lang.String url,
                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerInfo,
                          java.util.Map<java.lang.String,java.lang.String> urlParams,
                          HttpOutputStreamWriter writer,
                          HttpInputStreamReader reader)
                   throws HttpMessagingException

HTTP通信を行う。

Specified by:

execute in interface HttpProtocolClient

Parameters:

httpMethod - HTTPメソッド

url - 接続先

headerInfo - HttpHeadderに渡す情報

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

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

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

Returns:

レスポンスコード

Throws:

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

createHttpConnection

protected java.net.HttpURLConnection createHttpConnection(java.lang.String targetUrl,
                                                          HttpProtocolClient.HttpRequestMethodEnum method,
                                                          java.util.Map<java.lang.String,java.util.List<java.lang.String>> headerInfo)
                                                   throws java.io.IOException

HttpURLConnectionを作成する。

Parameters:

targetUrl - 接続先

method - 接続メソッド

headerInfo - HttpHeadderに渡す情報

Returns:

HttpURLConnection

Throws:

java.io.IOException - 接続例外

paramStringBuilder

protected java.lang.String paramStringBuilder(java.util.Map<java.lang.String,java.lang.String> paramData)

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

Parameters:

paramData - 作成元パラメータ

Returns:

作成結果