[portal-commits] JBoss Portal SVN: r6515 - docs/trunk/referenceGuide/en/modules.

Author: bdaw Date: 2007-03-03 18:14:55 -0500 (Sat, 03 Mar 2007) New Revision: 6515 Modified: docs/trunk/referenceGuide/en/modules/identity.xml docs/trunk/referenceGuide/en/modules/ldap.xml Log: update Modified: docs/trunk/referenceGuide/en/modules/identity.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/identity.xml 2007-03-03 22:33:19 UTC (rev 6514) +++ docs/trunk/referenceGuide/en/modules/identity.xml 2007-03-03 23:14:55 UTC (rev 6515) @@ -815,7 +815,7 @@ </sect2> <sect2> <title>Delegating UserProfile module</title> - <para>Delegating UserProfile module implementation has very specific role. When we use storage mechanism like LDAP we may not be able to map all + <para>Delegating UserProfileModule implementation has very specific role. When we use storage mechanism like LDAP we may not be able to map all user properties into LDAP attributes because of schema limitations. To solve this problem we use database to store such not mapped properties. Delegating user profile module will recognize if property is mapped as <emphasis role="bold">ldap</emphasis> or <emphasis role="bold">database</emphasis> end delegate <emphasis>setProperty()/getProperty()</emphasis> method invocation to proper module implementation. This is implemented in @@ -868,7 +868,7 @@ </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 + <para>Because of behaviour described in previous section database UserProfileModule needs some special capabilities. If user is present in LDAP server but property we want to store isn't mapped as LDAP attribute 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.HibernateUserProfileModuleImpl</emphasis> has additional synchronization features. @@ -876,25 +876,26 @@ <itemizedlist> <listitem> <emphasis role="bold">synchronizeNonExistingUsers</emphasis> - when set to "true" if user on which we want to perform operation doesn't exist it will - create it in database + create it in database. Default is "true". </listitem> <listitem> <emphasis role="bold">acceptOtherImplementations</emphasis> - if set to "true" module will accept user objects other than <emphasis>org.jboss.portal.identity.db.HibernateUserImpl</emphasis>. This is needed to enable cooperation with UserModule implementations other - than <emphasis>org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis> + than <emphasis>org.jboss.portal.identity.db.HibernateUserModuleImpl</emphasis>. Default is "true". </listitem> <listitem> - <emphasis role="bold">defaultSynchronizePassword</emphasis> - if this option is set the value will be used as password for synchronized user. + <emphasis role="bold">defaultSynchronizePassword</emphasis> - if this option is set, the value will be used as a password for synchronized user. </listitem> <listitem> <emphasis role="bold">randomSynchronizePassword</emphasis> - if this option is set to "true" synchronized user will have random generated password. - This is mostly for the security reasons. + This is mostly used for the security reasons. Default is "false". </listitem> <listitem> <emphasis role="bold">sessionFactoryJNDIName</emphasis> - JNDI name under which this user will be registered. </listitem> <listitem> - <emphasis role="bold">profileConfigFile</emphasis> - file with user profile configuration + <emphasis role="bold">profileConfigFile</emphasis> - file with user profile configuration. If this option is not set, and we use delegating UserProfileModule, + profile configuration will be obtained from it. </listitem> </itemizedlist> </para> Modified: docs/trunk/referenceGuide/en/modules/ldap.xml =================================================================== --- docs/trunk/referenceGuide/en/modules/ldap.xml 2007-03-03 22:33:19 UTC (rev 6514) +++ docs/trunk/referenceGuide/en/modules/ldap.xml 2007-03-03 23:14:55 UTC (rev 6515) @@ -152,10 +152,122 @@ <sect1 id="ldap.ldap_identity_modules"> <title>LDAP Identity Modules</title> <para>TODO:</para> + <sect2> + <title>UserModule</title> + <sect3> + <title>LDAPUserModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPUserModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + <sect3> + <title>LDAPExtUserModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPExtUserModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + </sect2> + <sect2> + <title>RoleModule</title> + <sect3> + <title>LDAPRoleModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPRoleModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + <sect3> + <title>LDAPExtRoleModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPExtRoleModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + </sect2> + <sect2> + <title>MembershipModule</title> + <sect3> + <title>LDAPStaticRoleMembershipModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPStaticRoleMembershipModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + <sect3> + <title>LDAPStaticGroupMembershipModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPStaticGroupMembershipModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + </sect2> + <sect2> + <title>UserProfileModule</title> + <sect3> + <title>LDAPUserProfileModuleImpl</title> + <para>TODO:</para> + <para>org.jboss.portal.identity.ldap.LDAPUserModuleImpl options: + <itemizedlist> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + <listitem> + <emphasis role="bold"></emphasis> - + </listitem> + </itemizedlist> + </para> + </sect3> + </sect2> </sect1> <sect1> - <title>Place holder 3</title> + <title>LDAP server tree shapes</title> + </sect1> + <sect1> + <title>Supported LDAP servers</title> <para>TODO:</para> </sect1> - </chapter>