jp.co.intra_mart.foundation.service.client.application

クラス HTTPActionEventHandler

java.lang.Object

jp.co.intra_mart.foundation.service.client.application.HTTPActionEventHandler

直系の既知のサブクラス:

HTTPActionEventEntityHandler, HTTPActionEventFilterHandler

public abstract class HTTPActionEventHandler
extends Object

HTTPActionEvent の 実行をサーバに要求するためのハンドラの抽象実装です。

この抽象実装は、すべての HTTPActionEvent ハンドラの スーパークラスになります。

ハンドラを作成してイベント実行を要求する場合、execute(String) または execute(java.net.URL) を利用します。 execute(java.net.HttpURLConnection) も利用できますが、 通常はこの方法を使わない方が良いと思われます。

イベント実行を要求するＵＲＬは、 HTTPActionEventListener へ接続できるものを指定します。 標準では、下記のようになります。
http://<サーバアドレス>[:<ポート番号>]/imart/HTTPActionEventListener

外部ソフトウェア接続モジュールでは、HTTPS プロトコルを利用した通信が可能です。
以下に、簡単にHTTPSプロトコルを利用した通信を行う方法を記します。

1. 証明書の追加

JDK 付属のツール keytool の -import コマンドを使って、信頼できる証明書をリストに追加します。
例えば、サーバ証明書「C:¥temp¥server.crt」を、 別名「sample_alias」でキーストアエントリに格納するには、以下のコマンドを実行します。

 >keytool -import -alias sample_alias -file C:¥temp¥server.crt
 

上記コマンドを実行すると、ユーザのホームディレクトリの「.keystore」ファイルに、キーストアが作成されます。
（keytoolの詳細は、 keytool - 鍵と証明書の管理ツール を参照してください）


2. キーストアを指定して、クライアントを実行

外部ソフトウェア接続モジュールのクライアントが、証明書ファイルを利用できる状態に設定します。
java コマンドを実行する際、次のオプションをコマンド行に追加し、手順1 で追加したキーストアを指定します。
ここでは、ユーザのホームディレクトリを「 /home/user_name 」とします。

 -Djavax.net.ssl.trustStore=/home/user_name/.keystore
 


Windows環境の例 （ホームディレクトリが「 C:¥Documents and Settings¥user_name 」の場合）


 -Djavax.net.ssl.trustStore="C:¥¥Documents and Settings¥¥user_name¥¥.keystore"
 

簡単にHTTPSプロトコルを利用した通信を行う方法は 以上です。


外部ソフトウェア接続モジュールは、HTTPS プロトコルを利用した通信を行う際に、 HttpsURLConnection を利用して通信を行います。
そのため、デフォルト動作をオーバライドしたい場合、以下の二つを設定する必要があります。

• javax.net.ssl.HostnameVerifier

外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の HostnameVerifier を setHostnameVerifier(HostnameVerifier) メソッドで設定します。
（この HostnameVerifier は、URL ホスト名のデフォルトの検証規則が失敗した場合に使用されます）
HostnameVerifier が設定されていない場合、
ホスト名が認証方式に準拠しているかどうかに関わらず、接続を許可します。


• javax.net.ssl.SSLContext

外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の SSLSocketFactory を生成する SSLContextを、 setSSLContext(SSLContext) メソッドで設定します。
SSLContext が設定されていない場合、
HttpsURLConnection に対して SSLSocketFactory の設定を行いません。

HTTPS プロトコルを利用した通信を行うには、Java Secure Socket Extension (JSSE) の知識が必要です。
詳しくは、 Java Secure Socket Extension (JSSE) リファレンスガイド を参照してください。

導入されたバージョン:

version 4.3

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

コンストラクタ

修飾子	コンストラクタと説明
protected	HTTPActionEventHandler() 新しいイベントハンドラを作成します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
HTTPActionEventResult	execute(HttpURLConnection connection) 指定された URL コネクションを利用してにサーバに接続し、 イベントの実行を要求します。
HTTPActionEventResult	execute(String url) 指定された URL に接続して、 イベントの実行を要求します。
HTTPActionEventResult	execute(URL url) 指定された URL に接続して、 イベントの実行を要求します。
String	getCharacterEncoding() パラメータを符号化するためのエンコーディング名を返します。
protected abstract Properties	getEventRequestParameterMap() イベントに対するパラメータのマップを返します。
abstract String	getName() イベント名を返します。
abstract String	getParameter(String key) 設定したパラメータ値を取得します。
abstract Set<String>	getParameterKeySet() 現在、パラメータとして設定されているキーの一覧を返します。
abstract Properties	getParameterMap() 設定済みパラメータのマップのコピーを返します。
abstract boolean	hasParameter(String key) 設定したパラメータ名にパラメータがマッピングされているかどうか検査します。
abstract void	removeParameter(String key) 指定のキーのマップを削除します。
void	setCharacterEncoding(String enc) パラメータを符号化するためのエンコーディング名を指定します。
void	setHostnameVerifier(HostnameVerifier hostnameVerifier) 外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の HostnameVerifier を設定します。
abstract void	setParameter(String key, String value) イベントへのパラメータを設定します。
void	setSSLContext(SSLContext sslContext) 外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の SSLSocketFactory を生成する SSLContextを設定します。

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

HTTPActionEventHandler

protected HTTPActionEventHandler()

新しいイベントハンドラを作成します。

メソッドの詳細

getName

public abstract String getName()

