ユーザプロファイルの連合

WebLogic Portal により、ユーザプロファイル情報をコンシューマからプロデューサに渡すことができます。この機能により、WebLogic Portal で多くのパーソナライゼーション機能を利用可能にして、連合ポータルで機能させることができます。この章では、連合ポータルでユーザプロファイル情報を処理する方法を説明します。連合ポータルでユーザプロファイル情報を使用できるようにするには、コンシューマアプリケーションとプロデューサアプリケーションの両方で何らかのコンフィグレーションが必要です。

はじめに

この節では、ユーザプロファイル伝播の目的と、WebLogic Portal が連合環境でユーザプロファイルデータを伝播する方法を説明します。

ユーザプロファイルとは

ユーザプロファイルは、ユーザ固有の情報を含むプロパティセットの集合です。WebLogic Portal は、ユーザプロファイルに依存する多くの機能を提供します。たとえば、WebLogic Portal パーソナライゼーション機能は、ユーザプロファイルに依存して、特定のタイプのユーザにカスタマイズされたコンテンツを配信します。

たとえば、Workshop for WebLogic では、性別、雇用日、電子メールアドレスなどのプロパティを格納する従業員というプロパティセットを作成できます。この情報を使用すると、ポータルでユーザが行う操作をパーソナライズできます。ユーザがポータルにログインするときに、ポータルはプロパティ値にアクセスし、設定したパーソナライゼーションルールに基づいて、パーソナライズされたコンテンツ、電子メール、入力済みのフォーム、および割引にその値を適用できます。

パーソナライゼーションの詳細については、『対話管理ガイド』を参照してください。ユーザプロファイルの作成の詳細については、『ユーザ管理ガイド』を参照してください。

連合ポータルでのユーザプロファイル

WebLogic Portal プロデューサがパーソナライズしたコンテンツをコンシューマに返すには、ユーザ情報をコンシューマからプロデューサに伝達する必要があります。連合ポータル内のユーザプロファイル情報を使用するための基本要件には、次のものが含まれます。

プロデューサ側で、ユーザプロパティをコンシューマから要求するように宣言する。ベストプラクティスは、プロデューサでデプロイされているポートレットにより要求されるプロパティのみを要求することです。詳細については、「プロデューサのコンフィグレーション」を参照してください。
コンシューマ側で、必要に応じて、要求されたユーザプロパティを、コンシューマ側に存在する同等のプロパティにマップするマッピングファイルを指定する。コンシューマは、WebLogic Portal パーソナライゼーション (P13N) API を使用して、要求されたユーザプロパティをコンシューマ側で取得します。詳細については、「コンシューマのコンフィグレーション」を参照してください。

図 11-1 に示すように、コンシューマがプロデューサに最初に接続すると、プロデューサは、提供するポートレットのリストと、各ポートレットが必要とするユーザ情報に対する要求を返します。

ポートレットがユーザ情報を要求すると、図 11-2 に示されているように、ポートレットを提供できるようにするため、コンシューマは、プロデューサに getMarkupRequest() の一部としてその情報を提供しようと試みます。WebLogic Portal は一般にマッピングファイルと一緒に P13N API を使用し、要求されたユーザプロパティをコンシューマ側で取得します。

P3P (Platform for Privacy Preferences)

WSRP プロトコルは、ユーザ情報の保存および交換用に標準形式を指定します。この形式は、P3P (Platform for Privacy Preferences) と呼ばれ、インターネット標準です。WebLogic Portal アプリケーションが、WebLogic Portal ユーザプロファイル形式だけでなく、この形式で表示されるユーザ情報を受け入れるようにコンフィグレーションできます。

詳細については、「P3P の例」を参照してください。P3P 仕様は、W3C の Web サイトである www.w3.org/TR/P3P から入手できます。

この機能を使用するタイミング

プロデューサ側とコンシューマ側で定義されたユーザプロパティが一致しない場合に、この機能を使用します。まったく同じユーザプロパティが、コンシューマ側とプロデューサ側に存在する場合、この機能を使用する必要はありません。

プロデューサのコンフィグレーション

