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

クラス HTTPActionEventEntityHandler

java.lang.Object

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

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

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

ConcreteHTTPActionEventHandler, WebApplicationHTTPActionEventHandler

public abstract class HTTPActionEventEntityHandler
extends HTTPActionEventHandler

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

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

導入されたバージョン:

version 4.3

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected Properties	getEventRequestParameterMap() イベントに対するパラメータのマップを返します。
abstract String	getName() イベント名を返します。
String	getParameter(String key) 設定したパラメータ値を取得します。
Set<String>	getParameterKeySet() 現在、パラメータとして設定されているキーの一覧を返します。
Properties	getParameterMap() 設定済みパラメータのマップのコピーを返します。
boolean	hasParameter(String key) 設定したパラメータ名にパラメータがマッピングされているかどうか検査します。
void	removeParameter(String key) 指定のキーのマップを削除します。
void	setParameter(String key, String value) イベントへのパラメータを設定します。

クラスから継承されたメソッド jp.co.intra_mart.foundation.service.client.application.HTTPActionEventHandler

execute, execute, execute, getCharacterEncoding, setCharacterEncoding, setHostnameVerifier, setSSLContext

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

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

コンストラクタの詳細

HTTPActionEventEntityHandler

protected HTTPActionEventEntityHandler()

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

メソッドの詳細

getName

public abstract String getName()

イベント名を返します。

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

定義:

getName クラス内 HTTPActionEventHandler

戻り値:

イベント名

setParameter

public void setParameter(String key,
                         String value)

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

定義:

setParameter クラス内 HTTPActionEventHandler

パラメータ:

key - キー

value - 値

getParameter

public String getParameter(String key)

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

定義:

getParameter クラス内 HTTPActionEventHandler

パラメータ:

key - キー

戻り値:

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

hasParameter

public boolean hasParameter(String key)

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

定義:

hasParameter クラス内 HTTPActionEventHandler

パラメータ:

key - キー

戻り値:

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

getParameterKeySet

public Set<String> getParameterKeySet()

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

定義:

getParameterKeySet クラス内 HTTPActionEventHandler

戻り値:

キーのセット

removeParameter

public void removeParameter(String key)

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

定義:

removeParameter クラス内 HTTPActionEventHandler

パラメータ:

key - キー

getParameterMap

public Properties getParameterMap()

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

定義:

getParameterMap クラス内 HTTPActionEventHandler

戻り値:

パラメータマップ

getEventRequestParameterMap

protected Properties getEventRequestParameterMap()
                                          throws HTTPActionEventHandlerParameterException

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

定義:

getEventRequestParameterMap クラス内 HTTPActionEventHandler

戻り値:

パラメータマップ

例外:

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