Jetspeedによるポータルサイトの構築

5. ポートレットの作成
本節では，ポートレットのプログラム構造の概略を説明し，実際にポートレットを作成します．Jetspeed では，多くのポートレットがVelocityテンプレートを用いて作成されていますが，ここでは広く普及しているJSPをテンプレートとして使用するポートレットを作成します．Velocityは，決して難易度の高い技術ではありませんので，Velocityでのポートレットの作成にも，チャレンジしてみてください．

5.1 ポートレットのプログラム構造
ポートレットアプリケーションの振る舞いの決定に大きな役割を果たすのが，次の3つのプログラムです．

ポートレットクラス

アクションクラス

テンプレート

MVCモデルでは，ポートレットクラス・アクションクラスがControllerに相当し，テンプレートがView に相当します．なお，アクションクラスやテンプレートは必ず必要というわけではなく，ポートレットクラスのみからポートレットを作成することも可能ですが，一般的にはJetspeed上のポートレットアプリケーションはこのような構造になっています．

5.2 ポートレットの作成方法
新たにポートレットを作成するには，主に次の方法があります．

a) 標準ポートレットクラスを使用し，表示テンプレートを新規に作成する
b) 標準ポートレットクラスを使用し，Actionクラス，表示テンプレートを新規作成する
c) 新規にポートレットクラス，Actionクラス，表示テンプレートを作成する

上記項目は，上のものほど作成するプログラム量が少なく，下のものほどプログラムの自由度が増します．本稿では，b の方法を用いて，Actionクラスおよび，JSP による表示テンプレートを作成することにします． JSPでポートレットを作成する場合、多くの場合新規にポートレットを作成する必要はありません。標準ポートレットとして用意されている JspPortletを使用し、Actionクラスにロジックを実装するようにします。
Jetspeedで提供されている主なポートレットクラスとアクションクラスの関係を図10に示します．

図10-1

図10-2

サンプルポートレットは，次の手順で作成していきます．

5.3 サンプルポートレットの説明
サンプルで作成するポートレットは，メモを表示するポートレットです．メモ情報は，サブジェクトと本文からなるものとします（図11）．

図11

単純にテキスト情報を表示するだけならHTMLポートレットでも可能ですが，ポートレットのタイトルバー上にあるカスタマイズボタン（図4参照）をクリックすると表示されるカスタマイズモードでメモ内容を編集できるようにし（図12），さらにポートレットの最大化表示（ポートレットのタイトルバー上の最大化ボタンをクリック）にも対応するようにします．通常表示モードでは，メモの内容は20文字程度しか表示しませんが，最大表示モードではメモの全テキストを表示するようにします（図13）．

図12

図13

リスト2 CustomeJspPortletクラス

 1 package sample;
 2 
 3 import org.apache.turbine.util.RunData;
 4 import org.apache.ecs.ConcreteElement;
 5 import org.apache.jetspeed.portal.portlets.JspPortlet;
 6 
 7 import org.apache.turbine.services.jsp.JspService;
 8 import org.apache.turbine.util.Log;
 9 import org.apache.turbine.modules.ActionLoader;