連合ポータルでユーザプロファイル情報を使用するには、プロデューサでデプロイされているポートレットにより、どのユーザプロパティが要求されるかをプロデューサ側で宣言する必要があります。宣言されたプロパティは、コンシューマへの応答で整理されて、コンシューマアプリケーションに戻されます。コンシューマアプリケーションは、プロデューサを登録するときに、要求されたユーザプロパティ値を返す必要があります。

ユーザプロファイル情報を使用するためにプロデューサでデプロイされるポートレットをコンフィグレーションする手順は、Java ポートレットまたは非 Java ポートレットのどちらをコンフィグレーションするかによって異なります。

Java ポートレットのコンフィグレーション

Java ポートレット仕様は、名前、電子メールアドレス、電話番号などのユーザ属性に、Java ポートレットがどのようにアクセスするかを指定します。この節では、プロデューサアプリケーションでデプロイされている Java ポートレットに対してユーザ属性を指定する方法、および Java ポートレットがユーザ情報を取得する方法について説明します。

デプロイメント記述子 (portlet.xml) のコンフィグレーション

Java ポートレット仕様は、デプロイされている Java ポートレットにより要求されるユーザ属性を指定するため、<user-attribute> 要素を定義します。図 11-1 は、指定されているユーザプロパティがある portlet.xml ファイルの一部を示しています。<name> 要素は、ユーザ属性名を指定します。

Java ポートレット内のユーザ情報の取得

Java ポートレット仕様は、Java ポートレットがデプロイされているポータル環境から、Java ポートレットがユーザ情報を取得する方法も指定します。ポートレットは、要求を行ったユーザのユーザ属性を含む Map オブジェクトを取得できます。この Map オブジェクトを PortletRequest.USER_INFO 定数を使って、要求から取得できます。

コードリスト 11-2 のコード例は、ユーザ情報の Map を Java ポートレットに関連付けられている JSP 内の要求から取得する方法を示しています。ユーザプロパティ値は、ユーザプロパティ名をキーとして使用して、Map から取得されます。

デフォルトユーザプロパティセットの作成

コードリスト 11-3 では、portlet.xml ファイルで指定されたサンプルユーザ属性を示します。この章は、デフォルトユーザプロパティセットを作成して <user-attribute> プロパティを効率化できる方法について説明します。たとえば、「従業員」というデフォルトユーザプロパティを作成することで、コードリスト 11-3 にある属性名を <name>言語</name> に短縮することができます。

デフォルトユーザプロパティセットを作成するには、まずポータル Web アプリケーションの WEB-INF ディレクトリに weblogic-portlet.xml ファイルを作成します。次に、<user-property-set> 属性を使用してデフォルトユーザプロパティセットをコンフィグレーションします。

コードリスト 11-4 では、Web アプリケーションのすべてのポートレットに「従業員」という名前のデフォルトユーザプロパティセットを作成する方法について示します。

コードリスト 11-5 では、特定のポートレットにデフォルトユーザプロパティセットを作成する方法について示します。

weblogic-portlet.xml で指定されたデフォルトユーザプロパティセット「従業員」で、portlet.xml ファイルのコードリスト 11-3 に示すように <user-attribute> 値をコーディングすることができます。

weblogic-portlet.xml ファイルの詳細については、『ポートレット開発ガイド』の「ポートレットの構築」を参照してください。

ユーザプロパティのマッピング

コンシューマ側とプロデューサ側のユーザプロパティが一致しない場合、コンシューマ側でマッピングファイルを作成できます。マッピングファイルにより、コンシューマは、プロデューサにより要求されるプロパティにマップするユーザプロパティを取得できます。ユーザプロパティのマッピングの詳細については、「コンシューマのコンフィグレーション」を参照してください。

非 Java ポートレットのコンフィグレーション

この節では、プロデューサアプリケーションでデプロイされている非 Java ポートレットに対してユーザ属性を指定する方法について説明します。

デプロイメント記述子ファイルのコンフィグレーション

