jp.co.hitachi.soft.portal.api.portlets.PortletParameters

機能

ポートレット間でパラメタを受け渡すためのインタフェースです。

使用方法

ポートレットでこのインタフェースを実装した場合,各ポートレットデプロイ定義ファイル(hportlet.xml)の中に以下の形式で実装クラスを指定します。

<param-name>hptl.portlet.parameters</param-name>

<param-value>PortletParameters実装クラスのFQCN(パッケージ名を含むクラス名)</param-value>

PortletParameters実装クラスの呼び出し側では,上記より取得したFQCNからClass.forNameでオブジェクトを取得して,newInstanceメソッドでインスタンス化します。そのインスタンスに対してsetRequestメソッドを発行後,ウィンドウサイズ情報の取得用のキーなどを指定してgetParameterメソッドをコールすることで,対応する情報を取得します。newInstanceでPortletParametersのインスタンスを生成する呼び出し側では,JSPページ内やrequestスコープ内でインスタンスを解放し,このインスタンスを複数ページ/複数スレッド間で共有してはいけません。

メソッドの一覧

戻り値のデータ型メソッド説明
voidsetRequest(javax.servlet.http.HttpServletRequest req)リクエストオブジェクトを設定します。必ず最初にこのメソッドを呼び出してください。
java.lang.StringgetParameter(java.lang.String key)指定したキーに対応するポートレットの設定値を取得します。

メソッドの説明

setRequest
形式

public void setRequest(javax.servlet.http.HttpServletRequest req)

機能
このメッソドを発行することで,PortletParameters実装クラスからHttpServletRequestオブジェクトを利用できるようになります。PortletParameters実装クラスの呼び出し側は,必ず最初にこのメソッドを呼び出す必要があります。
パラメタ
req - HttpServletRequestオブジェクト
戻り値
なし
getParameter
形式

public java.lang.String getParameter(java.lang.String key)

機能
指定したキーに対応するポートレットの設定値を取得します。
パラメタ
key - 設定値を取得するためのキー値
戻り値
キーに対応する設定値。設定値を返せない場合にはnullを返す。