From portal-commits at lists.jboss.org Mon Mar 5 08:40:33 2007 Content-Type: multipart/mixed; boundary="===============7180173238825567235==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r6539 - docs/trunk/referenceGuide/en/modules. Date: Mon, 05 Mar 2007 08:40:33 -0500 Message-ID: --===============7180173238825567235== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: bdaw Date: 2007-03-05 08:40:33 -0500 (Mon, 05 Mar 2007) New Revision: 6539 Modified: docs/trunk/referenceGuide/en/modules/ldap.xml Log: anorther part of ldap chapter Modified: docs/trunk/referenceGuide/en/modules/ldap.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/ldap.xml 2007-03-05 13:22:46 UTC (= rev 6538) +++ docs/trunk/referenceGuide/en/modules/ldap.xml 2007-03-05 13:40:33 UTC (= rev 6539) @@ -153,33 +153,162 @@ LDAP Identity Modules TODO: + Common settings + For all modules you can set two config options: + + + jndiName - JNDI name = under which this module will be registered + + + connectionJNDIName - = JNDI name under which LDAP datasource is registered = + + + Most configuration of LDAP identity modules is done in <= emphasis>options section by adding module specific options + in "common" option-group or in other modu= le specific groups. + + + UserModule LDAPUserModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPUserModuleImpl option= s: + This is the base implementation of LDAP UserMo= dule. It supports user creation, but will retreive users and cre= ate them + in strictly specified place in LDAP tree. + To enable it in your configuration you should have: + + + + User + LDAP + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPUserModuleImpl config= uration option-groups options: - - = + common: + + + userCtxDN - = DN that will be used as context for user searches + + + uidAttributeID - attribute name under which user name is specified. Default value is "u= id" + + + passwordAttributeID - attribute name under which user password is specified. Default va= lue is "userPassword" + + + principalDNPrefix and principalDNSuffix + + + searchTimeLimit - The timeout in milliseconds for the user searches. Defaults to 10000 = (10 seconds). + + - - + userCreateAttibutes: This option-group defines a set of ldap attributes that will be set on u= ser entry creation. + Option name will be used as attribute name, and optio= n values as attribute values. This enables to fulfill LDAP schema requireme= nts. + Example configuration: + + + common + + + + + + userCreateAttibutes + + + + + + ]]> + + LDAPExtUserModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPExtUserModuleImpl opt= ions: + This module doesn't support user creation and removal + To enable it in your configuration you should have: + + + + User + LDAP + org.jboss.portal.identity.ldap.LDAPExtUserModu= leImpl + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPExtUserModuleImpl con= figuration option-groups options: - - + common: + + + userCtxDN - = DN that will be used as context for user searches + + + userSearchFilter - ldap filter to search users with. {0} will be substitute with user n= ame. Example filter can look like this: + "(uid=3D{0})". This substituion behavior comes = from the standard DirContext.search(Name, String, Object, SearchC= ontrols cons) method + + + uidAttributeID - attribute name under which user name is specified. Default value is "u= id" + + + searchTimeLimit - The timeout in milliseconds for the user searches. Defaults to 10000 = (10 seconds). + + + searchScope = - Sets the search scope to one of the strings. The default is SUBTREE_SCOPE. + + + OBJECT_SCOPE - only search the named users context. + + + ONELEVEL_SCOPE - search directly under the named users context. + + + SUBTREE_SCOPE - If the users context is not a DirContext, se= arch only the object. + If the users context is a DirCo= ntext, search the subtree rooted at the named object, including = the named object itself. + + + + - - - - + @@ -188,28 +317,94 @@ LDAPRoleModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPRoleModuleImpl option= s: + To enable it in your configuration you should have: + + + + Role + LDAP + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPRoleModuleImpl config= uration option-groups options: - - + common: + + + roleCtxDN - = DN that will be used as context for role searches. + + + ridAttributeID - attribute name under which role name is specified. Default value is "c= n". + + + roleDisplayNameAttribut= eID - attribute name under which role display name is specified.= Default value is "cn". + + + searchTimeLimit - The timeout in milliseconds for the roles searches. Defaults to 10000= (10 seconds). + + - - - - LDAPExtRoleModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPExtRoleModuleImpl opt= ions: + To enable it in your configuration you should have: + + + + Role + LDAP + org.jboss.portal.identity.ldap.LDAPExtRoleModu= leImpl + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPExtRoleModuleImpl con= figuration option-groups options: - - + common: + + + roleCtxDN - = DN that will be used as context for role searches + + + roleSearchFilter - ldap filter to search roles with. {0} will be substitute with role n= ame. Example filter can look like this: + "(cn=3D{0})". This substituion behavior comes f= rom the standard DirContext.search(Name, String, Object, SearchCo= ntrols cons) method. + + + ridAttributeID - attribute name under which role name is specified. Default value is "c= n". + + + roleDisplayNameAttribut= eID - attribute name under which role display name is specified.= Default value is "cn". + + + searchTimeLimit - The timeout in milliseconds for the roles searches. Defaults to 10000= (10 seconds). + + + searchScope = - Sets the search scope to one of the strings. The default is SUBTREE_SCOPE. + + + OBJECT_SCOPE - only search the named roles context. + + + ONELEVEL_SCOPE - search directly under the named roles context. + + + SUBTREE_SCOPE - If the roles context is not a DirContext, se= arch only the object. + If the roles context is a DirCo= ntext, search the subtree rooted at the named object, including = the named object itself. + + + + - - - - @@ -217,30 +412,71 @@ MembershipModule - LDAPStaticRoleMembershipModuleImpl + LDAPStaticGroupMembershipModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPStaticRoleMembershipM= oduleImpl options: + This module support tree shape where role entries keep i= nformation about users that are their members. + To enable it in your configuration you should have: + + + + Membership + LDAP + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPStaticGroupMembership= ModuleImpl configuration option-groups options: - - + common: + + + membershipAttributeID - LDAP attribute that defines member users ids. This will be used= to retreived users from role + entry. + + + membershipAttributeIsDN= - defines if values of attribute defined in membershi= pAttributeID are fully qualified + LDAP DNs. + + - - - - - LDAPStaticGroupMembershipModuleImpl + LDAPStaticRoleMembershipModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPStaticGroupMembership= ModuleImpl options: + This module support tree shape where user entries keep i= nformation about roles that they belong to. + To enable it in your configuration you should have: + + + + Membership + LDAP + org.jboss.portal.identity.ldap.LDAPStaticRoleM= embershipModuleImpl + + + ]]> + + + org.jboss.portal.identity.ldap.LDAPStaticRoleMembershipM= oduleImpl configuration option-groups options: - - + common: + + + membershipAttributeID - LDAP attribute that defines role ids that user belongs to. This= will be used to retreived roles + from user entry. + + + membershipAttributeIsDN= - defines if values of attribute defined in membershi= pAttributeID are fully qualified + LDAP DNs. + + - - - - @@ -250,14 +486,49 @@ LDAPUserProfileModuleImpl TODO: - org.jboss.portal.identity.ldap.LDAPUserModuleImpl option= s: + To enable it in your configuration you should have: + + + UserProfile + DELEGATING + + + + + + DBDelegateUserProfile + DB + + + + + + LDAPDelegateUserProfile + LDAP + + + ]]> + + Using such configuration you will have LDAP Membershi= pModule along with DB MembershipModule and Delegating MembershipModule + + org.jboss.portal.identity.ldap.LDAPUserModuleImpl config= uration option-groups options: - - + common: + + + profileConfigFile - file with user profile configuration. If this option is not set, an= d we use delegating UserProfileModule, + profile configuration will be obtained from it. + + - - - - @@ -265,6 +536,7 @@ LDAP server tree shapes + TODO: Supported LDAP servers --===============7180173238825567235==--