非 Java ポートレットについては、記述子ファイルの wsrp-producer-config.xml で必要なユーザプロパティを指定します。このファイルは、プロデューサ Web アプリケーションの WEB-INF ディレクトリに配置されます。コードリスト 11-7 は、サンプルの wsrp-producer-config.xml ファイルを示しています。<requiredUserProperties> 要素は、プロデューサ Web アプリケーションでデプロイされているポートレットに対して要求されているユーザプロパティを指定します (太字で表示)。例では、値 All が、コンシューマがプロデューサに対してすべての利用可能なユーザプロファイル情報を提供しなければならないことを指定しています。その他の可能な値については、この節で説明されています。

<?xml version="1.0" encoding="UTF-8"?>
<wsrp-producer-config
    xmlns="http://www.bea.com/servers/weblogic/wsrp-producer-config/9.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:uddi="urn:uddi-org:api_v2"
    xsi:schemaLocation="http://www.bea.com/servers/weblogic/wsrp-producer-config/9.0 wsrp-producer-config.xsd">
    <description></description>
    <service-config>
        <registration required="true" secure="false"/>
        <service-description secure="false" supports-method-get="true"/>
        <markup secure="false" rewrite-urls="true" transport="string"/>
        <portlet-management required="true" secure="false"/>
    </service-config>
    <supported-locales>
        <locale>en</locale>
        <locale>en-US</locale>
    </supported-locales>
    <requiredUserProperties properties="All">
    </requiredUserProperties>
</wsrp-producer-config>

<requiredUserProperties> 要素には、次の 3 つの値のうちのいずれかを使用する properties という 1 つの属性が含まれています。

All - すべてのユーザプロファイル情報を送信するようにコンシューマに指示します。次に例を示します。

<requiredUserProperties properties="All">

None - どのユーザプロファイル情報も送信しないようにコンシューマに指示します。次に例を示します。

<requiredUserProperties properties="None">

Specified - 指定したユーザプロファイル情報のみを送信するようにコンシューマに指示します。<specifiedProperties> サブ要素を使用して、ポートレットにより要求されるユーザ情報を一覧表示します。次に例を示します。

<requiredUserProperties properties="specified"> <description>These are required properties</description> <specifiedProperty name="Employee/name"/> <specifiedProperty name="Employee/gender"/> <specifiedProperty name="Employee/number"/> </requiredUserProperties>

name プロパティに指定される値は、次の形式のいずれかにすることができます。

propertySet/propertyName - プロデューサに定義されているプロパティセットの名前と、そのプロパティセットのプロパティの名前。次に例を示します。

<requiredUserProperties properties="specified"> <specifiedProperty name="Employee/gender"/> </requiredUserProperties>