10 import org.apache.jetspeed.services.template.TemplateLocatorService;
11 import org.apache.ecs.StringElement;
12 import org.apache.turbine.services.TurbineServices;
13 import org.apache.ecs.ElementContainer;
14 
15 // カスタマイズ可能なJspPortlet
16 public class CustomizeJspPortlet extends JspPortlet {
17 
18     // ポートレットのコンテンツを生成
19     public ConcreteElement getContent(RunData rundata) {
20 
21         String template = "";
22         try {
23 
24             JspService service = (JspService)TurbineServices.getInstance().
25                 getService(JspService.SERVICE_NAME);
26 
27             service.addDefaultObjects(rundata);
28 
29             // JSPテンプレートから参照できるように設定
30             rundata.getRequest().setAttribute("portlet", this);
31             rundata.getRequest().setAttribute("js_peid", this.getID());
32 
33             String actionName = getPortletConfig().getInitParameter("action");
34 
35             rundata.getRequest().setAttribute("template",
36                 getPortletConfig().getInitParameter("template"));
37 
38             if (actionName != null) {
39                 try {
40                     // actionクラスの実行
41                     ActionLoader.getInstance().exec(rundata, actionName);
42                 } catch(Exception e) {
43                     Log.error(e);
44                 }
45             }
46 
47             // actionクラスで設定されたテンプレートの取得
48             template = (String)rundata.getRequest().getAttribute("template");
49 
50             TemplateLocatorService lserv =
51                 (TemplateLocatorService)TurbineServices.getInstance()
52                 .getService(TemplateLocatorService.SERVICE_NAME);
53             String locatedTemplate = lserv.locatePortletTemplate( rundata,
54                 template );
55 
56             // 出力
57             service.handleRequest(rundata, locatedTemplate);
58         } catch (Exception e) {
59             String message = "CustomizeJspPortlet: error : " + e.getMessage();
60             Log.error(message, e);
61             // エラー出力
62             return new StringElement( message );
63         }
64         return new ElementContainer();
65 
66     }
67 
68     // カスタマイズモードを有効にする
69     public boolean providesCustomization() {
70         return( true );
71     }
72 
73 }

5.3.1 ポートレットクラスについて
Jetspeed 1.4b3版までのJetspeedで提供されていたJSPポートレットでは、ポートレットのカスタマイズモードはサポートしていませんでした。つまり、カスタマイズボタンをクリックしても、メモ内容を変更するといったカスタマイズモードに移行する事ができませんでした。Jetspeed 1.4b4からは、JSPポートレットはカスタマイズモードをサポートしているので、カスタマイズモードを使用するポートレットでも、標準のJSPポートレットが使用でき、新規にポートレットを作成する必要はなくなりました。
5.3.2 Action クラスの作成
アクションクラスは，表示・最大化・カスタマイズなどのイベントを処理し，ポートレットの表示に使用するテンプレートを選択する，MVCモデルでのControllerに相当する処理を担当するクラスです．このメカニズムは， Turbineが提供している機能を使用するもので，Action クラスの実装は， Turbineが定義している抽象クラスであるActionクラスを実装する必要があります（図10参照）．
Jetspeedでは，標準で多くのActionクラスの実装も提供していますので， Actionクラスを直接継承して実装することはあまりありません．今回作成するSampleJspActionクラス（リスト3）のように，テンプレートとしてJSPを使用する場合には，JspPortletActionクラスを継承してアクションクラスを実装します．JspPortletActionクラスは，表示モードやイベントごとに異なるメソッドが呼び出されるように実装されています．表2 に，JspPortlet Actionクラスがイベント処理時に呼び出す主なメソッドを記述します．

表2 JspPortletAction クラスのイベント処理メソッド

メソッド	概要
buildNormalContext()	通常表示モードでポートレットを表示するときに呼び出されます
buildMaximizedContext()	最大表示モードでポートレットを表示するときに呼び出されます
buildConfigureContext()	カスタマイズモードを表示するときに呼び出されます

サンプルプログラムのActionクラス（リスト3）では，表2 の3 つのメソッドと，カスタマイズモードでユーザがフォームに入力した値を受け取り処理するためのメソッドとして，doUpdate( )メソッドを実装します．本来，Actionクラスの役割は Controllerですので，ビジネスロジックに相当する処理はこのクラスと分離して実装すべきですが，今回は簡単なサンプルプログラムですので，Actionクラス内でメモに関する処理も実装しています．

リスト2 SampleJspActionクラス

 1 package sample.actions;
 2 
 3 import org.apache.jetspeed.modules.actions.portlets.JspPortletAction;
 4 import org.apache.jetspeed.portal.Portlet;
 5 import org.apache.jetspeed.util.PortletSessionState;
 6 import org.apache.turbine.util.RunData;
 7 import javax.servlet.http.HttpServletRequest;
 8 
 9 
