From portal-commits at lists.jboss.org Sat Mar 3 11:37:50 2007 Content-Type: multipart/mixed; boundary="===============8037147926148364337==" MIME-Version: 1.0 From: portal-commits at lists.jboss.org To: portal-commits at lists.jboss.org Subject: [portal-commits] JBoss Portal SVN: r6499 - in docs/trunk/referenceGuide/en: modules and 1 other directory. Date: Sat, 03 Mar 2007 11:37:49 -0500 Message-ID: --===============8037147926148364337== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: bdaw Date: 2007-03-03 11:37:49 -0500 (Sat, 03 Mar 2007) New Revision: 6499 Modified: docs/trunk/referenceGuide/en/master.xml docs/trunk/referenceGuide/en/modules/identity.xml Log: identity docs update Modified: docs/trunk/referenceGuide/en/master.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/master.xml 2007-03-03 14:44:29 UTC (rev 64= 98) +++ docs/trunk/referenceGuide/en/master.xml 2007-03-03 16:37:49 UTC (rev 64= 99) @@ -18,6 +18,7 @@ + @@ -67,7 +68,8 @@ &themeandlayouts; &identity; &authentication; - &sso; = + &ldap; + &sso; &troubleshooting; = 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 14:44:29 U= TC (rev 6498) +++ docs/trunk/referenceGuide/en/modules/identity.xml 2007-03-03 16:37:49 U= TC (rev 6499) @@ -370,145 +370,6 @@ - How to enable LDAP usage in JBoss Portal - We'll describe here the simple steps that you'll need to enabl= e LDAP support in JBoss Portal. - For additional information you need to study more about configura= tion of identity and specific implementations of identity modules - There are two ways to achieve this: - - - In - jboss-porta.sar/META-INF/jboss-serv= ice.xml - in section: - - - - portal:service=3DHibernate - - java:/portal/IdentityServiceController - true - conf/identity/identity-config.xml - conf/identity/standardidentity-co= nfig.xml -]]> - - change - identity-config.xml - to - ldap_identity-config.xml - - - - Swap the names or content of files in - jboss-porta.sar/conf/identity/ident= ity-config.xml - and - jboss-porta.sar/conf/identity/ldap_= identity-config.xml - - - - - - After doing on of above changes you need to edit configuration fi= le that you choose to - use (identity-config.xml or ldap_identity-config.xml) and configu= re LDAP connection options in section: - - - LDAP - - - - - - -]]> - - You also need to specify options for your LDAP tree (described in= configuration documentation) like those: - - - common - - -]]> - - - Under PORTAL_SOURCES/identity/src/resourc= es/example/ you can find a sample ldif that - you can use to populate LDAP server and quickly start playing wit= h it. - - - - - Configuration of LDAP connection - - SSL - The setup is very similar to the one described in LdapLogin= Module wiki page - You need to modify your identity configuration file and add= "protocol" - - LDAP - - ... - - ... - -]]> - - Then you need to have LDAP server certificate imported into yo= ur keystore. You can use following command: - keytool -import -file ldapcert.der -keystore l= dap.truststore - - - Now you need to change the settings to use the alternative tru= ststore. That can be done in the properties-service.xml in deploy directory: - - javax.net.ssl.trustStore=3D../some/path/to/ldap.truststore - javax.net.ssl.trustStorePassword=3Dsomepw -]]> - - - - ExternalContext - Instead of configuring your own connection you can use JNDI= context federation mechanism in JBoss Application Server. Configuration of - ExternalContext is described in JBoss Applicatio= n Server documentation - When you have ExternalContext configured you can use it in = JBoss Portal by providing proper JNDI name in the configuration: - - LDAP - - - -]]> - When using "externalContextJndiName" you don't need to s= pecify any other option for this datasource - - - - Identity configuration At the beginning to understand identity configuration you need= to understand how it is designed to work in portal. Different identity services like UserModule, RoleModule and etc a= re just plain java classes that are instantiated and exposed @@ -535,7 +396,7 @@ IdentityServiceController. It = brings to life and registers all other components like UserModule, RoleModule, MembershipModule and UserProfileModu= le. IdentityServiceController is d= efined in - jboss-portal.sar/META-INF/jboss-service.xml + jboss-portal.sar/META-INF/jboss-service.xml = ]]> + By default you can find it in jboss-portal.sar/co= nf/identity/identity-config.xml Datasources This section defines datasource components. They will be= processed and instantiated before components in @@ -656,7 +518,7 @@ portal:service=3DModule,type=3DUser org.jboss.portal.identity.db.HibernateUserModuleImpl = - + User profile configuration - TODO: + UserProfileModule has additional configuration file that defin= es user properties. It is specified in configuration in: + + + UserProfile + DELEGATING + + (...) + + + + (...) + + + + + ]]> + + This means that you can configure user profile in jb= oss-portal.sar/conf/identity/profile-config.xml + + + + + + user.name.nickName + java.lang.String + read-only + mandatory + Name + The user name + + + column + jbp_uname + + + + + + user.business-info.online.email + java.lang.String + read-write + mandatory + Email + The user real email + + + column + jbp_realemail + + + mail + + + + + + portal.user.location + java.lang.String + read-write + optional + Location + The user location + + + dynamic + portal.user.location + + + + + (...) + + + ]]> + + Configuration file contains properties definition that can be ret= reived using PropertyInfo interface. + Every property that will be used in portal need to be registered = here. + Some informations provided for property have big influence = on the behaviour of UserProfileModule. For example + access-mode can made property read-only, and= value provided in type will be checked + during setProperty()/getProperty() operation= s. On the other hand tags like usage, + description or display-name have mostly informational meaning at the moment + + + name - property name. Th= is value will be used to refer to the property in UserProfileModu= le + + + type - java type of prop= erty. This type will be checked when in UserProfileModule + methods invocation. + + + access-mode - possible v= alues are read-write and read-only + + + + usage - property usage c= an be mandatory or optional. + + + + display-name - property = display name. + + + + description - descriptio= n of property. + + + + mapping - defines how pr= operty is mapped in the underlaying storage mechanism. It can be mapped in = database + either as a column or dynami= c value. It can also be mapped as ldap attr= ibute. + In current implementation column= and dynamic mappings have the same effect, as databas= e mappings are defined + in hibernate configuration. + Property can have both ldap and = database mappings. In such situation when LDAP support= is enabled ldap mapping will take precedense. = + Also even when using ldap some properties will be mapped to= ldap and some to database. Its because LDAP schema doesn't support all att= ributes proper + to for portal properties. To solve this we have DelegatingUserProfileModuleImpl that will delegate = method invocation to + ldap or database = related UserProfile module. When LDAP support is enabled and + property need to be stored in database user will be synchro= nized into database when needed. This behaviour can be configured. + + + + Identity modules implementations @@ -798,5 +783,5 @@ Possible configuration scenarios with LDAP and RDBMS TODO: - = + --===============8037147926148364337==--