propertySet/* - プロデューサで定義されているプロパティセットの名前と、そのプロパティセットのすべてのプロパティが要求されていることを指定するアスタリスク (*)。次に例を示します。

<netuix:requiredUserProperties properties="specified"> <specifiedProperty name="Employee/*"/> </requiredUserProperties>

p3pName - P3P ユーザプロパティを指定します。次に例を示します。

<requiredUserProperties properties="specified"> <specifiedProperty name="name/given"/> <specifiedProperty name="gender"/> </requiredUserProperties>

どのユーザ情報も wsrp-producer-config.xml で指定されない場合、その動作は None の値が <requiredUserProperties> で指定されている場合と同じ動作になります。

コードリスト 11-8 のコードの抜粋は、P13N タグの <profile:getProperty> を使ってポートレットの JSP ファイルでユーザプロパティを取得する方法を示しています。

ユーザプロパティ拡張の処理

WebLogic Portal または非 WebLogic Portal コンシューマが拡張 P3P ユーザプロファイル情報を送信する場合、ポートレットは、<profile:getProperty> タグから取得した List オブジェクトとしてその拡張を取得できます。コードリスト 11-9 は、電話の内線番号を含む List を抽出するコード例を示します。この例では、homeInfo/postal/extensions プロパティは、拡張 WSRP ユーザプロパティです。

コンシューマでのユーザ情報のマッピング

コンシューマは、コンシューマに存在するプロパティに、プロデューサにより要求されたユーザプロパティをマップできます。ユーザプロパティのマッピングの詳細については、「コンシューマのコンフィグレーション」を参照してください。

コンシューマのコンフィグレーション

多くの場合、プロデューサに存在するユーザプロパティセットとプロパティ名はコンシューマ側のものと一致しません。したがって、WebLogic Portal が、これらの名前を適切にマップできるようにします。この節では、コンフィグレーションファイルの使用またはプログラミングにより、プロパティセットとプロパティ名をマッピングクラスにマップする方法を説明します。

マッピングファイルの使用

wsrp-user-property-config.xml ファイルでユーザプロファイルマッピングを指定します。このファイルは、コンシューマ Web アプリケーションの WEB-INF ディレクトリに配置されます。

コードリスト 11-10 に示されているように、要素の <wsrp-user-property-map-bean> は、このコンフィグレーションファイルに表示できるトップレベルの要素です。<wsrp-user-property-map-bean> の下に入る可能性がある要素は太字で表示され、次のものが含まれます。

<user-property-map> - コンシューマに登録されているすべてのプロデューサに適用される、プロデューサからコンシューマへのマッピングを作成します。
<producer-user-property-map> - <producer-handle> 要素で示されている特定のプロデューサに関連付けられているマッピングを作成します。
<mapper-class-name> - マッピングをプログラミングにより実行するクラスを指定します。マッピングクラスの完全修飾クラス名を指定する必要があります。マッピングクラスの作成の詳細については、「マッピングクラスの使用」を参照してください。

コードリスト 11-10 に示されているように、<producer-user-property-map> 要素を使用して、プロデューサ固有のマッピングを直接またはマッピングクラスを使って作成できます。

<?xml version="1.0" encoding="UTF-8"?>
<wsrp-user-property-map-bean xmlns="http://www.bea.com/ns/portal/90/wsrp-user-property-config">

    <!-- 登録済みのすべてのプロデューサについて ldap/name を Employee/name にマップします -->
    <user-property-map>
        <producer-property-name>Employee/name</producer-property-name>
        <consumer-property>ldap/name</consumer-property>
    </user-property-map>

    <!-- 登録済みのすべてのプロデューサに適用するマッパー クラスを指定します -->
    <mapper-class-name>myClasses.MyUserPropertyMapper1</mapper-class-name>

    <!-- 特定のプロデューサについてのユーザ プロパティのマップ -->
    <producer-user-property-map>
        <producer-handle>complexProducer</producer-handle>
        <user-property-map>
            <producer-property-name>Employee/number</producer-property-name>
            <consumer-property>"xxxxxx"</consumer-property>
        </user-property-map>
    </producer-user-property-map>

    <!-- 特定のプロデューサのマッパー クラスを指定します -->
    <producer-user-property-map>
        <producer-handle>complexProducer2</producer-handle>
        <mapper-class-name>myClasses.MyUserPropertyMapper2</mapper-class-name>
    </producer-user-property-map>
</wsrp-user-property-map-bean>

<user-property-map> の <producer-property-name> サブ要素は、要求されたプロデューサプロパティの propertySet と propertyName のペアを指定し、<consumer-property> サブ要素は、コンシューマ側に存在する同等のペアを指定します。

<producer-property-name> と <consumer-property> のペアは次の形式にすることができます。

propertySetName/propertyName - プロパティセットの名前とそのプロパティセット内のプロパティの名前。次に例を示します。

<producer-property-name>propertySetName-A/propertyName-A</producer-property-name>
<consumer-property>propertySetName-B/propertyName-B</consumer-property>

propertySetName/* - アスタリスク (*) は、そのプロパティセット内のすべてのプロパティがマップされることを示します。このパターンは、コンシューマとプロデューサのマップされたプロパティセットに、同じプロパティ名が存在すると仮定します。

たとえば、次の行は、プロデューサ上の propertySetName-A 内の全プロパティをコンシューマ側の propertySetName-B にマップします。

<producer-property-name>propertySetName-A/*</producer-property-name>
<consumer-property>propertySetName-B/*</consumer-property>

propertyValue - プロデューサから定数値へプロパティ名をマップします。たとえば、次の行は、propertyName-A というプロパティを、プロデューサから、任意の文字列の定数にマップします。文字列の他に、別のタイプの定数を指定できます。詳細については、「定数のマッピング」を参照してください。

<producer-property-name>propertySetName-A/propertyName-A
</producer-property-name>
<consumer-property>"aStringValue"</consumer-property>

マッピングクラスの使用

マッピングファイルを使用して、要求したプロデューサプロパティをコンシューマプロパティにマップする他に、マッピングクラスを作成して、プログラミングによりコンシューマ側でユーザプロパティ値をマップおよび設定できます。マッピングクラスを使用するには、以下の操作を行います。

マッピングクラスの書き込み

com.bea.wsrp.consumer.userproperty.DefaultUserPropertyMapper クラスを拡張します。
getProducerProperties メソッドをオーバーライドして、作成するマッピング機能を実装します。このメソッドの詳細については、「Javadoc」を参照してください。コードリスト 11-11 内のマッパークラスの例は、ユーザ名に基づいてユーザに対する性別プロパティを設定します。

注意 : DefaultUserPropertyMapper の拡張と getProducerProperties の無効化は、必須ではありませんが、最も簡単で最良の実施例です。必要に応じて、抽象ベースクラスも拡張できます。

wsrp-user-property-config.xml ファイルでマッパークラスをコンフィグレーションします。そのためには、コードリスト 11-11 に示されているパターンをたどる wsrp-user-property-config.xml に、行を追加します。ここで producerHandle は、コンシューマ側でプロデューサを識別するユニークな名前、myClasses.MyMapperClass は、マッパークラスの完全なクラス名を表します。

コードリスト 11-11 マッパークラスの例

package com.bea.portlet.qa.wsrp.userprops;

import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

import com.bea.p13n.property.EntityPropertyCache;
import com.bea.wsrp.consumer.userproperty.DefaultUserPropertyMapper;
import com.bea.wsrp.consumer.userproperty.RequiredUserProperties;
import com.bea.wsrp.consumer.userproperty.UserProperty;

public class TestUserPropertyMapper extends DefaultUserPropertyMapper {
    private final static Set<String> MALE_NAMES = new HashSet<String>() ;
    private final static Set<String> FEMALE_NAMES = new HashSet<String>() ;
    
    static {
        final String[] maleNames = {"Nate","Nathan","Eric","Subbu","Scott"};
        MALE_NAMES.addAll(Arrays.asList(maleNames)) ;
        final String[] femaleNames = {"Mandy","Geeta","Jenn","Jen","Jenny"} ;
        FEMALE_NAMES.addAll(Arrays.asList(maleNames)) ;
    }

    /**
     * user.name.given が設定される場合は、マップによりユーザの性別が設定されます
     * @param requiredProperties  プロデューサが要求するプロパティ
     * @param map  キーがプロデューサの名前であり、
     * 値がコンシューマの名前であるマップ
     * @param profile  コンシューマでのユーザのプロファイル
     * @return  プロデューサにマップされたプロパティ
     */
    public Collection<UserProperty> getProducerProperties(
            RequiredUserProperties requiredProperties, 
            Map<String, String> map, 
            EntityPropertyCache profile) {

        final Collection<UserProperty> properties = 
        super.getProducerProperties(requiredProperties, map, profile) ;
        if (requiredProperties.isPropertyRequired("HR", "gender")) {
            final String givenName = (String) getProperty(profile, "HR", "name.given") ;
            if (MALE_NAMES.contains(givenName)) {
                addUserProperty(properties, "HR", "gender", "M") ;
            } else if (FEMALE_NAMES.contains(givenName)) {
                addUserProperty(properties, "HR", "gender", "F") ;
            }
        }
        return properties ;
    }
}