10 public class SampleJspAction extends JspPortletAction {
11 
12     // 通常表示
13     protected void  buildNormalContext(Portlet portlet, RunData rundata)
14         throws Exception {
15 
16         // 設定されているサブジェクト、本文の取得
17         String subject = (String)PortletSessionState.getAttributeWithFallback(
18             portlet, rundata, "subject");
19         String body = (String)PortletSessionState.getAttributeWithFallback(
20             portlet, rundata, "body");
21 
22         // サブジェクト、本文を JSP で使用できるように設定
23         HttpServletRequest request = rundata.getRequest();
24         request.setAttribute("subject", subject);
25         request.setAttribute("body", body);
26 
27         // テンプレート設定
28         setTemplate(rundata, 
29             portlet.getPortletConfig().getInitParameter("template"));
30     }
31 
32     // 最大表示
33     protected void buildMaximizedContext(Portlet portlet, RunData rundata)
34         throws Exception {
35 
36         buildNormalContext(portlet, rundata);
37 
38         setTemplate(rundata,
39             portlet.getPortletConfig().getInitParameter("maximizeTemplate"));
40     }
41 
42     // 編集モード表示
43     protected void buildConfigureContext(Portlet portlet, RunData rundata)
44         throws Exception {
45 
46         buildNormalContext(portlet, rundata);
47 
48         setTemplate(rundata, 
49             portlet.getPortletConfig().getInitParameter("customizeTemplate"));
50     }
51 
52     // データ更新
53     public void doUpdate(RunData rundata, Portlet portlet) {
54 
55         HttpServletRequest request = rundata.getRequest();
56 
57         String subject = getParameter(rundata, "subject");
58         String body    = getParameter(rundata, "body");
59         portlet.setAttribute("subject", subject, rundata);
60         portlet.setAttribute("body", body, rundata);
61 
62         request.setAttribute("subject", subject);
63         request.setAttribute("body", body);
64     }
65 
66     // リクエストパラメータの取得
67     private String getParameter(RunData rundata, String parameter) {
68         String value = rundata.getParameters().getString(parameter);
69         try {
70             value = new String (value.getBytes("8859_1"), "EUC-JP");
71         } catch(Exception e) {}
72         return( value );
73     }
74 
75 }

・buildNormalContext()の実装

・buildMaximizedContext( )の実装

・buildConfigureContext( )の実装

・doUpdate( )メソッドの実装

5.3.3 テンプレートの作成
テンプレートの役割は，MVCモデルにおけるViewの処理です．
テンプレートでは，Actionメソッドで設定されたリクエスト属性を取得し，HTMLを出力します．Actionメソッドでポートレットの表示モードごとに呼び出すテンプレートを設定していますので，それに合わせて通常のポートレット表示用のテンプレートとして sample.jsp（リスト5），最大化ポートレット表示用のテンプレートとしてs a m p l e - maximize.jsp（リスト6），カスタマイズページ表示用テンプレートとしてsample-customize.jsp（リスト4）を作成します．

リスト4

<%@ page language="java" session="false" %>
<%@ page contentType = "text/html;charset=EUC-JP" %>
<%@ taglib uri='/WEB-INF/templates/jsp/tld/template.tld' prefix='jetspeed' %>
<%
	String subject = (String)request.getAttribute("subject");
	String body = (String)request.getAttribute("body");
	// Escape characters for the subject and body are omitted.
%>
<form action="<jetspeed:dynamicUri />" method="post">

<table>
    <tr>
    <td>タイトル</td>
    <td><input type="text" name="subject" value="<%= subject %>"></td>
    </tr>

    <tr>
    <td>本文</td>
    <td><textarea name="body" rows="3" cols="30"><%= body %></textarea></td>
    </tr>