イベント名を返します。

実際には、Application Runtime で実行される HTTPActionEvent を 実装したクラスのクラス名を返します。

戻り値:

イベント名

setParameter

public abstract void setParameter(String key,
                                  String value)

イベントへのパラメータを設定します。 ここで設定した値は、Application Runtime で実行されるイベントにて、 通常のＵＲＬ引数として受け取ることができます。 値を取得するには、サーブレットプログラムにおいてＵＲＬパラメータを 取得する一般的な方法と同様に、HttpServletRequest#getParameter(String) を利用してください。

パラメータ:

key - キー

value - 値

getParameter

public abstract String getParameter(String key)

設定したパラメータ値を取得します。 指定のキーにマップされている値が存在しない場合、null を返します。

パラメータ:

key - キー

戻り値:

キーにマップされているパラメータ値

hasParameter

public abstract boolean hasParameter(String key)

設定したパラメータ名にパラメータがマッピングされているかどうか検査します。

パラメータ:

key - キー

戻り値:

キーにパラメータ値がマップされている場合 true。

getParameterKeySet

public abstract Set<String> getParameterKeySet()

現在、パラメータとして設定されているキーの一覧を返します。

戻り値:

キーのセット

removeParameter

public abstract void removeParameter(String key)

指定のキーのマップを削除します。 削除されたキーおよびそのキーにマップされた値は、Application Runtime に送信されなくなります。

パラメータ:

key - キー

getParameterMap

public abstract Properties getParameterMap()

設定済みパラメータのマップのコピーを返します。 パラメータ名をキーとしてパラメータ値がマッピングされている java.util.Properties を返します。

戻り値:

パラメータマップ

例外:

HTTPActionEventHandlerParameterException - パラメータに異常がある場合

getEventRequestParameterMap

protected abstract Properties getEventRequestParameterMap()
                                                   throws HTTPActionEventHandlerParameterException

イベントに対するパラメータのマップを返します。
パラメータ名をキーとしてパラメータ値がマッピングされている java.util.Properties を返します。 イベントでは、javax.servlet.ServletRequest からリクエストパラメータとして、 #getParameter(String) メソッドなどにより取得できます。

戻り値:

パラメータマップ

例外:

HTTPActionEventHandlerParameterException - パラメータに異常がある場合

getCharacterEncoding

public String getCharacterEncoding()

パラメータを符号化するためのエンコーディング名を返します。

戻り値:

文字エンコーディング名

setCharacterEncoding

public void setCharacterEncoding(String enc)
                          throws UnsupportedEncodingException

パラメータを符号化するためのエンコーディング名を指定します。

デフォルトでは UTF-8 を用いてパラメータを符号化します。 また、イベントへの各パラメータ値は Unicode のまま扱われますので、 通常は文字エンコーディングを変更する必要はありません。

パラメータ:

enc - 文字エンコーディング名

例外:

UnsupportedEncodingException - 指定のエンコーディング名がサポートされない場合

execute

public HTTPActionEventResult execute(String url)
                              throws MalformedURLException,
                                     IOException,
                                     HTTPActionEventHandlerException

指定された URL に接続して、 イベントの実行を要求します。

このメソッドは、指定の URL 文字列から java.net.URL のインスタンスを 作成して execute(java.net.URL) メソッドを呼び出します。

パラメータ:

url - 接続 URL

戻り値:

実行結果オブジェクト

例外:

HTTPActionEventHandlerException - 実行時エラー

MalformedURLException

IOException

execute

public HTTPActionEventResult execute(URL url)
                              throws IOException,
                                     HTTPActionEventHandlerException

指定された URL に接続して、 イベントの実行を要求します。

このメソッドは、指定の java.net.URL から java.net.HttpURLConnection を取得して execute(java.net.HttpURLConnection) メソッドを呼び出します。

パラメータ:

url - 接続 URL

戻り値:

実行結果オブジェクト

例外:

HTTPActionEventHandlerException - 実行時エラー

IOException

execute

public HTTPActionEventResult execute(HttpURLConnection connection)
                              throws IOException,
                                     HTTPActionEventHandlerException

指定された URL コネクションを利用してにサーバに接続し、 イベントの実行を要求します。

このメソッドは、 getParameterMap() の返り値をイベントの引数として サーバに対して getName() が表すイベントの 実行を要求します。

パラメータ:

connection - コネクション

戻り値:

実行結果オブジェクト

例外:

IOException - 入出力エラー

HTTPActionEventHandlerException - 実行時エラー

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier hostnameVerifier)

外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の HostnameVerifier を設定します。
（このHostnameVerifierは、URL ホスト名のデフォルトの検証規則が失敗した場合に使用されます）

HostnameVerifier が設定されていない場合、
ホスト名が認証方式に準拠しているかどうかに関わらず、接続を許可します。

パラメータ:

hostnameVerifier - 外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の HostnameVerifier

導入されたバージョン:

version 6.1

setSSLContext

public void setSSLContext(SSLContext sslContext)

外部ソフトウェア接続モジュールを利用して HTTPS 通信を行う際の SSLSocketFactory を生成する SSLContextを設定します。
SSLContext が設定されていない場合、
HttpsURLConnection に対して SSLSocketFactory の設定を行いません。

デフォルト動作をオーバライドする場合を除き、 SSLContext オブジェクトを直接作成したり初期化したりする必要はありません。

パラメータ:

sslContext - SSLContext

導入されたバージョン:

version 6.1