マッピングクラスのコンフィグレーション

wsrp-user-properties-config.xml ファイルでマッピングクラスを宣言する必要があります。そのためには、<mapper-class-name> 要素を使用します。この要素は、次の例に示すように、プロパティとして完全修飾クラス名を使用します。

<wsrp-user-property-map-bean> 要素または <producer-user-property-map> 要素の下に、直接この要素を配置できます。コンフィグレーションファイルの詳細については、「マッピングファイルの使用」を参照してください。

定数のマッピング

ユーザプロパティをユーザプロパティにマップするだけでなく、ユーザプロパティを定数値にマップできます。コンフィグレーションファイルまたはマッパークラスで、定数にマップできます。コードリスト 11-12 は、long というプロパティが long 型の定数にマップされている wsrp-user-properties-config.xml ファイルの一部を示しています。これは、/L 区切り記号で囲まれています。

表 11-1 定数区切り記号
型	区切り記号	例
String	`"`	`"Hello World"`
Boolean	`/B`	`/Btrue/B`
Long	/L	`/L42/L`
Double	`/D`	`/D3.14159/D`
Date	`/T`	`/T1975-09-27T14:38:11-07:00/T`

マッピングクラスを作成する場合、表 11-1 に示されている区切り記号を使用して定数を指定するか、com.bea.wsrp.consumer.userproperty.UserProperty インタフェースで定義されている定数を指定できます。このインタフェースの詳細については、「Javadoc」を参照してください。