</table>

<input type="submit" name="eventSubmit_doUpdate">
</form>

リスト5

<%@ page contentType = "text/html;charset=EUC-JP" %>
<%
	String subject = (String)request.getAttribute("subject");
	String body = (String)request.getAttribute("body");
	if (body.length() > 23) {
		body = body.substring(0,20) + "...";
	}
	// Escape characters for the subject and body are omitted.
%>
<b><%= subject %></b><br/>
<br/>
<%= body %>

リスト5

<%@ page language="java" session="false" %>
<%@ page contentType = "text/html;charset=EUC-JP" %>
<%
	String subject = (String)request.getAttribute("subject");
	String body = (String)request.getAttribute("body");
	// Escape characters for the subject and body are omitted.
%>
<font size="+1">最大表示</font><br>
<b><%= subject %></b><br/>
<br/>
<%= body %>

ごく簡単なJSPファイルですので，見ていただければどのような処理をしているかすぐわかると思います．どのJSPファイルでも，SampleJspActionクラスでリクエストの属性として設定した情報を取得し，それを画面上に表示する処理を行っています．sample.jspでは，本文テキストは，20文字程度しか表示しないように処理していますが，最大化表示するsamplemaximize. jspでは，本文テキストをすべて表示するようになっています．また，sample-customize.jspの submit のname パラメータで，Action クラスの doUpdateメソッドが呼び出されるように設定しています．

5.3.4 コンパイル
作成したリスト2をコンパイルします．コンパイルには，サーブレットのクラスライブラリのほかに， ECS とTurbine のクラスライブラリが必要です． $JETSPEED/WEB-INF/lib/の下にあるecs-1.4.1.jar とturbine-2.2.jarをクラスパスに追加し，コンパイルを実行してください．

5.3.5 設定
1) クラスファイルの配置
コンパイルしたクラスファイルは，Jetspeedが読み込めるように，$JETSPEED/WEB-INF/classes/の下に置いてください．これに併せて，アクションモジュールのパッケージをTurbineの設定ファイルに記述します．今回，アクションモジュールはsample.action パッケージとして作成しました．Turbineがこのアクションモジュールを検索できるように，設定ファイルを修正します．$JETSPEED/WEB-INF/conf/ TurbineResources.properties の170 行目付近に， module.packagesを設定している部分がありますので，そこに以下の記述を追加してください．

module.packages=sample

また，作成したJSP テンプレートファイルは， $JETSPEED/WEB-INF/templates/jsp/portlets/html/ に置いてください．

2) レジストリマークアップの設定
レジストリは，XMLで記述します．ここで登録するレジストリファイルがリスト1です．ポートレットのタイトルや説明文などのほかに，このポートレットのクラス名，使用するテンプレートファイル，アクションクラスをここで記述します．サンプルポートレットでは，通常表示，最大表示，カスタマイズページでそれぞれ異なるテンプレートファイルを使用しますので，それぞれのテンプレートを設定しています．このファイルはsample.xregとして，$JETSPEED/WEB-INF/conf/ の下に置いてください．なお， Jetspeedはレジストリマークアップのデータをキャッシュしますので，この設定はTomcatのプロセスを停止させてから行うようにしてください．

5.3.6 実行
以上で設定終了です．Jetspeedを起動し，ログインしたら，画面上部にある“カスタマイズ: HTML” のリンクをクリックし，カスタマイズ画面に進みます．そこで“ポートレットの追加”ボタンをクリックし，表示される画面で，SampleJSPポートレットを追加してください（図14）．

図14 ポートレットのカスタマイズ画面

画面上で，図11のようなポートレットが表示されます．標準表示では，テキストが一部しか表示されませんが，最大化するとテキストがすべて表示されます．また，カスタマイズボタンから，サブジェクトや本文を変更することもできます．

　<< prev　　↑index　　next >>

このドキュメントに関するご意見、ご要望などはまで。