この章は、読者が WebSphere® Portal のポートレット開発について十分理解していることが前提になっています。「HATS ユーザーと管理者のガイド」に、HATS ポートレットを作成する方法および HATS Web プロジェクトをポートレット・プロジェクトに変換する方法について説明があります。ご使用の HATS マシンに WebSphere Portal Toolkit をインストールしておいてください。 Portal ツールを使用して、ポートレットの作成、管理、展開、および実行を Rational® SDP 環境で行うことができます。 WebSphere Portal Toolkit は、Rational SDP と共にインストールされます。Rational SDP をインストールする際に、「ポータル・ツール」チェック・ボックスを選択します。
IBM® ポートレット API に準拠するか、標準の Java™ ポートレット仕様 API (JSR 168) に準拠する (以降、「標準ポートレット API」) HATS ポートレットを開発できます。標準ポートレット API (JSR 168) に準拠する HATS ポートレットを、「標準ポートレット」と呼びます。
ポートレットは、WebSphere Portal v6.0 または v6.1 をターゲットにできます。WebSphere Portal v6.0 または v6.1 のいずれかをターゲットとする標準 (JSR 168) ポートレットは、WebSphere Application Server V6.1 または V7.0 上でも実行できます。
Portal API の資料 (Javadoc) はツールキットと一緒にインストールされます。この資料には、この章で説明するタスクの実行に役立つ情報があります。Portal API はビジネス・ロジックまたは JSP で使用できます。Portal API と共に HATS ビジネス・ロジックを使用する詳細な例は、HATS インフォメーション・センターの「Portlet messaging with IBM Rational Host Access Transformation Services (HATS)」という資料にあります。
以下は、IBM ポートレットに固有の内容です。
ポートレットのカスタマイズを何種類か行うので、そのためのビジネス・ロジック・クラスを作成する必要があります。HATS Toolkit で「ビジネス・ロジックの作成」ウィザードを使用すると、「ポートレット・サンプル・メソッドの作成」というラベルのチェック・ボックスが表示されます。このチェック・ボックスを選択すると、HATS は、ポートレットの通信およびセキュリティーに関連したサンプル・メソッドをビジネス・ロジック・クラス内に作成します。これらのメソッドについては、この章の該当するセクションの中で具体的に示します。
WebSphere Portal で信任状ボールトを使用している場合は、信任状ボールトを処理するように HATS ポートレットを構成できます。HATS には、WebSphere Portal Credential Vault Credential Mapper という Web 高速ログオン・プラグインがあります。このプラグインは、ポートレット・プロジェクトに関してのみ、「信任状マッパー・プラグインの追加」ウィンドウに表示されます。このプラグインは、単一プラグイン・パラメーター、SlotID」 を使用して名前が指定されたボールト・スロットから、受動ユーザー・パスワード信任状を検索します。使用される実際のボールト・スロット ID は、ホスト名とアプリケーション名をスペースを使用して連結したスロット ID になります。スロット ID のこの 3 つのエレメントはエンコードされ、スペースは下線に置換されます。このスロット ID の生成方法については、信任状ボールト・ビジネス・ロジック・メソッドのサンプルを参照してください。「ポートレット・サンプル・メソッドの作成」チェック・ボックスを選択すると、これらのメソッドが新規のビジネス・ロジック・クラスに追加されます。
開発者は、対象ユーザーのボールト・スロットの作成および取り込みを行います。Web 高速ログオン・プラグインは、ビジネス・ロジック setUserCredential() メソッドを使用して作成された信任状で直接使用できます。このメソッドはスロットに対して同じ命名規則に従うからです。ボールト・スロットは、ビジネス・ロジックに指定された信任状または他のソースから検索された信任状と一緒に取り込むことができます。ポータル・ユーザー ID を使用する場合は、WebSphere Portal ネットワーク・セキュリティー・プラグインを使用すれば、ID を検索できます。このプラグインは、ポートレット・プロジェクトの場合に限り、「ネットワーク・セキュリティー・プラグインの追加 (Add Network Security plug-in)」ウィンドウに表示されます。
Web 高速ログオンのプラグインの作成で説明したとおり、Web 高速ログオンが使用するプラグインには、ネットワーク・セキュリティー・プラグインと信任状マッパー・プラグインの 2 種類があります。 HATS で提供される任意のネットワーク・セキュリティー・プラグインは、HATS ポートレットで使用できます。表 4 に、ポートレットで使用可能なプラグインの組み合わせ例を示します。
| ネットワーク・セキュリティー・プラグイン | 信任状マッパー・プラグイン |
|---|---|
| WebSphere Portal NS プラグイン | 任意の提供されたプラグイン、カスタムの CM プラグイン、または WebSphere Portal Credential Vault CM プラグイン |
| なし | WebSphere Portal Credential Vault CM プラグイン |
| カスタム NS プラグイン | カスタム CM プラグイン |
以下の手順は、Web 高速ログオン 機能をポートレットに追加する方法の 1 つの例です。このロジックを HATS ポートレットの開始イベントに追加してください。
ユーザーがポートレットをオープンしたときに、ユーザーのホスト信任状がすでに提供されているかを示すグローバル変数を検査します。
HATS ポートレットに機能を追加する方法の一つとして、入力ポートレットの拡張があります。例えば、ポートレットにメッセージを listen させたり、プロパティーを連携ポートレットとして交換するために、入力ポートレットを拡張することができます。入力ポートレットを拡張するには、新規クラス・ファイルを作成する必要があります。以下の手順を実行してください。
ポートレットは、相互にメッセージを送信できます。メッセージは、特定のポートレットに向けて送信することも、すべてのポートレットにブロードキャストすることもできます。ポートレットがメッセージを送受信できるようにするには、このセクションで示す手順を実行してください。
HATS ポートレットからメッセージを送信するには、以下の手順を実行します。
メッセージを受信するには、入力ポートレットの拡張の説明に従って、入力ポートレットを拡張する必要があります。カスタム・クラスには org.apache.jetspeed.portlet.event.MessageListener インターフェースが実装されていなければなりません。該当するメソッドを実装してください。メッセージから情報を検索したら、その情報を共用グローバル変数に保管します。これにより、その情報は通常の HATS の方法でアクセスできるようになり、画面認識で使用できます。メソッドのサンプルは以下のとおりです。
public void messageReceived(MessageEvent event) throws PortletException {
PortletRequest request = event.getRequest();
PortletSession session = request.getPortletSession();
DefaultPortletMessage dpm = (DefaultPortletMessage) event.getMessage();
ClientSpecificInfo csi =
ClientContainer.getInstance().accessClient(session.getId());
if (csi == null) {
System.out.println("mesg receiver can not access csi");
return;
}
Hashtable gvs = csi.getGlobalVariables();
IGlobalVariable gv = new GlobalVariable("msg", dpm.getMessage());
gvs.put("msg", gv);
}
連携ポートレット は、プロパティー・ブローカーを通じて情報を交換するポートレットです。連携ポートレットはページ上の他の連携ポートレットへの変更に対処するので、最低限のユーザー介入だけで複数のポートレットを同時に更新できます。詳しくは、http://publib.boulder.ibm.com/infocenter/wpdoc/v6r1m0/index.jsp にある WebSphere Portal インフォメーション・センターの連携ポートレットのセクションを参照してください。
IBM の Click-to-Action インプリメンテーションを使用する場合は、ワイヤーをポートレット内で作成することができます。これは、「Click-to-Action」アイコンをクリックして、ユーザーが現在のアクションの選択を自動化したいかどうかをダイアログを介して確認しながら、Ctrl または Alt のいずれかを押したままにすることによって行います。ワイヤリングを正常にサポートするには、「Click-to-Action」アイコンのレンダリングに使用される <c2a:encodeProperty/> タグの name 属性がプロパティー・ブローカーで登録された出力プロパティーを参照する必要があります。
連携ポートレットを実装するには、次の 3 つのステップが必要になります。各ステップの詳細は、以降のセクションで説明します。
ポートレットの間の Click-to-Action (C2A) を使用可能にするには、以下のものの構成が必要です。
ポートレットを特殊なクラスでラップするため、HATS ポートレット・アプリケーションの web.xml ファイルを以下のように変更します。
<servlet id="Servlet_1"> <servlet-name>EntryPortlet</servlet-name> <display-name>entry</display-name> <servlet-class>com.ibm.wps.pb.wrapper.PortletWrapper</servlet-class> <init-param> <param-name>c2a-application-portlet-class</param-name> <param-value>com.ibm.hats.runtime.EntryPortlet</param-value> </init-param> <load-on-startup>-1</load-on-startup> </servlet>
プロパティーを公開するには、まず最初に、公開するプロパティーを登録する必要があります。publishPortletProperty は、「ポートレット・サンプル・メソッドの作成」チェック・ボックスを選択した場合に新規のビジネス・ロジック・クラスに作成されるメソッドであり、常に HATS グローバル変数を受け渡します。次に、以下の手順を実行します。
プロパティーを公開するには、以下の手順を実行します。
公開する予定のグローバル変数の名前を登録しなければならないのと同様に、更新情報を受信したいグローバル変数の名前も登録する必要があります。以下の手順を実行してください。
プロパティー更新メッセージを受信するには、入力ポートレットの拡張の説明に従って、入力ポートレットを拡張する必要があります。カスタム・クラスには、PropertyListener インターフェースが実装されていなければなりません。該当するメソッドを実装してください。ポートレットのメッセージングの場合とほとんど同じ方法で、Properties の配列からプロパティーを検索し、現在のグローバル変数セットを変更できます。
着信プロパティーのトレースの例を以下に示します。同様の手法を使用して受信プロパティーをたどり、それらをトレースすることができます。
public void setProperties(PortletRequest arg0, PropertyValue[] pvs) {
for(int i=0;i<pvs.length;i++) {
PropertyValue pv = pvs[i];
System.out.println("prop name: "+pv.getProperty().getName()+" type "
+pv.getProperty().getType());
System.out.println("with val: "+pv.getValue().toString());
}
}
HATS プロジェクト・アプリケーションがモデル 1 ページに基づいている場合は、同じ機能を備えたポートレットを作成できます。この方法を行うには、アプリケーション内に、Java Server Pages (JSP) が駆動する統合オブジェクトが含まれている必要があります。HATS モデル 1 Web ページについては、「HATS ユーザーと管理者のガイド」の『モデル 1 Web ページの作成』を参照してください。
ポートレットを作成するには、以下の手順を実行します。
public static final String HP_PAGE_TARGET = "/model1/jsp/Output.jsp";
public static final String DEFAULT_VIEW_JSP = "/model1/jsp/Input.jsp";
public static HashMap actionMap = new HashMap();
static {
actionMap.put("action1","/model1/jsp/Output.jsp"");
actionMap.put("action2","/jsp/HPPage2.jsp");
actionMap.put("action3","/jsp/HPPage3.jsp");
}public void doView(PortletRequest request, PortletResponse response)
throws PortletException, IOException {
String jspTarget = (String) request.getAttribute(HP_PAGE_TARGET);
if(jspTarget==null) { //for a simple refresh
jspTarget = (String)
request.getPortletSession().getAttribute(HP_PAGE_TARGET);
}
if(jspTarget==null) { //for the initial portlet view
jspTarget = DEFAULT_VIEW_JSP;
}
request.getPortletSession().setAttribute(HP_PAGE_TARGET,jspTarget);
getPortletConfig().getContext().include(jspTarget, request, response);
}
public void actionPerformed(ActionEvent event) throws PortletException {
String actionString = event.getActionString();
PortletRequest request = event.getRequest();
if(actionMap.containsKey(actionString)) {
request.setAttribute(HP_PAGE_TARGET,actionMap.get(actionString));
}
}<portletAPI:createURI> <portletAPI:URIAction name="action1" /> </portletAPI:createURI>
以下は、標準ポートレットに固有の内容です。
WebSphere Portal で信任状ボールトを使用している場合は、信任状ボールトを処理するように HATS ポートレットを構成できます。HATS には、WebSphere Portal Credential Vault Credential Mapper という Web 高速ログオン・プラグインがあります。このプラグインは、ポートレット・プロジェクトに関してのみ、「信任状マッパー・プラグインの追加」ウィンドウに表示されます。このプラグインは、ボールト・スロットから、受動ユーザー・パスワード信任状を検索します。
以下のクラスは、標準標準ポートレットによる Portal Credential Vault へのアクセスを支援するために提供されています。
CredentialVaultHelper クラスには、以下の public メソッドがあります。 getInstance() メソッドは、CredentialVaultHelper の固有のインスタンスを返すことに注意してください。
public static CredentialVaultHelper getInstance(); public static String generateSlotName(String vaultId,String hostDestination,String hostAppId); public String getSlotId(PortletRequest portletRequest, String slotName, int slotType); public void setCredential(String slotId,UserPasswordCredential credential,PortletRequest portletRequest); public UserPasswordCredential getCredential(String slotId,PortletRequest portletRequest);
UserPasswordCredential クラスには、以下の public メソッドがあります。
public UserPasswordCredential(); public UserPasswordCredential(String user,char[] password); public void setUser(String user); public void setPassword(char[] password); public void setPassword(String password); public String getUser(); public String getPassword();
com.ibm.hats.portlet.cv.CredentialVaultHelper クラスおよび com.ibm.hats.portlet.cv.UserPasswordCredential クラスの詳細については、HATS Information Center (http://publib.boulder.ibm.com/infocenter/hatshelp/v75/index.jsp) の HATS API References (Javadoc) を参照してください。
開発者は、対象ユーザーのボールト・スロットの作成および取り込みを行います。Web 高速ログオン・プラグインは、com.ibm.hats.portlet.cv.CredentialVaultHelper クラスの setCredential() メソッドを使用して作成された信任状で直接使用できます。このメソッドはスロットに関して同じ命名規則に従うためです。ボールト・スロット名は、com.ibm.hats.portlet.cv.CredentialVaultHelper クラスの generateSlotName() メソッドを使用して生成できます。このメソッドに対して、プラグイン・パラメーターの SLOT_ID、ホスト名、およびアプリケーション名 (IBM i サーバーへの接続時などアプリケーション名が適用されない場合は、NULL を使用) を渡します。生成されるスロット名は、ホスト名とアプリケーション名をスペースを使用して連結した SLOT_ID になります。スロット名のこの 3 つのエレメントはエンコードされ、スペースは下線に置換されます。次に、com.ibm.hats.portlet.cv.CredentialVaultHelper クラスの getSlotId() メソッドを使用して、実際のボールト・スロット ID を取得できます。ここでは、PortletRequest、スロット名、および SLOT_TYPE を渡します。 SLOT_TYPE が 2 または 3 の場合、スロット ID はスロット名と等しくなります。
ボールト・スロットは、ビジネス・ロジックに指定された信任状または他のソースから検索された信任状と一緒に取り込むことができます。ポータル・ユーザー ID を使用する場合は、WebSphere Portal ネットワーク・セキュリティー・プラグインを使用すれば、ID を検索できます。このプラグインは、ポートレット・プロジェクトの場合に限り、「ネットワーク・セキュリティー・プラグインの追加 (Add Network Security plug-in)」ウィンドウに表示されます。
Web 高速ログオンのプラグインの作成で説明したとおり、Web 高速ログオンが使用するプラグインには、ネットワーク・セキュリティー・プラグインと信任状マッパー・プラグインの 2 種類があります。 HATS で提供される任意のネットワーク・セキュリティー・プラグインは、HATS ポートレットで使用できます。表 5 に、ポートレットで使用可能なプラグインの組み合わせ例を示します。
| ネットワーク・セキュリティー・プラグイン | 信任状マッパー・プラグイン |
|---|---|
| WebSphere Portal NS プラグイン | 任意の提供されたプラグイン、カスタムの CM プラグイン、または WebSphere Portal Credential Vault CM プラグイン |
| なし | WebSphere Portal Credential Vault CM プラグイン |
| カスタム NS プラグイン | カスタム CM プラグイン |
以下の手順は、Web 高速ログオン 機能をポートレットに追加する方法の 1 つの例です。このロジックを HATS ポートレットの開始イベントに追加してください。ユーザーがポートレットをオープンしたときに、ユーザーのホスト信任状が既に提供されているかどうかを示すグローバル変数を検査します。
HATS 標準ポートレットを拡張して、機能を追加したり、ポートレットをカスタマイズしたりできます。例えば、ポートレットを拡張して、接続パラメーターおよびグローバル変数のオーバーライドを指定することができます。
標準 Entry ポートレットを拡張するには、Java クラス・ファイルをカスタマイズする必要があります。
以下の例は、拡張したポートレット・クラスを使用して、接続パラメーターおよびグローバル変数のオーバーライドを指定する方法を示したものです。
public Properties getInitParameters(IRequest request)
{
Properties initParams = new Properties();
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.HOST, "129.12.11.2");
initParams.setProperty(com.ibm.eNetwork.beans.HOD.Session.PORT, "623");
initParams.setProperty("hatsgv_userName", "some user");
initParams.setProperty("hatsgv_password", "xxxxx");
initParams.setProperty("hatssharedgv_someVariable", "zzzzz");
return initParams;
}選択した接続パラメーターまたはグローバル変数のオーバーライドを可能にするには、プロジェクトのセキュリティー設定も構成する必要があります。この構成は、「プロジェクト設定」>「その他」のタブにある「接続パラメーターのオーバーライド」パネルおよび「グローバル変数のオーバーライド」パネルを使用して行います。セキュリティー・パネルでのオーバーライドを許可していない場合は、ポートレット・クラスを拡張するかポートレットの「編集」モードを使用して設定したすべてのオーバーライドが、暗黙的に無視されます。
標準ポートレットでの統合オブジェクトの実行には、processRequest() メソッドを使用します。また、統合オブジェクトのチェーニングに関しては特別な考慮事項があります。
統合オブジェクトのチェーニング (統合オブジェクトのチェーニングを参照) では、チェーン内のすべての統合オブジェクトで同じ接続を使用する必要があります。 processRequest() メソッドを使用して統合オブジェクトを実行する際、統合オブジェクト・チェーンの接続を表すキーは、チェーン内の最初の統合オブジェクトから取り出して、チェーン内の後続の統合オブジェクトに設定しなければなりません。この接続は、getHPubLinkKey() メソッドによって最初の統合オブジェクトから取り出し、setHPubLinkKey() メソッドによって後続の IO に設定することができます。
接続を表すキーは、以下のように FORM に非表示の入力フィールドを追加することによって、HttpServletRequest オブジェクトのパラメーターとして JSP を介して受け渡されます。
<INPUT TYPE="HIDDEN" NAME="<%CommonConstants.HPUB_LINK_KEY%>"VALUE="<%=FirstInChainIO.getHPubLinkKey()%>"/>
その後、次の JSP が getParameter() メソッドを使用してこのキーを取得し、次の統合オブジェクトにこれを設定します。
<% MiddleInChainIO.setHPubLinkKey((String)request.getParameter(CommonConstants.HPUB_LINK_KEY)); %>
HATS ポートレットが使用している接続を、「URL に転送」アクションを使用して統合オブジェクトに受け渡す場合、その接続を表すキーは、PortletRequest オブジェクトの CommonConstants.HPUB_LINK_KEY 属性に保存されます。
この場合、ユーザーは、「URL に転送」アクションを使用して制御を取得する JSP を以下のように編集して、この JSP が、PortletRequest オブジェクトからキーを取得し、setHpubLinkKey() メソッドを呼び出す最初の統合オブジェクトにそのキーを設定するようにしなければなりません。
<% ExampleIO.setHPubLinkKey((String)request.getAttribute(CommonConstants.HPUB_LINK_KEY)); %>
「URL に転送」アクションから制御を取得する JSP には、以下のステートメントも追加する必要があります。このとき、その JSP が、統合オブジェクトに必要なデータを収集する入力ページであるか、統合オブジェクトの実行結果を表示する出力ページであるかは関係ありません。
<%@ taglib uri="http://java.sun.com/portlet" prefix="portletAPI" %> <portletAPI:defineObjects/>
「URL に転送」アクションから制御を取得する JSP が入力ページである場合、アプリケーション開発者は、要求オブジェクトおよび応答オブジェクトを使用している箇所を、ポートレットの renderRequest オブジェクトおよび renderResponse オブジェクトに置き換えることによって、FORM ステートメントを変更する必要もあります。
<FORM NAME="iojsp_ExampleIOOutput" METHOD="POST" ACTION='<%= renderResponse.encodeURL(renderRequest.getContextPath() + "/iojsp/ExampleIOOutput.jsp")%>'>
以下は、IBM ポートレットと標準ポートレットの両方に共通の内容です。
.jsp ファイルを非ポートレット・プロジェクトから HATS ポートレット・プロジェクトにコピーする場合は、ファイルを変換する必要があるため、ファイル名を右マウス・ボタンでクリックして、「ポータルの JSP の変換」を選択してください。ツリー表示内で複数の .jsp ファイルを選択すれば、それらを一度に変換できます。このメニュー項目は、Portal Toolkit がインストール済みで、.jsp が HATS ポートレット・プロジェクト内にあり、まだ変換されていない場合にのみ使用できます。複数の .jsp ファイルを選択し、そのうちの 1 つ以上のファイルがすでに変換済みの場合、これらのファイルはスキップされます。