WebSphere Portal V5.1.0.1プログラミング・モデルを活用する:第2部:高度なURL生成

コンテンツ はじめに ステート・ハンドリングの確認 ナビゲーション・ステートのエンコード Navigational State SPIを調べる ナビゲーション・ステートとURLを表す URLエンコードを理解する アクセサーAPIを使用したナビゲーション・ステートの読み取りと書き込み PortalStateManagerServiceを使用したURLの生成 URLAccessorFactoryを使用したURLの作成 例：テーマ用のパンくずリスト・ナビゲーション・コントロール まとめ 既知の問題 ダウンロード リソース 筆者について（原文のまま）

これは、WebSphere Portal V5.1.0.1プログラミング・モデルの企業ポータルへの適用を支援する連続記事の第2部です。第1部では、モデルについて解説しました。 第2部では、従来のWebアプリケーション業界のプログラマーにとって難しい領域であるUniformResource Locator(URL)の生成方法を取り上げます。 ポータル環境は、URLの作成が必要なコンポーネントにとって特殊な要件をもたらします。このため、ポータル環境でのURLの生成は少し複雑になります。 この記事では、ポータル・コンポーネントが、ポータルJSPタグよりも優れた機能を持つWebSphere Portalバージョン5.1.0.1 System Programming Interface (SPI)を使用してURLを生成する方法を解説します。 また、ナビゲーション用のパンくずリストを実装した例を用いて、これらのSPIの使用方法についても解説します。

はじめに

• テーマ：ページ全体のルック・アンド・フィールとページのレイアウトを作成します。
• スキン：ポートレット・ウィンドウのルック・アンド・フィールを作成します。ウィンドウの状態やポートレットのポートレット・モードを変更するボタンも含まれます。
• ポートレット：ポートレット・ウィンドウ内のコンテンツをレンダリングします。

上に戻る

ステート・ハンドリングの確認

• パーシスタント・ステート(Persistent state)：PortletPreferences APIを介して公開されます。ポートレットの実装者は、プリファレンスを使用して、ポータルのエンド・ユーザー・セッションでデータを保存および取得できます。
• セッション・ステート(Session state)：PortletSession APIを介して公開されます。セッション・ステートはサーバー上で保持されるデータを表し、このデータはポートレット・コンテナーによって管理される限られたライフタイムを持ちます。セッション・ステートの目的は、一時的な特性を持ち、他のステートや現在の対話からは再計算できない情報(たとえば、ショッピング・カートの中身)を保持することです。テーマとスキンは、HttpSessionを使用してセッション・ステートを使用できます。
• ナビゲーション・ステート：PortletRequestを使用したレンダリングまたは対話パラメーターの形で公開されます。ナビゲーション・ステートは、ポートレット上の現在のビューに特有な情報(たとえば、選択されているタブ)を表します。このステートのライフタイムは、ポートレット要求のライフタイムと同じです。ポートレットのナビゲーション・ステートは、ポートレット・コンテナーによって、エンド・ユーザーと他のポータル成果物(たとえば、ページ上の他のポートレットまたはテーマ内のナビゲーション)との対話に沿って管理されます。ナビゲーション・ステートの使用は、WebSphere Portalでブラウザーの「戻る」と「進む」ボタンを有効にする際に重要です。ポートレットのレンダリング・パラメーターに加え、WebSphere Portalは、ページ選択、ページ・ナビゲーション・ツリーの展開状態、ポートレットのモードなどのナビゲーション・ステート情報を管理します。すべての指定済みポートレットの結合されたレンダリング・パラメーターは、システムの完全なナビゲーション・ステートを形成します。これは、ポータル・ページの各URLにエンコードしなければなりません。

