intra-mart(R)
5.1

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 java.lang.Object

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

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

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

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

導入されたバージョン:
version 4.3

コンストラクタの概要
protected HTTPActionEventHandler()
          新しいイベントハンドラを作成します。
 
メソッドの概要
 HTTPActionEventResult execute(java.net.HttpURLConnection connection)
          指定された URL コネクションを利用してにサーバに接続し、 イベントの実行を要求します。
 HTTPActionEventResult execute(java.lang.String url)
          指定された URL に接続して、 イベントの実行を要求します。
 HTTPActionEventResult execute(java.net.URL url)
          指定された URL に接続して、 イベントの実行を要求します。
 java.lang.String getCharacterEncoding()
          パラメータを符号化するためのエンコーディング名を返します。
protected abstract  java.util.Properties getEventRequestParameterMap()
          イベントに対するパラメータのマップを返します。
abstract  java.lang.String getName()
          イベント名を返します。
abstract  java.lang.String getParameter(java.lang.String key)
          設定したパラメータ値を取得します。
abstract  java.util.Set getParameterKeySet()
          現在、パラメータとして設定されているキーの一覧を返します。
abstract  java.util.Properties getParameterMap()
          設定済みパラメータのマップのコピーを返します。
abstract  boolean hasParameter(java.lang.String key)
          設定したパラメータ名にパラメータがマッピングされているかどうか検査します。
abstract  void removeParameter(java.lang.String key)
          指定のキーのマップを削除します。
 void setCharacterEncoding(java.lang.String enc)
          パラメータを符号化するためのエンコーディング名を指定します。
abstract  void setParameter(java.lang.String key, java.lang.String value)
          イベントへのパラメータを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

HTTPActionEventHandler

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

メソッドの詳細

getName

public abstract java.lang.String getName()
イベント名を返します。

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

戻り値:
イベント名

setParameter

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

パラメータ:
key - キー
value - 値

getParameter

public abstract java.lang.String getParameter(java.lang.String key)
設定したパラメータ値を取得します。 指定のキーにマップされている値が存在しない場合、null を返します。

パラメータ:
key - キー
戻り値:
キーにマップされているパラメータ値

hasParameter

public abstract boolean hasParameter(java.lang.String key)
設定したパラメータ名にパラメータがマッピングされているかどうか検査します。

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

getParameterKeySet

public abstract java.util.Set getParameterKeySet()
現在、パラメータとして設定されているキーの一覧を返します。

戻り値:
キーのセット

removeParameter

public abstract void removeParameter(java.lang.String key)
指定のキーのマップを削除します。 削除されたキーおよびそのキーにマップされた値は、Application Runtime に送信されなくなります。

パラメータ:
key - キー

getParameterMap

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

戻り値:
パラメータマップ
例外:
HTTPActionEventHandlerParameterException - パラメータに異常がある場合

getEventRequestParameterMap

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

戻り値:
パラメータマップ
例外:
HTTPActionEventHandlerParameterException - パラメータに異常がある場合

getCharacterEncoding

public java.lang.String getCharacterEncoding()
パラメータを符号化するためのエンコーディング名を返します。

戻り値:
文字エンコーディング名

setCharacterEncoding

public void setCharacterEncoding(java.lang.String enc)
                          throws java.io.UnsupportedEncodingException
パラメータを符号化するためのエンコーディング名を指定します。

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

パラメータ:
enc - 文字エンコーディング名
例外:
java.io.UnsupportedEncodingException - 指定のエンコーディング名がサポートされない場合

execute

public HTTPActionEventResult execute(java.lang.String url)
                              throws java.net.MalformedURLException,
                                     java.io.IOException,
                                     HTTPActionEventHandlerException
指定された URL に接続して、 イベントの実行を要求します。

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

パラメータ:
url - 接続 URL
戻り値:
実行結果オブジェクト
例外:
HTTPActionEventHandlerException - 実行時エラー
java.net.MalformedURLException
java.io.IOException

execute

public HTTPActionEventResult execute(java.net.URL url)
                              throws java.io.IOException,
                                     HTTPActionEventHandlerException
指定された URL に接続して、 イベントの実行を要求します。

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

パラメータ:
url - 接続 URL
戻り値:
実行結果オブジェクト
例外:
HTTPActionEventHandlerException - 実行時エラー
java.io.IOException

execute

public HTTPActionEventResult execute(java.net.HttpURLConnection connection)
                              throws java.io.IOException,
                                     HTTPActionEventHandlerException
指定された URL コネクションを利用してにサーバに接続し、 イベントの実行を要求します。

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

パラメータ:
connection - コネクション
戻り値:
実行結果オブジェクト
例外:
java.io.IOException - 入出力エラー
HTTPActionEventHandlerException - 実行時エラー

intra-mart(R)
5.1

Copyright © 2000-2006 NTT DATA INTRAMART CO.,LTD. All Rights Reserved.