P3P の例

この節では、この章で前述した例の一部を書き直して、WebLogic Portal ユーザ属性の代わりに P3P 属性を使用する方法を示します。この節では、次の例について説明します。

例 : P3P 属性がある portlet.xml ファイル

portlet.xml ファイルは、Java ポートレットに対する標準のデプロイメント記述子です。コードリスト 11-13 は、P3P 属性がある portlet.xml ファイルを示しています。このファイルの詳細については、「Java ポートレットのコンフィグレーション」を参照してください。

P3P 属性名は、常にプレフィックスの user で始まり、慣例により、ドット (.) 区切り文字が名前の区切り要素として使用されます (例 : user.name.given)。Java ポートレットにより使用されるすべての名前については、Java ポートレット仕様を参照してください。

<portlet-app>
...
    <user-attribute>
        <description>User Given Name</description>
        <name>user.name.given</name>
    </user-attribute>
    <user-attribute>
        <description>User Last Name</description>
        <name>user.name.family</name>
    </user-attribute>
    <user-attribute>
        <description>User eMail</description>
        <name>user.home-info.online.email</name>
    </user-attribute>
    <user-attribute>
        <description>Company Organization</description>
        <name>user.business-info.postal.organization</name>
    </user-attribute>
...

</portlet-app>

例 : Java ポートレットでの P3P ユーザ情報の取得

コードリスト 11-14 のコード例は、ユーザ情報の Map を Java ポートレットに関連付けられている JSP 内の要求から取得する方法を示しています。user.bdate などの標準 P3P ユーザプロパティ名が、ファイルで使用されています。

例 : その他のポートレットでのユーザ情報の取得

コードリスト 11-15 のコードの抜粋は、P13N タグの <profile:getProperty> を使ってポートレットの JSP ファイルで P3P プロパティを取得する方法を示しています。WebLogic Portal は定数 com.bea.wsrp.consumer.userproperty.UserProperty.P3P_PROPERTY_SET_NAME を、標準 P3P ユーザプロパティのセットであると認識します。

<%@ page import = "com.bea.wsrp.consumer.userproperty.UserProperty" %>
...
<%
    if (request.getUserPrincipal() != null) {
  %>
      <profile:getProfile profileKey="<%= request.getUserPrincipal().getName() %>"
     />
  <%
  } else { %>
      <profile:getProfile profileKey="anonymous" groupOnly="true" />
  <%
  }
  %>

  <tr>
    <td>Date</td>
    <td id="wsrp_date"><profile:getProperty propertySet=
    "<%= UserProperty.P3P_PROPERTY_SET_NAME %>" propertyName="bdate"/></td>
   
  </tr>
  <tr>
    <td>Int Code</td>
    <td id="wsrp_int_code"><profile:getProperty propertySet=
    "<%= UserProperty.P3P_PROPERTY_SET_NAME %>" propertyName=
    "businessInfo/telecom/telephone/intcode"/></td> 
  </tr>
...

連合ポータル ガイド

ユーザ プロファイルの連合