WebOTX Manual V10.4 (第4版) 目次を表示

---

3. プログラミング・開発ガイド

3.1. ポートレットとは

3.2. ポートレット開発の概要

3.2.1. ポートレット開発の流れ

1. ポートレットプロジェクトウィザードもしくは動的Webプロジェクトから変換することでポートレットプロジェクトを作成します。
2. ポートレットウィザードで各ポートレットテンプレートを生成します。
3. 生成された雛形をベースに各機能を実装します。
4. 作成したポートレットアプリケーションをWARファイルにアーカイブします。
5. WARファイルをポータルサーバへ配備します。
6. 配備したポートレットをポータルページへ追加して実行します。

3.3. ポートレットプロジェクト

3.3.1. ポートレットプロジェクトの作成

3.3.1.1. ウィザードの起動

3.3.1.2. ポートレットプロジェクトの基本情報設定

Memo
XMLファイル、JSPファイルの作成時のエンコードの設定方法については、環境設定のエンコード設定 を参照してください。

3.3.2. ポートレットプロジェクトの構成

3.3.2.1. フォルダ/ファイル構成

3.3.2.2. プロジェクト・エクスプローラ・ビューの説明

プロジェクト・エクスプローラ・ビューの構成

• ポートレットデプロイメント記述子
• ポートレット参照

ポートレットデプロイメント記述子ノード

<?xml version="1.0" encoding="UTF-8"?>
<portlet-app version="x.x" …>
        …
</portlet-app>

• version="1.0"である場合、記述子バージョンは1.0です。
• version="2.0"である場合、記述子バージョンは2.0です。

<event-definition xmlns:接頭辞="名前空間">
  <qname>接頭辞:イベント名</qname>
  <value-type>イベントペイロードの型</value-type>
</event-definition>

<event-definition>
  <name>イベント名</name>
  <value-type>イベントペイロードの型</value-type>
</event-definition>

<supported-publishing-event xmlns:接頭辞="名前空間">
    <qname>接頭辞:イベント名</qname>
</supported-publishing-event>

<supported-publishing-event>
    <name>イベント名</name>
</supported-publishing-event>

<supported-processing-event xmlns:接頭辞="名前空間">
    <qname>接頭辞:イベント名</qname>
</supported-processing-event>

<supported-processing-event>
    <name>イベント名</name>
</supported-processing-event>

プロジェクト・エクスプローラ・ビューの操作

Memo
ポートレットプロジェクトの右クリックメニューから ポータル > ポートレット参照 を選択した場合と同じ挙動をします。「ポートレット参照の利用」を参照してください。

3.4. ポートレットウィザードの利用

3.4.1. ポートレットウィザードの起動

3.4.2. ポートレットの作成ページ

