From portal-commits at lists.jboss.org Sat Mar  3 16:34:34 2007
Content-Type: multipart/mixed; boundary="===============2597329985467139266=="
MIME-Version: 1.0
From: portal-commits at lists.jboss.org
To: portal-commits at lists.jboss.org
Subject: [portal-commits] JBoss Portal SVN: r6510 -
 docs/trunk/referenceGuide/en/modules.
Date: Sat, 03 Mar 2007 16:34:34 -0500
Message-ID: <E1HNbsA-0007SF-Bu@committer01.frg.pub.inap.atl.jboss.com>

--===============2597329985467139266==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: bdaw
Date: 2007-03-03 16:34:34 -0500 (Sat, 03 Mar 2007)
New Revision: 6510

Modified:
   docs/trunk/referenceGuide/en/modules/identity.xml
Log:
update

Modified: docs/trunk/referenceGuide/en/modules/identity.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- docs/trunk/referenceGuide/en/modules/identity.xml	2007-03-03 21:03:18 U=
TC (rev 6509)
+++ docs/trunk/referenceGuide/en/modules/identity.xml	2007-03-03 21:34:34 U=
TC (rev 6510)
@@ -815,6 +815,90 @@
       </sect2>
       <sect2>
          <title>Delegating UserProfile module</title>
+         <para>Delegating UserProfile module implementation has very speci=
fic role. When we use storage mechanism like LDAP we may not be able to map=
 all
+         user properties into LDAP attributes because of schema limitation=
s. To solve this problem we use database to store such not mapped propertie=
s.
+         Delegating user profile module will recognize if property is mapp=
ed as <emphasis role=3D"bold">ldap</emphasis> or <emphasis role=3D"bold">da=
tabase</emphasis>
+         end delegate <emphasis>setProperty()/getProperty()</emphasis> met=
hod invocation to proper module implementation. This is implemented in
+         <emphasis role=3D"bold">org.jboss.portal.identity.DelegatingUserP=
rofileModuleImpl</emphasis>. If property is mapped either as
+         <emphasis role=3D"bold">ldap</emphasis> and <emphasis role=3D"bol=
d">database</emphasis> the <emphasis role=3D"bold">ldap</emphasis> mapping =
will
+            have higher priority.
+         </para>
+         <programlisting>
+            <![CDATA[
+      <module>
+         <!--type used to correctly map in IdentityContext registry-->
+         <type>UserProfile</type>
+         <implementation>DELEGATING</implementation>
+
+         <!--name of service and class for creating mbean-->
+         <service-name>portal:service=3DModule,type=3DUserProfile</service=
-name>
+         <class>org.jboss.portal.identity.DelegatingUserProfileModuleImpl<=
/class>
+         <!--set of options that are set in instantiated object-->
+         <config>
+            <option>
+               <name>jndiName</name>
+               <value>java:/portal/UserProfileModule</value>
+            </option>
+            <option>
+               <name>dbModuleJNDIName</name>
+               <value>java:/portal/DBUserProfileModule</value>
+            </option>
+            <option>
+               <name>profileConfigFile</name>
+               <value>conf/identity/profile-config.xml</value>
+            </option>
+         </config>
+      </module>
+            ]]>
+         </programlisting>
+         <para>
+            Module options are:
+            <itemizedlist>
+               <listitem>
+                  <emphasis role=3D"bold">dbModuleJNDIName</emphasis> - JN=
DI name under which database implementation of UserProfileModule is registe=
red.
+               </listitem>
+               <listitem>
+                  <emphasis role=3D"bold">ldapModuleJNDIName</emphasis> - =
JNDI name under which ldap implementation of UserProfileModule is registere=
d.
+               </listitem>
+               <listitem>
+                  <emphasis role=3D"bold">profileConfigFile</emphasis> - c=
onfiguration file for user properties.
+               </listitem>
+            </itemizedlist>
+         </para>
       </sect2>
+      <sect2>
+         <title>Database UserProfile module implementation</title>
+         <para>Because of behaviour described in previous section database=
 UserProfile module needs some special capabilities. If user is present in
+         LDAP server but property we want to store isn't mapped as LDAP at=
tribute such property need to be stored in database. But to store
+         the property user need to be synchronized from ldap into database=
 first</para>
+         <para>Class <emphasis>org.jboss.portal.identity.db.HibernateUserP=
rofileModuleImpl</emphasis> has additional synchronization features.
+         Here are the options:
+         <itemizedlist>
+            <listitem>
+               <emphasis role=3D"bold">synchronizeNonExistingUsers</emphas=
is> - when set to "true" if user on which we want to perform operation does=
n't exist it will
+               create it in database
+            </listitem>
+            <listitem>
+               <emphasis role=3D"bold">acceptOtherImplementations</emphasi=
s> - if set to "true" module will accept user objects other than
+               <emphasis>org.jboss.portal.identity.db.HibernateUserImpl</e=
mphasis>. This is needed to enable cooperation with UserModule implementati=
ons other
+               than <emphasis>org.jboss.portal.identity.db.HibernateUserMo=
duleImpl</emphasis>
+            </listitem>
+            <listitem>
+               <emphasis role=3D"bold">defaultSynchronizePassword</emphasi=
s> - if this option is set the value will be used as password for synchroni=
zed user.
+            </listitem>
+            <listitem>
+               <emphasis role=3D"bold">randomSynchronizePassword</emphasis=
> - if this option is set to "true" synchronized user will have random gene=
rated password.
+               This is mostly for the security reasons.
+            </listitem>
+            <listitem>
+               <emphasis role=3D"bold">sessionFactoryJNDIName</emphasis> -=
 JNDI name under which this user will be registered.
+            </listitem>
+            <listitem>
+               <emphasis role=3D"bold">profileConfigFile</emphasis> - file=
 with user profile configuration
+            </listitem>
+         </itemizedlist>
+         </para>
+         =

+      </sect2>
    </sect1>
 </chapter>


--===============2597329985467139266==--