• アクション・リンクは、ポートレットのアクション・フェーズを呼び出すトリガーとなります。ポートレットは、このフェーズでセッション・ステートまたはバックエンド・ステートを自由に変更でき、アクション・フェーズの最後に新しいレンダリング・パラメーターを関連付けます。これらのレンダリング・パラメーターは、アクション要求に続くレンダリング要求で有効になります。アクション・フェーズは、ページ上の他のポートレットがレンダリングを開始する前に呼び出されるため、この柔軟性の短所としてパフォーマンスが低下します。アクションの完了後にのみ、これらのポートレットはレンダリングを開始できます。しかし、WebSphere Portalのパラレル・ポートレット・レンダリング(Parallel Portlet Rendering)機能を有効にすると、これらのレンダリングを並列して実行できます。アクション・リンクは、WWW1のW3Cアーキテクチャー推奨(「リソース」参照)に適合させるために、常にPOSTリンクとしてエンコードする必要があります。
• レンダー・リンクは、レンダリング・パラメーターのセットをリンクの呼び出し時に発行される要求と結び付けます。レンダー・リンクの呼び出しの結果として、ポートレットのアクション・フェーズは呼び出されず、ポートレットはレンダリング・パラメーターの新しいセットを使用してそのビューをレンダリングする必要があります。また、レンダー・リンクの呼び出しの結果として、ポートレットはセッション・ステートまたはバックエンド・ステートを変更することはできません。レンダー・リンクは、ポートレットと対話するために最も効率的な方法を提供し(JavaScriptを使用した未加工のクライアント・サイドの対話を除く)、ナビゲーション・ステートが変更された場合にのみ使用します。レンダー・リンクはGETリンクとしてエンコードしなければなりません(「リソース」参照)。

• エンジン・アクション(Engine Actions)へのリンクは、ポートレットのアクション・リンクに相当します。このリンクは、サーバー・サイド・ステートを変更できるサーバー・サイド・コマンドを参照するためです。
• それ以外のすべてのリンク(たとえば、ページ選択またはポートレット・ステート/モードの変更)は、ポートレットのレンダー・リンクに相当します。これらのリンクは、サーバーのステートを変更せずにポータル・サーバーだけの異なるビューを要求し、GETリンクとして表す必要があります(「リソース」参照)。

上に戻る

ナビゲーション・ステートのエンコード

上に戻る

Navigational State SPIを調べる

上に戻る

ナビゲーション・ステートとURLを表す

• com.ibm.portal.state.StateHolderは、ナビゲーション・ステート情報への読み取りアクセスを提供します。
• com.ibm.portal.state.StateHolderControllerはステート情報の変更を可能にします。

• URLのデコード時に、ポータルはステート・ホルダーを作成し、受信した要求URLから取得したナビゲーション・ステートを割り当てます。次に、URLに含まれるフラットで文字ベースのステート表現を、階層的なオブジェクト表現(前述の文書モデル)に変換します
• アクションの処理時に、ポータル・エンジンとポートレットはステートを変更できます。アクション・フェーズの処理が完了した後、ポータルはステートを固定し、変更できないようにします。
• レンダリング時に、指定済みポータル・ページの一部であるポートレットとナビゲーション・コントロールは、URLを生成し、それらをマークアップに含めます。通常、生成されたURLはターゲットのナビゲーション・ステートをエンコードします。このナビゲーション・ステートは、固定されたステート・ホルダー(ベース・ステートとも呼ばれます)と、対応するURLの特定のセマンティクスを表す部分的なステート情報によって構成されます(「URLエンコードを理解する」を参照)。この段階ではベース・ステートを変更できないため、ポータル・エンジンは新しい各URL用に、このベース・ステートの(論理的な)コピーを作成します。このベース・ステートは、URLの目的とするセマンティクスに応じて変更できます。ベース・ステートを維持することにより、前の対話のナビゲーション・ステートは失われません。

 public interface EngineURL extends DisposableURL {	
    /** Returns a read-write interface to the state carried by this URL */
    StateHolderController getState();
    /** Specifies whether the URL should point to public /protected area */
    void setProtected(Boolean bFlag);	
    /** Specifies whether a secure connection is requested */
    void setSecure(Boolean bFlag);
    /**
     * Streams the URL to the given writer. Maintains the state of the URL
     * i.e. this method can be called multiple times.
     */
    Writer writeCopy(Writer out)
       throws IOException, OutputMediatorException, 
              PostProcessorException, DocumentModelException;
    /**
     * Streams the URL to the given writer and finally releases the state
     * of the URL. The EngineURL object must not be accessed after 
     * invoking this method
     */
    Writer writeDispose(Writer out)
       throws IOException, OutputMediatorException, PostProcessorException;
}

上に戻る

URLエンコードを理解する

• URLの生成に必要な処理時間を最小限にします。特に、URLに含めなければならないナビゲーション・ステートのシリアライズに要する時間が短縮されます。
• URLをできるだけ短くします。これにより、マークアップのサイズが減少すると共に、一部のブラウザーで行われているURLの長さの制限(2KBまで)に適合します。

http://myserver.com:9081/wps/portal/kcxml/04_Sj9SPykssy0xPLMnMz0vM0Y_QjHvm5qf
oFuaE6KigCBh9CG/delta/base64xml/Y2BkbGBgYlrDwMDE3srCasTUq!