Caution
ポートレット名に下記の文字は使えません。
• 空白
• 特殊文字（` ~ ! @ # % ^ & * ( ) - + = { [ } ] | \ : ; " ' < , > . ? /等）
• Latin-1 (ISO 8859-1)以外の文字(日本語等)
• 1文字目が数字

• シンプルポートレット
• JSP/HTMLポートレット
• コンテンツ表示ポートレット

Memo
スーパークラスは javax.portlet.GenericPortlet を継承したクラスを指定してください。

3.4.3. ポートレットの基本情報設定ページ

Memo
追加されたロケールはロケール設定情報テーブルで表示され、有効になります。また、タイトル、ショートタイトル、キーワードは設定しても、WebOTX Portal V9では表示されません。

3.4.4. オプションページ

Memo
ポートレット型 でシンプルポートレットを指定した場合、オプションページへ遷移すること ができません。
JSP/HTMLポートレットとコンテンツ表示ポートレットを指定した場合、 オプションページへ遷移することができます。

3.4.5. コンテンツ表示ポートレットの基本情報設定ページ

Memo
ポートレット型 でコンテンツ表示ポートレットを指定した場合に遷移することができます。

Caution
ポートレット型 でコンテンツ表示ポートレットを指定した場合、 ポートレットウィザード生成後に実行環境からJARファイルをプロジェクトにコピーする必要があります。
詳細は 他システム連携ポートレットの作成 を参照して下さい。

3.5. 基本的なポートレットの実装

3.5.1. JSR 168 と JSR 286

3.5.2. ポートレットデプロイメント記述子

<portlet-app>
  <portlet>
    <portlet-name>TestPortlet</portlet-name>
    <portlet-class>com.nec.webotx.TestPortlet</portlet-class>
    <init-param>
      <name>TestName</name>
      <value>TestValue</value>
    </init-param>
    <supports>
      <mime-type>text/html</mime-type>
      <portlet-mode>view</portlet-mode>
      <portlet-mode>help</portlet-mode>
    </supports>
    <portlet-info>
      <title>TestPortlet</title>
    </portlet-info>
  </portlet>
</portlet-app>

3.5.3. ポートレット インタフェース

• init(PortletConfig config)
  ポートレットがサービス開始される際にポートレットコンテナによって1度だけ呼び出されるメソッドです。
• processAction(ActionRequest request,ActionResponse response)
  クライアントのリクエストに対し、1 つだけアクションをとれます。
  リダイレクト、モードやウィンドウの状態の変更、持続するステートの更新などを行います。
• render(RenderRequest request, RenderResponseresponse)
  現在のページの各ポートレットに対し render メソッドが呼ばれ、ポートレットモードやウィンドウの状態に応じて、マークアップを生成します。
• destroy()
  ポートレットがサービス終了される際にポートレットコンテナによって呼び出されるメソッドです。
• processEvent()
  ポートレットに配信されたイベントを受信するために呼び出されるメソッドです。
• serveRersource()
  ポートレットが直接リソース・サービングの要求を受け取るメソッドです。

3.5.4. ポートレットモード

public class HelloPortlet extends javax.portlet.GenericPortlet {
    public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        //表示モードを実装する
    }
    public void doEdit(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        //個人設定モードを実装する
    }
    public void doHelp(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        //ヘルプモードを実装する
    }
    @RenderMode(name = "about")
    public void doAbout(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        //説明モードを実装する
    }
    @RenderMode(name = "edit_defaults")
    public void doEditDefaults(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        //共用設定モードを実装する
    }
}

3.5.5. ポートレットプリファレンス

Caution
ポートレットプリファレンスではトランザクション機能等は備えていないため機密性や信頼性の高い情報の保存には適していませんので、 それらのデータの保存には利用することは避けて下さい。

3.5.5.1. ポートレットプリファレンスの取得と設定

public void processAction(ActionRequest request, ActionResponse response) throws IOException {
   // プリファレンスオブジェクトの取得
   PortletPreferences prefs = request.getPreferences();

   //プリファレンスの取得
   String data = prefs.getValue("KEYNAME", "");
   
   // プリファレンスの設定
   prefs.setValue("PEF_KEY", "value");
   
   // プリファレンスの永続化
   prefs.store();
}

3.5.5.2. ポートレットプリファレンスの初期設定

<portlet>
    <portlet-name>RefreshPortlet</portlet-name>
    <portlet-class>com.nec.portlet.RefreshPortlet</portlet-class>
    <portlet-preferences>
        <preference>
            <name>KEYNAME</name>
            <value>value</value>
            <read-only>false</read-only>
        </preference>
    </portlet-preferences>
</portlet>

3.5.5.3. ポートレットプリファレンス API

3.5.6. ポートレットタグライブラリ

<portlet:actionURL windowState="maximized" portletMode="edit" name="action1">
    <portlet:param name="action" value=2editStocks"/>
</portlet:actionURL>

<form action="<portlet:renderURL portletMode="view"/>" method="POST">
<input name="view" type="submit" value="back to view mode"></form>

<form action="<portlet:resourceURL id="res1"/>" method="POST">

<A HREF="javascript:<portlet:namespace/>doFoo()" >Foo</A>

<portlet:param name="myParam" value="someValue"/>

Memo
<portlet:namespace/> タグを利用してHTML上の要素を一意に特定する場合は、ウィンドウ状態を識別する識別子と組み合わせて使用してください。詳細については、プログラミング上の注意事項を参照してください。

3.5.7. ポートレットアノテーション

3.5.8. ポートレットイベント

3.5.9. パブリックレンダーパラメータ

3.5.10. ポートレットフィルター

3.5.11. ポートレットウィンドウ状態

3.5.12. ポートレットでのクライアント側とサーバ側の基本的な実装

• Form タグの action 属性に <portlet:actionURL>を指定する
  
  JSPでFormのactionに<portlet:actionURL>を使用することができます。<portlet:actionURL>にはWindow StateやPortlet Modeを指定することができます。
  
  カレントモードから表示モードへ遷移したい場合、portletModeをviewに指定します。
  

  <form action="<portlet:actionURL portletMode="view" />" method="post">...</form>
  

  カレントウィンドウ状態から標準ウィンドウ状態へ遷移したい場合、windowStateをnormalに指定します。
  

  <form action="<portlet:actionURL windowState="normal" />" method="post">...</form>
  

• サーバ側でのデータの受け取り方法
  
  Javaで renderRequest などのパラメータを利用することでデータの受け取ることができます。
  サーバ側でパラメータの取得：

  String yourName = request.getParameter("key");
  

  サーバ側でJSPへ渡す：

  response.setRenderParameter("key", value);
  

• クライアント側でのデータの受け取り方法
  
  JSPで renderRequest などのパラメータを利用することでデータの受け取ることができます。
  クライアント側でパラメータの取得：

  <%=renderRequest.getParameter("key")%>
  

• ポートレットのコンテキストパスの取得
  ポートレット中でポートレットのコンテキストパスを取得したい場合は、以下のようにして取得が可能です。

  <%=renderRequest.getContextPath()%>
  

3.6. 作成ポートレットに関する実装

3.6.1. 作成ポートレットイベント

com.nec.webotx.portal.container.portlet.PortletListener

Memo
PortletListenerを実装するクラスは、portlet.xml の portlet-class要素 で定義されるクラスである必要があります。 また、portlet.xml の listener 要素に設定する必要はありません。

import java.io.IOException;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Locale;

import javax.portlet.PortletException;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import com.nec.webotx.portal.container.portlet.PortletListenerException;

public class PortletListener extends GenericPortlet implements com.nec.webotx.portal.container.portlet.PortletListener {

    /**
     * 以下のテーブルのレコードをコピーする。
     * idには作成ポートレットIDが入る。
     * 
     * テーブル名 : data
     *   id (bigint, NULL以外)
     *   data (nvarchar(255), NULL)
     */
    public void copyPortlet(long arg0, long arg1) throws PortletListenerException {
        Connection con = null;
        PreparedStatement pstmt = null;
        PreparedStatement copypstmt = null;
        
        try 
        {
            Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
            con = DriverManager.getConnection("jdbc:sqlserver://localhost:1433;database=portlet", "user", "password");
            String sql = "select * from data where id = ?";
            pstmt = con.prepareStatement(sql);
            pstmt.setLong(1, srcPortletId);
            ResultSet rset = pstmt.executeQuery();
            
            String data = null;
            while (rset.next())
            {
                data = rset.getString(2);
            }
            
            // コピー処理
            String copySql = "insert into data values(?,?)";
            copypstmt = con.prepareStatement(copySql);
            copypstmt.setLong(1, destPortletId);
            copypstmt.setString(2, data);
            copypstmt.execute();
            
        }
        catch (ClassNotFoundException e)
        {
            e.printStackTrace();
        }
        catch (SQLException e)
        {
            e.printStackTrace();
        }
        finally
        {
            try 
            {
                if (copypstmt != null)
                {
                    copypstmt.close();
                }
                if (pstmt != null)
                {
                    pstmt.close();
                }
                if (con != null)
                {
                    con.close();
                }
            }
            catch (SQLException e)
            {
                e.printStackTrace();
            }
        }
    }

    /**
     * 以下のテーブルのレコードを削除する。
     * idには作成ポートレットIDが入る。
     * 
     * テーブル名 : data
     *   id (bigint, NULL以外)
     *   data (nvarchar(255), NULL)
     */
    public void removePortlet(long arg0) {
	    Connection con = null;
	    PreparedStatement pstmt = null;
	    
        try
        {
            Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
            con = DriverManager.getConnection("jdbc:sqlserver://localhost:1433;database=portlet", "user", "password");
            String sql = "delete from data where id = ?";
            pstmt = con.prepareStatement(sql);
            pstmt.setLong(1, portletId);

            // 削除処理
            pstmt.executeUpdate();
        }
        catch (ClassNotFoundException e)
        {
            e.printStackTrace();
        }
        catch (SQLException e)
        {
            e.printStackTrace();
        }
        finally
        {
            try 
            {
                if (pstmt != null)
                {
                    pstmt.close();
                }
                if (con != null)
                {
                    con.close();
                }
            }
            catch (SQLException e)
            {
                e.printStackTrace();
            }
        }
    }
}

3.6.2. 作成ポートレット情報

• renderメソッド
• processActionメソッド
• processEventメソッド
• serveResourceメソッド

public void doView(RenderRequest request, RenderResponse response) {

   // リクエストから AboutProperty オブジェクト取得
   AboutProperty aboutProperty = (AboutProperty) request.getAttribute(PortletRequestAttributesConsts.ABOUT);
   
   // リクエストから 基本ポートレットIDを取得
   long id = (long) request.getAttribute(PortletRequestAttributesConsts.PORTLET_DEFINITION_ID);

3.7. セッションを利用したポートレット間連携の作成

PortletSession session = request.getSession(true);
URL url = new URL("http://www.nec.com");
session.setAttribute("home.url", url, PortletSession.APPLICATION_SCOPE);
session.setAttribute("bkg.color", "RED", PortletSession.PORTLET_SCOPE); 

3.8. イベント/パブリックレンダーパラメータを利用したポートレット間連携の作成

3.8.1. ポートレット間連携定義エディタについて

3.8.2. ポートレット間連携定義エディタの画面構成

3.8.2.1. ポートレット開発専用ツール・バーの説明

図2.8.2.1-1

Memo
ポートレット間連携定義エディタで、 元に戻す と やり直し との機能は提供しません。

3.8.2.2. ポートレット間連携定義エディタの本体の説明

3.8.2.3. プロパティー・ビューの説明

3.8.2.4. ステータス・バーの説明

3.8.3. ポートレット間連携定義エディタの起動

Memo
WebOTX開発環境で、ポートレット間連携定義エディタは同時に一つのみ開くことができます。

3.8.3.1. 起動パターンの設定

3.8.4. ポートレット間連携定義エディタでポートレットの追加

3.8.4.1. ポートレットの表示/非表示

ポートレットデプロイメント記述子ノードの表示方法

ポートレット参照ノードの表示方法

ポートレットの表示ルール

ポートレットの構成

ポートレットの非表示

図2.8.4.1-6

ポートレットの非表示のルール

「portlet.xml」ファイルの更新

プロジェクト・エクスプローラ・ビューの更新

3.8.4.2. ポートレットの選択/移動

Memo
ポートレットの関連情報は編集できません。

Memo
ポートレットを移動した場合、ポートレットに所属するイベント／パブリックレンダーパラメータも一緒に移動します。

Memo
「portlet.xml」ファイルの更新
D&Dでポートレットをポートレット間連携定義エディタへ追加する時に「portlet.xml」ファイルは更新されません。

Memo
プロジェクト・エクスプローラ・ビューの更新
D&Dでポートレットをポートレット間連携定義エディタへ追加する時にプロジェクト・エクスプローラ・ビューも更新されません。

3.8.5. イベントを利用する場合

3.8.5.1. ポートレット間連携定義エディタでイベントの新規作成

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event xmlns:接頭辞='名前空間'>
     <qname>接頭辞:イベント名</qname>
    </supported-publishing-event>
  </portlet>
……
  <event-definition xmlns:接頭辞='名前空間'>
    <qname>接頭辞:イベント名</qname>
    <value-type>イベントペイロードの型</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event>
      <name>イベント名</name>
    </supported-publishing-event>
  </portlet>
……
  <event-definition>
    <name>イベント名</name>
    <value-type>イベントペイロードの型</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event xmlns:prefix='http://com.nec.webotx'>
      <qname>prefix:eventName</qname>
    </supported-publishing-event>
  </portlet>
……
  <event-definition xmlns:prefix='http://com.nec.webotx'>
    <qname>prefix:eventName</qname>
    <value-type>java.lang.String</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event>
      <name>eventName</name>
    </supported-publishing-event>
  </portlet>
……
  <event-definition>
    <name>eventName</name>
    <value-type>java.lang.String</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-processing-event xmlns:接頭辞='名前空間'>
      <qname>接頭辞:イベント名</qname>
    </supported-processing-event>
  </portlet>
……
  <event-definition xmlns:接頭辞='名前空間'>
    <qname>接頭辞:イベント名</qname>
    <value-type>イベントペイロードの型</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-processing-event>
      <name>イベント名</name>
    </supported-processing-event>
  </portlet>
……
  <event-definition>
    <name>イベント名</name>
    <value-type>イベントペイロードの型</value-type>
  </event-definition>
……
</portlet-app>

3.8.5.2. ポートレット間連携定義エディタでイベントの編集

Memo
Javaの命名ルール：
   1.  大文字と小文字を区別します。
   2. １文字目は英字、$, _ の何れかとします。
   3. キーワードと重複しないようにします。
   4. false, true (boolean literal) は不可です。
   5. null (null literal) は不可です。
   6. 記号は、演算子／特殊文字は不可です。
   7. 文字数は任意です。
   8. 言語は任意です。
キーワードには次の 49 個が定義されています。

……
  public void メソッド名(ActionRequest request, ActionResponse response) {
    try {
      javax.xml.namespace.QName qName = new javax.xml.namespace.QName ("名前空間", "イベント名", "接頭辞");
      イベントペイロードの型data = null;
      response.setEvent(qName, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void メソッド名(ActionRequest request, ActionResponse response) {
    try {
      String event = "イベント名";
      イベントペイロードの型data = null;
      response.setEvent(event, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void testEvent (ActionRequest request, ActionResponse response) {
    try {
      javax.xml.namespace.QName qName = new javax.xml.namespace.QName ("http://com.nec.webotx ", "eventName", "prefix");
      java.lang.String data = null;
      response.setEvent(qName, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

……
  public void testEvent (ActionRequest request, ActionResponse response) {
    try {
      String event = "eventName";
      java.lang.String data = null;
      response.setEvent(event, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void メソッド名 {
……
    try {
      javax.xml.namespace.QName qName = new javax.xml.namespace.QName("名前空間", "イベント名", "接頭辞");
      イベントペイロードの型data = null;
      response.setEvent(qName, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void メソッド名 {
……
    try {
      String event = "イベント名";
      イベントペイロードの型data = null;
      response.setEvent(event, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
    try {
      javax.xml.namespace.QName qName = new QName("http://com.nec.webotx ", "eventName", "prefix");
      java.lang.String data = null;
      response.setEvent(qName, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
    try {
      String event = "eventName";
      java.lang.String data = null;
      response.setEvent(event, data);
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
……

……
@ProcessEvent(qname = "{名前空間}イベント名")
 public void メソッド名(EventRequest request,  EventResponse response)   throws PortletException, IOException {
  Event event = request.getEvent();
  response.setRenderParameter(event.getName(), (イベントペイロードの型) event.getValue());
 }
……

……
@ProcessEvent(name = "イベント名")
 public void メソッド名(EventRequest request,  EventResponse response)   throws PortletException, IOException {
  Event event = request.getEvent();
  response.setRenderParameter(event.getName(), (イベントペイロードの型) event.getValue());
 }
……

……
@ProcessEvent(qname = "{http://com.nec.webotx}eventName ")
 public void handleProcessEvent(EventRequest request,  EventResponse response)
   throws PortletException, IOException {
  Event event = request.getEvent();
  response.setRenderParameter(event.getName(), (java.lang.String) event.getValue());
 }
……

……
@ProcessEvent(name = "eventName")
 public void handleProcessEvent(EventRequest request,  EventResponse response)
   throws PortletException, IOException {
  Event event = request.getEvent();
  response.setRenderParameter(event.getName(), (java.lang.String) event.getValue());
 }
……

3.8.5.3. ポートレット間連携定義エディタでイベントの削除

イベントの削除の方法

イベントの削除のルール

「portlet.xml」ファイルの更新

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event xmlns:
		接頭辞
		='
		名前空間
		'>
      <qname>
		接頭辞
		:
		イベント名
		</qname>
    </supported-publishing-event>
		
  </portlet>
……
  <event-definition xmlns:
		接頭辞
		='
		名前空間
		'>
    <qname>
		接頭辞
		:
		イベント名
		</qname>
    <value-type>
		イベントペイロードの型
		</value-type>
  </event-definition>
		
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event>
      <name>
		イベント名
		</name>
    </supported-publishing-event>
		
  </portlet>
……
  <event-definition>
    <name>
		イベント名
		</name>
    <value-type>
		イベントペイロードの型
		</value-type>
  </event-definition>
		
……
</portlet-app>

Memo
「<event-definition>」要素の定義は他のイベントが利用している場合、「<event-definition>」要素の定義は削除しません。

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event xmlns:prefix='http://com.nec.webotx'>
      <qname>prefix:eventName</qname>
    </supported-publishing-event>
  </portlet>
……
  <event-definition xmlns:prefix='http://com.nec.webotx'>
    <qname>prefix:eventName</qname>
    <value-type>java.lang.String</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-publishing-event>
      <name>eventName</name>
    </supported-publishing-event>
  </portlet>
……
  <event-definition>
    <name>eventName</name>
    <value-type>java.lang.String</value-type>
  </event-definition>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-processing-event xmlns:
		接頭辞
		='
		名前空間
		'>
      <qname>
		接頭辞
		:
		イベント名
		</qname>
    </supported-processing-event>
		
  </portlet>
……
  <event-definition xmlns:
		接頭辞
		='
		名前空間
		'>
    <qname>
		接頭辞
		:
		イベント名
		</qname>
    <value-type>
		イベントペイロードの型
		</value-type>
  </event-definition>
		
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-processing-event>
      <name>
		イベント名
		</name>
    </supported-processing-event>
		
  </portlet>
……
  <event-definition>
    <name>
		イベント名
		</name>
    <value-type>
		イベントペイロードの型
		</value-type>
  </event-definition>
		
……
</portlet-app>

プロジェクト・エクスプローラ・ビューの更新

3.8.6. パブリックレンダーパラメータを利用する場合

3.8.6.1. ポートレット間連携定義エディタでパブリックレンダーパラメータの新規作成

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-public-render-parameter>識別子</supported-public-render-parameter>
  </portlet>
……
  <public-render-parameter xmlns: 接頭辞='名前空間'>
    <identifier>識別子</identifier>
    <qname>接頭辞:パブリックレンダーパラメータ名</qname>
  </public-render-parameter>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-public-render-parameter>識別子</supported-public-render-parameter>
  </portlet>
……
  <public-render-parameter>
    <identifier>識別子</identifier>
    <name>パブリックレンダーパラメータ名</name>
  </public-render-parameter>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
  <supported-public-render-parameter>id</supported-public-render-parameter>
  </portlet>
……
  <public-render-parameter xmlns:prefix='http://com.nec.webotx'>
    <identifier>id</identifier>
    <qname>prefix:paramName</qname>
  </public-render-parameter>
……
</portlet-app>

<?xml version='1.0' encoding='UTF-8' ?>
<portlet-app ……>
……
  <portlet>
……
    <supported-public-render-parameter>id</supported-public-render-parameter>
  </portlet>
……
  <public-render-parameter>
    <identifier>id</identifier>
    <name>paramName</name>
  </public-render-parameter>
……
</portlet-app>

3.8.6.2. ポートレット間連携定義エディタでパブリックレンダーパラメータの編集

……
  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
……
    String publicRenderParamValue = request.getParameter("識別子");
    response.setRenderParameter("識別子", publicRenderParamValue);
  }
……

……
  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
……
    String publicRenderParamValue = request.getParameter("id");
    response.setRenderParameter("id", publicRenderParamValue);
  }
……

  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
    String publicRenderParamValue = request.getParameter("識別子");
    response.setRenderParameter("識別子", publicRenderParamValue);
  }

  public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
    String publicRenderParamValue = request.getParameter("id");
    response.setRenderParameter("id", publicRenderParamValue);
  }

3.8.6.3. ポートレット間連携定義エディタでパブリックレンダーパラメータの削除

3.8.7. ポートレット間連携定義エディタでポートレット間連携の表示

3.8.7.1. ポートレット間連携の表示

3.8.7.2. ポートレット間連携の結線の生成ルール

3.8.7.3. ポートレット間連携の結線の基本操作

3.9. ドラックアンドドロップ(D&D)を利用したポートレット間連携の作成

3.9.1. ドラッグ&ドロップが可能な範囲

1. ある1つのポートレット内の画面
2. 同一ポータルページ内に貼り付けられているポートレット間

3.9.2. ドラッグ&ドロップの定義と種類

Memo
各タグの詳細は WebOTX ポートレットタグライブラリ を参照して下さい。

3.9.3. ブラウザ経由

図2.9.3-1

図2.9.3-2

3.9.3.1. ドラッグ側 JSP の定義

<otxp:drag id="drag1" >
<div class="otxpDndItem">Item 1</div> 
</otxp:drag>

以下にドロップ可能
<otxp:drop id="drop1">
</otxp:drop>

<otxp:drag id="drag1" 
           model="client"
           onDndSourceOver="<portlet:namespace />_onDndSourceOver" 
           onDndStart="<portlet:namespace />_onDndStart"
           onDndCancel="<portlet:namespace />_onDndCancel"
           copyOnly="false">
    <div class="otxpDndItem">abc</div>
<div>def</div>
</otxp:drag>
<script type="text/javascript">
  function <portlet:namespace>_onDndSourceOver(){ … }
  function <portlet:namespace>_onDndStart(){ … }
  function <portlet:namespace>_onDndCancel() { … }
</script>

3.9.3.2. ドロップ側 JSP の定義

<otxp:drop id="drop1"
           model="client"
           accept="dragId" 
           onDndDrop="<portlet:namespace />_onDndDrop()" 
           onDndDropBefore="<portlet:namespace />_onDndDropBefore()">
   ? ここに Drop 可能 ?
</otxp:drop>
<script type="text/javascript">
  function <portlet:namespace>_onDndDrop(){ … }
  function <portlet:namespace>_onDndDropBefore(){ … }
</script>

3.9.3.3. テキスト入力系へのドロップ

• <input type="text" class="otxpDndItem" >
• <textarea class="otxpDndItem" >

<otxp:drag id="dragzone1">
    <div class="otxpDndItem">Item Alpha</div>
    <div class="otxpDndItem">Item Beta</div>
    <div class="otxpDndItem">Item Gamma</div>
    <div class="otxpDndItem">Item Delta</div>
</otxp:drag>
<otxp:drop id="dropzone1" >
    <div>Item 1</div>
                            ← テキストボックスの前
    <input type="text" class="otxpDndItem" />   ← テキストボックスの中
                            ← テキストボックスの後
    <div>Item 2</div>
    <div>Item 3</div>
</otxp:drop> 

Memo
Firefoxでドロップしてからテキストボックスに入力する場合、フォーカスが移らない場合があります。 その場合、右クリックまたはタブキーでフォーカスを移す必要があります。

<otxp:drag id="dragId">
    <div class="otxpDndItem">
        <div>Item Y</div>
        <div>Item Z</div>
    </div>
</otxp:drag>
 
<otxp:drop id="dropId" accept="dragId">
    <input class="otxpDndItem" type="text"/>
</otxp:drop>

3.9.3.4. ドラッグソースの限定

<otxp:drag id="AA"> 
    <div class="otxpDndItem">Item X</div> 
    <div class="otxpDndItem">Item Y</div> 
    <div class="otxpDndItem">Item Z</div> 
</otxp:drag> 
 
<otxp:drop id="drop2" accept="CC"> 
    <div class="otxpDndItem">Item Alpha</div> 
    <div class="otxpDndItem">Item Beta</div> 
    <div class="otxpDndItem">Item Gamma</div> 
    <div class="otxpDndItem">Item Delta</div> 
</otxp:drop> 

Caution
ブラウザ経由のドラッグ&ドロップを行う場合は、<otxp:drag>、<otxp:drop> のmodel属性は client に統一して下さい。

3.9.4. サーバ経由

3.9.4.1. ドラッグ側 JSP の定義

<otxp:drag id="drag1"
           model="server"
           onDndSourceOver="<portlet:namespace />_onDndSourceOver" 
           onDndStart="<portlet:namespace />_onDndStart"
           onDndCancel="<portlet:namespace />_onDndCancel"
           copyOnly="false">
<div class="otxpDndItem">abc</div>
    <div>def</div>
</otxp:drag>
<script type="text/javascript">
  function <portlet:namespace>_onDndSourceOver(){ … }
  function <portlet:namespace>_onDndStart(){ … }
  function <portlet:namespace>_onDndCancel() { … }
</script>

<div class="otxpDndItem" otxpDndSrc="data">AAA</div>

<otxp:drag id="drag1" model="server" load="<portlet:namespace />_load">
   <div class="otxpDndItem">abc</div>
</otxp:drag>

<script type="text/javascript">
  function <portlet:namespace />_load(response){ 
      // ドラッグ側のサーバからのレスポンスを取得
      var responseData = response;
             :
      // レスポンスデータに対してデータ編集
      responseData = responseData + "addData";
             :
      // 編集したデータを return する
      return responseData;
  }
</script>

3.9.4.2. ドラッグ側 Java の定義

public serveResource(ResourceRequest request, ResourceResponse response) throws PortletException, IOException { 
      response.setContentType("text/xml");
      PrintWriter out = response.getWriter();
      String data = "";
      String resourceID = request.getResourceID();

      //drag側のサーバ処理
      if (resourceID.equals("<otxp:drag>のid属性")) {
           String param = request.getParameter("otxpDndParam");
           data = param;
      }
      
      out.write(data);
      out.close();
}

3.9.4.3. ドロップ側 JSP の定義

<otxp:drop id="drop1"
           model="server"
           handleAs="text"
           accept="server"
           onDndDrop="<portlet:namespace />_onDndDrop()" 
           onDndDropBefore="<portlet:namespace />_onDndDropBefore()"/>
           method="get"
           content="a=1&b=1"
           load="<portlet:namespace />_load()" 
           error="<portlet:namespace />_error()" 
           timeout="30" 
           handle="<portlet:namespace />_handle()" />
</otxp:drop>
<script type="text/javascript">
  function <portlet:namespace />_onDndDrop(){ … }
  function <portlet:namespace />_onDndDropBefore(){ … }
  function <portlet:namespace />_load(){ … }
  function <portlet:namespace />_error(){ … }
  function <portlet:namespace />_handle(){ … }
</script>

3.9.4.4. ドロップ側 Java の定義

public serveResource(ResourceRequest request, ResourceResponse response) 
throws PortletException, IOException { 
      response.setContentType("text/xml");
      PrintWriter out = response.getWriter();
      String data = "";
      String resourceID = request.getResourceID();

     //ドロップ側のサーバ処理
     if (resourceID.equals("[ドロップ側のid]")) {
           String param = request.getParameter("otxpDndResp");
           String a = request.getParameter("a");
           String b = request.getParameter("b");
           data  = "Drop Server!" + a + b + param;
      }
      
      out.write(data);
      out.close();
}

Caution
サーバ経由のドラッグ&ドロップを行う場合は、<otxp:drag> と <otxp:drop> のmodel属性は server に統一して下さい。

3.10. ポートレットウィンドウ状態を利用した表示切替の作成

3.10.1. ポートレットウィンドウ状態でJSPファイルを分ける方式

public class TestPortlet extends GenericPortlet {
    public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {
        response.setContentType(request.getResponseContentType());
        String viewpage = "";
        
        if (request.getWindowState() == WindowState.MAXIMIZED) {
            viewpage = getPortletConfig().getInitParameter("MaxPage");
        } else {
            viewpage = getPortletConfig().getInitParameter("ViewPage");
        }
        
        PortletRequestDispatcher rd = getPortletContext().getRequestDispatcher(viewpage);
        rd.include(request, response);
    }
}

<portlet-app>
    <portlet>
        <init-param>
            <name>ViewPage</name>
            <value>/jsp/html/XXXView.jsp</value>
        </init-param>
        
        <init-param>
            <name>MaxPage</name>
            <value>/jsp/html/XXXViewMax.jsp</value>
        </init-param>
        

3.10.2. 同一JSPファイル中で切り替える方式

<%@ taglib uri="http://www.nec.com/webotx/portlet" prefix="otxp"%>
<div>AAA</div>
<otxp:winstat viewStandard="maximized">
  <div>BBB</div>
</otxp:winstat>
<div>CCC</div>

3.11. Ajax を利用した部分更新の作成

3.11.1. クライアント側 JSP の定義

<otxp:ajax id="ajax1"
           content="a:1" 
           load="<portlet:namespace />_load" 
           error="<portlet:namespace />_error" 
           timeout="30"/> 
<div id="<portlet:namespace />result"> </div> 
<script type="text/javascript">
function <portlet:namespace />_load(response, ioArgs){
    // サーバ側からのレスポンスデータ
    var repdata = response;
    
    // データを画面上の一部に表示
    dojo.byId("<portlet:namespace />result").innerHTML = repdata;
}
function <portlet:namespace />_error(){
     dojo.byId("<portlet:namespace />result").innerHTML = "エラー発生";
}
</script>

3.11.2. サーバ側 Java

public void serveResource(ResourceRequest request, ResourceResponse response) throws PortletException, IOException {
    response.setContentType("text/xml");
    PrintWriter out = response.getWriter();
    String data = "";
    String resourceID = request.getResourceID();

    // リソースIDの判定
    if (resourceID.equals("ajax1")) {
        data = "Hello Ajax!";
    }

    out.write(data);
    out.close();
}

3.11.3. <otxp:ajax>タグの利用法

<otxp:ajax id="ajax1" … />
<input type="button" onclick="<otxp:call funcId="ajax1" />" />

3.11.4. 複数の部分更新定義時

3.11.4.1. クライアント側 JSP の定義

<otxp:ajax id="id_1" load="<porlet:namespace/>_load1()" …/>
<otxp:ajax id="id_2" load="<porlet:namespace/>_load2()" …/>
<otxp:ajax id="id_3" load="<porlet:namespace/>_load3()" …/>
<input type=”text” />
<input type="button" value="編集" onclick="<otxp:call funcId="id_1"/>" />
<input type="button" value="保存" onclick="<otxp:call funcId="id_2"/>" />
<input type="button" value="削除" onclick="<otxp:call funcId="id_3"/>" />
<script type="text/javascript">
  function <porlet:namespace/>_load1() { … }
  function <porlet:namespace/>_load2() { … }
  function <porlet:namespace/>_load3() { … }
</script>

3.11.4.2. サーバ側 Java の定義

public void serveResource(ResourceRequest request, ResourceResponse response) throws PortletException, IOException {
    String resourceID = request.getResourceID();
    if (resourceID.equals("id_1")) {
        // 編集処理
    }else if (resourceID.equals("id_2")){
        // 保存処理
    } else if (resourceID.equals("id_3")){
        // 削除処理
    }
}

3.11.5. ポートレットウィザードでの雛形生成

3.11.5.1. クライアント側：JSPファイル

<otxp:ajax id="ajax1" load="<portlet:namespace/>_load" handleAs="text"/>
<script type="text/javascript">
function <portlet:namespace/>_load(data,ioargs) {
    dojo.byId("result").innerHTML = data;
}
</script>
<div id="result"></div>
<input type="button" value="Click" onclick="<otxp:call funcId="ajax1"/>" />

3.11.5.2. サーバ側：Javaファイル

public void serveResource(ResourceRequest request, ResourceResponse response) throws PortletException, IOException {
    response.setContentType("text/xml");
    PrintWriter out = response.getWriter();
    String data = "";
    String resourceID = request.getResourceID();

    if (resourceID.equals("ajax1")) {
        data = "Hello Ajax!";
    }

    out.write(data);
    out.close();
}

3.11.6. ポートレットからXMLHttpRequestを使用した場合のセッションタイムアウト

function <portlet:namespace />_sendRequest(){
	// XMLHttpRequestを発行する
	dojo.xhrGet({
		url: "<%=rc_url%>",
		handleAs: "text",
		timeout: 10000,
		sync: false,
		load: function(responseData, ioArgs){
			var resStatus = ioArgs.xhr.getResponseHeader("X-WebOTX-Portal-Status");
			if(resStatus === "400"){
				// セッションタイムアウトが発生した場合の処理
			}
			else if(resStatus === "500"){
				// サーバでエラーが発生した場合の処理。
			}
			else{
				// 通信が正常に終了した場合の処理
			}
		},
		error: function(error, ioArgs){
			alert("error!");
		}
	});
}

3.12. SWFアプリケーションを利用したポートレットの作成

<otxp:swf url="http://SWFアプリケーションのURL"/>

3.13. 他システム連携ポートレットの作成

3.13.1. ビルトインポートレットを利用

3.13.2. カスタムのコンテンツ表示ポートレットを利用

...
import java.io.*;
import javax.portlet.*;
import com.nec.webotx.portal.contentportlet.api.*;
public class TestPortlet extends GenericPortlet {
    public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {
	
        // Get preference
        PortletPreferences prefs = request.getPreferences();

        // Get content url
        String src = prefs.getValue("URL", "http://host1.co.jp");

        // Get height(pixel)
        String height = prefs.getValue("HEIGHT", "500");

        // Get scroll
        String scroll = prefs.getValue("SCROLL", "auto");

        // Constructor
        response.setContentType("text/html");
        PrintWriter writer = response.getWriter();
        Locale locale = request.getLocale();
        IFrameComponent iFrameComponent;
        try {
            iFrameComponent = new IFrameComponent(src, writer, locale);
        } catch (URISyntaxException e) {
            e.printStackTrace();
            return;
        }
        iFrameComponent.setHeight(height);
        iFrameComponent.setScrolling(scroll);
        // Set other attributes
        iFrameComponent.setIFrameAttribute("frameborder", "1");
        iFrameComponent.setIFrameAttribute("marginwidth", "10");
        // Print iframe tag
        iFrameComponent.generateContent();

    }
}

3.13.3. ポートレットとして利用

3.14. ポートレット参照の利用

3.14.1. ポートレット参照の起動

3.14.2. ポートレット参照ノードの説明に記載

Memo
参照用のアイコンは非参照用のアイコンの明るさを弱めて表示させたものです。

<event-definition xmlns:接頭辞="名前空間">
    <qname>接頭辞:イベント名</qname>
    <value-type>イベントペイロードの型</value-type>
</event-definition>

<event-definition>
    <name>イベント名</name>
    <value-type>イベントペイロードの型</value-type>
</event-definition>

<supported-publishing-event xmlns:接頭辞="名前空間">
    <qname>接頭辞:イベント名</qname>
</supported-publishing-event>

<supported-publishing-event>
      <qname>イベント名</qname>
</supported-publishing-event>

<supported-processing-event xmlns:接頭辞="名前空間">
      <qname>接頭辞:イベント名</qname>
</supported-processing-event>

<supported-processing-event>
  <name>イベント名</name>
</supported-processing-event>

Memo
参照用のアイコンは非参照用のアイコンの明るさを弱めて表示させたものです。

3.15. ポートレットフィルターの作成

3.15.1. ポートレットフィルターのインタフェース

• ActionFilter
• RenderFilter
• ResourceFilter
• EventFilter

3.15.2. ポートレットフィルターの定義

<filter>
<filter-name>TestFilter</filter-name>
  <filter-class>com.nec.portlet.TestPortlet</filter-class>
  <lifecycle>RENDER_PHASE</lifecycle>
  <lifecycle>ACTION_PHASE</lifecycle>
  <lifecycle>EVENT_PHASE</lifecycle>
  <lifecycle>RESOURCE_PHASE</lifecycle>
  <init-param>
    <description>foo</description>
    <name>time</name>
    <value>100</value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>TestFilter</filter-name>
  <portlet-name>TestPortlet</portlet-name>
</filter-mapping>

3.15.3. ポートレットフィルターウィザード

package パッケージ名;
 
import java.io.IOException;
import javax.portlet.*;
import javax.portlet.filter.*;
 
public class クラス名 extends スーパークラスimplements レンダーフィルター, アクションフィルター, イベントフィルター, リソースフィルター {
 
/**
* When the filter is initialized, it is executed only once.
*/
public void init(FilterConfig filterConfig) throws PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool.
 
}
 
// レンダーフィルターインタフェースの実装
/**
* It is a main body of the filter processing. When the filter is called, it
* is executed every time.
*/
public void doFilter(RenderRequest request, RenderResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}
 
// アクションフィルターインタフェースの実装
/**
 * It is a main body of the filter processing. When the filter is called, it
 * is executed every time.
 */
public void doFilter(ActionRequest request, ActionResponse response,　FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}
 
// イベントフィルターインタフェー??の実装
/**
 * It is a main body of the filter processing. When the filter is called, it
 * is executed every time.
 */
public void doFilter(EventRequest request, EventResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}
 
// リソースフィルターインタフェースの実装
/**
 * It is a main body of the filter processing. When the filter is called, it
 * is executed every time.
 */
public void doFilter(ResourceRequest request, ResourceResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}
 
/**
 * It is called when the filter is destroyed.
 */
public void destroy() {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool.
 
}
}

// レンダーフィルターインタフェースの実装
/**
 * It is a main body of the filter processing. When the filter is called, it
* is executed every time.
*/
public void doFilter(RenderRequest request, RenderResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}

// レンダーフィルターインタフェースの実装
/**
* It is a main body of the filter processing. When the filter is called, it
* is executed every time.
*/
public void doFilter(RenderRequest request, RenderResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}

// イベントフィルターインタフェースの実装
/**
* It is a main body of the filter processing. When the filter is called, it
* is executed every time.
*/
public void doFilter(EventRequest request, EventResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}

// リソースフィルターインタフェースの実装
/**
* It is a main body of the filter processing. When the filter is called, it
* is executed every time.
*/
public void doFilter(ResourceRequest request, ResourceResponse response, FilterChain chain) throws IOException, PortletException {
// TODO Stub method generated by NEC WebOTX Developer,  Portlet Tool. Filter’s logic must be implemented.
chain.doFilter(request, response);
}

3.16. 多言語

3.17. ポートレットアーカイブの作成

3.18. ポートレットの配備

3.18.1. 方法１：サーバで実行

3.18.2. 方法２：運用管理パースペクティブ

3.18.3. 方法３：運用管理コンソール

3.19. ポートレットの実行

3.20. ポートレットプロジェクトへの変換

1. WebAPPというプロジェクト名の動的Webプロジェクトを作成します。
2. WebAPP/WebContentの配下にindex.jspというJSPファイルを作成します。
   index.jspの内容は以下のようになります。
   

   <%@ page language="java" contentType="text/html; charset=windows-31j" pageEncoding="windows-31j"%>
   <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   <html>
      <head>
         <meta http-equiv="Content-Type" content="text/html; charset=windows-31j">
         <title>Insert title here</title>
      </head>
      <body>
         Hello World!
      </body>
   </html>
   

3. 作成した動的Webプロジェクトをポートレットプロジェクトに上記の変換流れのように変更します。
4. HelloPortletというポートレット名のJSP/HTMLポートレットをポートレットウィザードを利用して作成します。
5. 生成された portlet.xmlに以下のように変更します。

   <init-param>
      <name>ViewPage</name>
      <value>/index.jsp</value>
   </init-param>
   

6. このポートレットを配備しポータルページに追加すると、Hello World!という文字列が表示されます。

3.21. API 一覧

• com.nec.webotx.portal.container.CustomPortletMode
• com.nec.webotx.portal.contentportlet.api.IFrameComponent
• com.nec.webotx.portal.container.portlet.PortletListener
• com.nec.webotx.portal.container.portlet.AboutProperty
• com.nec.webotx.portal.container.portlet.PortletRequestAttributesConsts

3.22. WebOTX ポートレットタグライブラリ

3.22.1. <otxp:winstat>

<%@ taglib uri="http://www.nec.com/webotx/portlet" prefix="otxp"%>
<otxp:winstat viewStandard="[normal|maximized|all|none]">ユーザコンテンツ</otxp:winstat>

3.22.2. <otxp:swf>

<%@ taglib uri="http://www.nec.com/webotx/portlet" prefix="otxp"%>
<otxp:swf url="[url]"
          id="[id]"
          width="[width]"
          height="[height]"
          flashVars="[flashVars]"
          params="[params]"/>

3.22.3. <otxp:drag>

<otxp:drag id="[id]"
           model="[client|server]"
           copyOnly="[true|false]"
           onDndStart="[onDndStart]"
           onDndSourceOver="[onDndSourceOver]"
           onDndCancel="[onDndCancel]"
           handleAs="[text|json|json-comment-optional|json-comment-filtered|javascript|xml]"
           method="[get]"
           content="[content]"
           timeout="[timeout]"
           load="[load]"
           error="[error]"
           >
<div class="otxpDndItem otxpDndSrc="data">ドラッグコンテンツ</div>
</otxp:drag>

function function OtxDrag<portlet:namespace />_myLoad(responseData) {
	var data1 = "データ";
	var responseData += encodeURIComponent( data1);
	return responseData;
}

3.22.4. <otxp:drop>

<%@ taglib uri="http://www.nec.com/webotx/portlet" prefix="otxp"%>
<otxp:drop id="[id]"
           model="[client|server]"
           handleResponse="[handleResponse]"
           accept="[accept]"
           onDndDrop="[onDndDrop]" 
           onDndDropBefore="[onDndDropBefore]"
           handleAs="[text|json|json-comment-optional|json-comment-filtered|javascript|xml]"
           method="[get|post]"
           content="[content]"
           timeout="[timeout]" 
           load="[load]" 
           error="[error]" 
           handle="[handle]">
</otxp:drop>

3.22.5. <otxp:ajax>

<%@ taglib uri='http://www.nec.com/webotx/portlet' prefix='otxp'%>
<otxp:ajax id="[id]"
           handleAs="[text|json|json-comment-optional|json-comment-filtered|javascript|xml]"
           method="[get|post]"
           content="[content]"
           load="[load]"
           error="[error]"
           timeout="[timeout]"
           handle="[handle]"
/>

3.22.6. <otxp:call>

<%@ taglib uri="http://www.nec.com/webotx/portlet" prefix="otxp"%>
<otxp:call funcId="[funcId]" type="[type]" />

3.23. スニペット 一覧

3.23.1. WebOTX Portlet Tag

• WebOTX Portlet Tagのtaglib宣言
• <otxp:winstat>
• <otxp:swf>
• <otxp:drag>
• <otxp:drag>(関数定義付き)
• <otxp:drop>
• <otxp:drop>(関数定義付き)
• <otxp:ajax>
• <otxp:ajax>(関数定義付き)
• <otxp:call>

3.23.1.1. <otxp:winstat>

<otxp:winstat viewStandard="all"></otxp:winstat>

3.23.1.2. <otxp:swf>

<otxp:swf url="" id="" width="" height="" flashVars="" params="" />

3.23.1.3. <otxp:drag>

3.23.1.4. <otxp:drag>(関数定義付き)

<otxp:drag id="drag_"
           model="client"
           copyOnly="true"
           onDndStart="<portlet:namespace />_onDndStart"
           onDndSourceOver="<portlet:namespace />_onDndSourceOver"
           onDndCancel="<portlet:namespace />_onDndCancel"
           handleAs="text"
           method="get"
           content=""
           timeout="30"
           load="<portlet:namespace />_load"
           error="<portlet:namespace />_error"
           handle="<portlet:namespace />_handle">
     <div class="otxpDndItem" otxpDndSrc="data">Content</div>
</otxp:drag>
<script type="text/javascript">
    function <portlet:namespace />_onDndStart(){
    }

    function <portlet:namespace />_onDndSourceOver(){
    }

    function <portlet:namespace />_onDndCancel(){
    }

    function <portlet:namespace />_load(){
    }

    function <portlet:namespace />_error(){
    }

    function <portlet:namespace />_handle(){
    }
</script>

3.23.1.5. <otxp:drop>

<otxp:drop id="drop_"
           model="client"
           accept=""
           onDndDropBefore="<portlet:namespace />_onDndDropBefore"
           onDndDrop="<portlet:namespace />_onDndDrop"
           handleAs="text"
           method="get"
           content=""
           timeout="30"
           load="<portlet:namespace />_load"
           error="<portlet:namespace />_error"
           handle="<portlet:namespace />_handle">
    <div class="otxpDndItem"></div>
</otxp:drop>

3.23.1.6. <otxp:drop>(関数定義付き)

<otxp:drop id="drop_"
           model="client"
           handleResponse="<portlet:namespace />_handleResponse"
           accept=""
           onDndDropBefore="<portlet:namespace />_onDndDropBefore"
           onDndDrop="<portlet:namespace />_onDndDrop"
           handleAs="text"
           method="get"
           content=""
           timeout="30"
           load="<portlet:namespace />_load"
           error="<portlet:namespace />_error"
           handle="<portlet:namespace />_handle">
    <div class="otxpDndItem"></div>
</otxp:drop>
<script type="text/javascript">
    function <portlet:namespace />_onDndDropBefore(){
    }

    function <portlet:namespace />_onDndDrop(){
    }

    function <portlet:namespace />_load(){
    }

    function <portlet:namespace />_error(){
    }

    function <portlet:namespace />_handle(){
    }

    function <portlet:namespace />_handleResponse(responseData){
    }
</script>

3.23.1.7. <otxp:ajax>

<otxp:ajax id="ajax_"
           method="get"
           content=""
           handleAs="text"
           timeout="30"
           load="<portlet:namespace />_load"
           error="<portlet:namespace />_error"
           handle="<portlet:namespace />_handle" />

3.23.1.8. <otxp:ajax>(関数定義付き)

<otxp:ajax id="ajax_"
           method="get"
           content=""
           handleAs="text"
           timeout="30"
           load="<portlet:namespace />_load"
           error="<portlet:namespace />_error"
           handle="<portlet:namespace />_handle" />
<script type="text/javascript">
    function <portlet:namespace />_load(){
    }

    function <portlet:namespace />_error(){
    }

    function <portlet:namespace />_handle(){
    }
</script>

3.23.1.9. <otxp:call>

<otxp:call funcId="" type="ajax"/>

3.23.2. WebOTX Portlet Javascript

• 名前空間付きの関数

3.23.2.1. 名前空間付きの関数

<portlet:namespace />_ func() {
      //TODO
}

3.23.3. WebOTX Portlet Java

• ポートレットイベントの送信処理
• ポートレットイベントの受信処理
• パブリックレンダーパラメータの利用
• ajax更新
• 表示モードの描画処理
• 個人設定モードの描画処理
• ヘルプモードの描画処理
• 説明モードの描画処理
• 共用設定モードの描画処理
• プリファレンスの取得
• プリファレンスの設定

3.23.3.1. ポートレットイベントの送信処理

public void processAction(ActionRequest request, ActionResponse response) throws PortletException, IOException {
  try {
    javax.xml.namespace.QName qName = new javax.xml.namespace.QName("http://com.nec.webotx", "eventName", "prefix");
    java.lang.String data = "";
    response.setEvent(qName, data);
  } catch (Exception e) {
    e.printStackTrace();
  }
}

3.23.3.2. ポートレットイベントの受信処理

@javax.portlet.ProcessEvent(qname = "{http://com.nec.webotx}eventName")
public void handleEvent(EventRequest request, EventResponse response) throws PortletException, IOException {
  javax.portlet.Event event = request.getEvent();
  java.lang.String data = (java.lang.String) event.getValue();
}

3.23.3.3. パブリックレンダーパラメータの利用

public void processAction(ActionRequest request, ActionResponse response) throws PortletException,IOException {
  String publicRenderParamValue = request.getParameter("id");
  response.setRenderParameter("id",
  publicRenderParamValue);
}

3.23.3.4. ajax更新

public void serveResource(ResourceRequest request, ResourceResponse response) throws PortletException, IOException {
  String resourceID = request.getResourceID();
  PrintWriter writer;
  writer = response.getWriter();
  writer.print(“Hello Ajax!”);
}

3.23.3.5. 表示モードの描画処理

public void doView(RenderRequest request, RenderResponse response) throws PortletException, IOException {
}

3.23.3.6. 個人設定モードの描画処理

public void doEdit(RenderRequest request, RenderResponse response) throws PortletException, IOException {
}

3.23.3.7. ヘルプモードの描画処理

public void doHelp(RenderRequest request, RenderResponse response) throws PortletException, IOException {
}

3.23.3.8. 説明モードの描画処理

@RenderMode(name = "about")
public void doCustomAbout(RenderRequest request, RenderResponse response) throws PortletException, IOException {
}

3.23.3.9. 共用設定モードの描画処理

@RenderMode(name = "edit_defaults")
public void doCustomEditDefaults(RenderRequest request, RenderResponse response) throws PortletException, IOException {
}

3.23.3.10. プリファレンスの取得

PortletPreferences prefs = request.getPreferences();
String data = prefs.getValue("KEY_NAME", "");

3.23.3.11. プリファレンスの設定

PortletPreferences prefs = request.getPreferences();
prefs.setValue("PEF_KEY", "value");
try {
  prefs.store();
} catch (ValidatorException e) {
  // TODO handle the exception
  e.printStackTrace();
} catch (IOException e) {
  // TODO handle the exception
  e.printStackTrace();
}

3.23.4. Dojo部品

• ColorPalette部品
• Dialog部品
• Editor部品
• Button部品
• CheckBox部品
• CombButton部品
• CurrencyTextBox部品
• DataTextBox部品
• Form部品
• RadioButton部品
• TextBox部品
• TitlePane部品
• Tooltip部品
• ProgressBar部品
• Menu部品

<div id ="<portlet:namespace/>Content">
  <input dojoType="dijit.form.TextBox" id="textBox_<portlet:namespace/>">
</div>

<script type="text/javascript" >
  dojo.require("dojo.parser");
  dojo.require("dijit.form.TextBox");
  dojo.parser.parse(dojo.byId("<portlet:namespace/>Content"));
</script>

3.23.4.1. ColorPalette部品

<div dojoType="dijit.ColorPalette" id="colorPalette_<portlet:namespace/>"></div>

3.23.4.2. Dialog部品

<div dojoType="dijit.Dialog" id="dialogOne<portlet:namespace />" title="Dialog Title"></div>
<input type="button" value="Show me!" onclick="show<portlet:namespace />()" />
<script type="text/javascript">
    function show<portlet:namespace />() {
         dijit.byId("dialogOne<portlet:namespace />").show();
    }
</script>

3.23.4.3. Editor部品

<div dojoType="dijit.Editor" name="field" id="editor_<portlet:namespace/>"></div>

3.23.4.4. Button部品

<button dojoType="dijit.form.Button"  type="button" label="Button" id="button_<portlet:namespace/>"></button>

3.23.4.5. CheckBox部品

<input dojoType="dijit.form.CheckBox" id="checkBox_<portlet:namespace/>" />

3.23.4.6. CombButton部品

<div dojoType="dijit.form.ComboButton" id="comboButton_<portlet:namespace/>"></div>

3.23.4.7. CurrencyTextBox部品

<input type="text" dojoType="dijit.form.CurrencyTextBox" id="currencyTextBox_<portlet:namespace/>" currency="JPY" />

3.23.4.8. DataTextBox部品

<input type="text" dojoType="dijit.form.DateTextBox" id="dateTextBox_<portlet:namespace/>" />

3.23.4.9. Form部品

<div dojoType="dijit.form.Form" id="form_<portlet:namespace/>" action="" method=""></div>

3.23.4.10. RadioButton部品

<input type="radio" dojoType="dijit.form.RadioButton" id="radioButton_<portlet:namespace/>"/>

3.23.4.11. TextBox部品

<input type="text" class="otxpDndItem" dojoType="dijit.form.DateTextBox" id="textBox_<portlet:namespace/>"/>

3.23.4.12. TitlePane部品

<div dojoType="dijit.TitlePane" title="Title"></div>

3.23.4.13. Tooltip部品

<span id="text<portlet:namespace/>">text</span><span dojoType="dijit.Tooltip" connectId="text<portlet:namespace/>">tooltip</span>

3.23.4.14. ProgressBar部品

<div dojoType="dijit.ProgressBar" jsId="jsProgress">
</div>
<input type="button" value="Start" onclick="download<portlet:namespace/>();" />
<script type="text/javascript">
function download<portlet:namespace/>(){
  var step = 0;
  jsProgress.update({
    maximum: 1,
    progress: ++step
  });
}
</script>

3.23.4.15. Menu部品

<input type="text" class="otxpDndItem" dojoType="dijit.form.DateTextBox" id="textBox_<portlet:namespace/>"/>

3.24. スマートデバイス向けアプリケーションとして利用するポートレットの作成

3.24.1. アイコン一覧

WebOTX Portalをスマートデバイス向けアプリケーションで利用する場合、表示するページ一覧、および、ポートレットをアイコンに関連付けます。
スマートデバイスアプリケーションで提供するアイコンの説明をします。

3.24.2. ページアイコンの登録

ポータルサーバの以下のディレクトリに、スマートデバイスアプリケーションでページ一覧を表示する際に使用するアイコンを登録します。

アイコンファイル格納フォルダ

${WEBOTX_INSTANCE_ROOT}/config/portal/resources/webotxportal/images/page/

格納したアイコンファイルの一覧をプロパティファイルに記載します。

ページアイコンを定義するプロパティファイル(pageIcon.properties)

${WEBOTX_INSTANCE_ROOT}/config/portal/resources/webotx-portal/images/page/pageIcon.properties

3.24.3. ポートレットアイコンの登録

ポートレットデプロイメント述子( portlet.xml )のinit-paramに、アイコンファイル名を定義します。
なお、指定したアイコンファイルは、WEB-INFと同列にimagesディレクトリを作成し、そのディレクトリに格納します。

portlet.xmlの設定例

    <init-param>
      <name<webotx-portlet-icon</name<
      <value<announcePortletIcon.png</value>
    </init-param>

3.25. プログラミング上の注意事項

3.25.1. HTML関連

• ポートレットのコンテンツ内で <body>、<head> タグは使用できません。
• <object/> タグは対応していません。
• WebOTX Portal のDOCTYPEは XHTML 1.0 Transitional となります。そのため<frame>、<frameset> タグはポートレットコンテンツ中では利用できません。

3.25.2. スクリプト関連

• WebOTX Portal ではポートレットのコンテンツに記載された <script> タグはポートレットがページに読み込まれた タイミングで実行されます。なお、src属性を利用して外部のjsファイルを読み込む場合、作成ポートレットごとにjsファイルが 複数回ロードされますので、複数回ロードされた場合でも正しく動作するような考慮が必要です。
• WebOTX Portalの動作上、ポートレットのコンテンツが読み込まれるタイミングでは既にonLoad のイベントは発行された後になるため、 ドキュメントのonloadのタイミングに対してする処理は定義できません。dojo.addOnLoad も同様です。
• ポートレットコンテツ内で document.write は利用できません。
• ポートレットのコンテンツがscript処理などでポートレットのサイズを動的に更新する処理を実行するとレイアウトが崩れる場合があります。
• WebOTX Portal では内部で dojo 1.10.4 を利用しています。WebOTX Portal 上で動作させるポートレットで dojo を利用する場合は、 WebOTX Portal が利用している dojo 1.10.4 のみ利用することができます。
  その場合、WebOTX Portal で使用している dojo を利用するため、ポートレットアプリケーション(WAR)に dojo のjsファイルを含める必要はありません。アプリケーション中で必要に応じて dojo.require を実行することで利用できます。
• dojo の dijit を利用する場合は、ポートレットのコンテンツロード時に dojo.parse.parser を実行する必要があります。

  <div id="<portlet:namespace/>Content">
      <input type="text" dojoType="dijit.form.TextBox"/>
  </div>
  
  <script type="text/javascript">
  dojo.parser.parse(dojo.byId("<portlet:namespace/>Content"));
  </script>
  

3.25.3. CSS関連

• コンテンツ内の<style> 要素中の@import記述はサポートしていません。 <link> 要素または <style> 要素中に直接記述してください。
• ポータルを実現するために利用している以下のdojoのウィジットは、ポータルの定義しているスタイルの影響を受けます。
  • dojox.layout.GridContainer
• dojoのウィジットを利用する際は、そのウィジットを利用している箇所全てに影響しないように影響範囲が閉じたスタイル定義を行ってください。
  悪い例: .dojoInline要素を使っている全ての箇所のスタイルを変更してしまう。

  .dojoInline {
      border: 1px !important;
  }
  

• bodyにデフォルトのフォントサイズ 14px を指定しています。em等を利用する際は注意して指定してください。
• スタイルシートの名称や各スタイルの定義名は、ポートレット中でのみ有効となるような名称とする ように注意して下さい。

3.25.4. その他

• ポートレットは異なるWARとして作ったそれぞれの画面を同じHTML上に表示する関係上、Javascript の変数や関数名、HTMLのID属性等は 他のポートレットと重複しないようにする必要があります。重複している場合、どの関数や変数が利用されるのか不定なため誤動作を起こす場合があります。
  重複を避けるためには、ポートレット名前空間 <portlet:namespace /> を付与する必要があります。