<head>
    <base href="http://myportal.com:9081/wps/portal/!ut/p/kcxml/04_Sj9SPykssy0xPAIuz!
    </base>
</head>
<body>
...
    <td class="wpsToolBar" valign="middle" nowrap>
       <a href="delta/base64xml/L2dJQSEvUUt3QS80SVVFLzZfQkEwN1VTOVMyMzAwR0!"
          class="wpsToolBarLink">Administration</a>
    </td>
...

上に戻る

アクセサーAPIを使用したナビゲーション・ステートの読み取りと書き込み

public interface SelectionAccessorFactory extends AccessorFactory {
    /** Returns a read-only accessor operating on the given state */
    SelectionAccessor getSelection(StateHolder state);
    /** Returns a read-write accessor operating on the given state */
    SelectionAccessorController getSelectionController(StateHolderController state);
}

public interface SelectionAccessor extends Accessor {
    /** Returns the object id of the currently selected portal page */
    ObjectID getSelection() throws InvalidSelectionNodeIdException;
}
public interface SelectionAccessorController extends SelectionAccessor {
    /** Selects the page that corresponds with the given id */
    void setSelection(ObjectID pageID) throws CannotInsertSelectionNodeException;
    /** Selects the page that corresponds with the given unique name */
    void setSelection(String uniqueName) throws CannotInsertSelectionNodeException;
} 

 final EngineURL url = ...;
final SelectionAccessorFactory selFct = ...;

final SelectionAccessorController selCtrl = 
    selFct.getSelectionController(url.getState());

try {
    selCtrl.setSelection("wps.StockMarket");
} catch (StateException e) {
    // error handling
    ...
} finally {
    selCtrl.dispose();
}

上に戻る

PortalStateManagerServiceを使用したURLの生成

• WebSphere Portalタグ・ライブラリー(特に、URL-タグとURLGeneration-タグ)が十分でない場合に、テーマ(JSP)内にURLを作成します。
• ポータル関連の成果物(カスタム・タグ、カスタム・ポータル・アクションなど)でプログラマチックにURLを作成します。
• プログラマチックにURLを「オフライン」で作成します。これは、現在のサーブレット要求(たとえば、Enterprise JavaBeans)にアクセスしないビジネス・コンポーネントでの作成を意味します。

/** the JNDI name to retrieve the PortalStateManagerServiceHome object */
private static final String JNDI_NAME = 
                               "portal:service/state/PortalStateManager";

/**
 * The PortalStateManagerServiceHome object to retrieve the service from 
 */
private static PortalStateManagerServiceHome serviceHome;

/** Any method processing request and response. */
public void anyMethod(final HttpServletRequest request,
                      final HttpServletResponse response) {
    try {
        // get the service from our home interface
        final PortalStateManagerService service
            = getServiceHome().getPortalStateManagerService(request, response);
       // use the service
       ...
       // indicate that we do not need it any longer
       service.dispose();
    } catch (Exception e) {
        // error handling
    }
}
/**
 * Looks up the PortalStateManagerServiceHome being valid
 * for the lifetime of the portal.
 */
private static PortalStateManagerServiceHome getServiceHome() {
    if (serviceHome == null) {
        try {
            final Context ctx = new InitialContext();
            serviceHome =
                (PortalStateManagerServiceHome) ctx.lookup(JNDI_NAME);
        } catch (Exception e) {
            // error handling
        }
    }
    return serviceHome;
} 

StateHolderController newState()

変更可能な新しいステート・ホルダーを作成します。いくつかのEngineURL用のベースとして機能する新しいナビゲーション・ステートをプログラマチックに作成するときに、このメソッドを使用します。

AccessorFactory getAccessorFactory(final Class cls)

このサービスによって提供される機能にアクセスできるようにします。決定的な役割は、いわゆるURLAccessorFactoryによって行われます。これにより、プログラマーは、さまざまなユース・ケースをサポートするURLを作成できます。その他すべての取得可能なアクセサー・ファクトリーは、ナビゲーション・ステートの対応するアスペクトを変更することにより、URLの特定のセマンティクスを表現するために必要です。

1. URLAccessorFactoryを使用して新しいEngineURLオブジェクトを取得します。
2. EngineURLオブジェクトに関連付けられているStateHolderControllerを変更し、作成されたURLのセマンティクスを指定します。getAccessorFactory(Class)メソッドによって取得する適切なアクセサー・ファクトリーを使用します。
3. マークアップに含めるために、EngineURLを出力ストリーム(たとえば、JSPWriter)に書き込みます。

上に戻る

次のページへ