Author: smumford Date: 2011-11-04 02:31:04 -0400 (Fri, 04 Nov 2011) New Revision: 7971 Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default7.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_statistics/default88.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/Authentication_Identity/configuration.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml Log: GateIn revisions 7960, 7821, 7889 Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default7.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default7.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_Foundations/default7.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="UTF-8"?> <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd - http://www.exoplaform.org/xml/ns/kernel_1_0.xsd" - xmlns="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd"> + xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd + http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" + xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> <external-component-plugins> <!-- The full qualified name of the PortalContainerConfig --> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_statistics/default88.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_statistics/default88.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/Advanced_Development_JCR_statistics/default88.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,5 +1,5 @@ -<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd http://www.exoplaform.org/xml/ns/kernel_1_0.xsd" - xmlns="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd"> +<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" + xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> <component> <type>org.exoplatform.services.jcr.statistics.JCRAPIAspectConfig</type> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/Authentication_Identity/configuration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/Authentication_Identity/configuration.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/Authentication_Identity/configuration.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" -xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd http://www.exoplaform.org/xml/ns/kernel_1_0.xsd" -xmlns="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd"> +xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd http://www.exoplaform.org/xml/ns/kernel_1_2.xsd" +xmlns="http://www.exoplaform.org/xml/ns/kernel_1_2.xsd"> <component> <key>org.example.codec.ExampleCodec</key> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,7 +1,7 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <gadgets xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gadgets_1_0" + xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_2 http://www.gatein.org/xml/ns/gadgets_1_0" xmlns="http://www.gatein.org/xml/ns/gadgets_1_0"> <gadget name="Todo"> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <node-navigation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0" - xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_0"> + xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_2 http://www.gatein.org/xml/ns/gatein_objects_1_2" + xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_2"> <priority>1</priority> <page-nodes> <node> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <page-set xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0" - xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_0"> + xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_2 http://www.gatein.org/xml/ns/gatein_objects_1_2" + xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_2"> <page> <name>homepage</name> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,8 +1,8 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <portal-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_0 http://www.gatein.org/xml/ns/gatein_objects_1_0" - xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_0"> + xsi:schemaLocation="http://www.gatein.org/xml/ns/gatein_objects_1_2 http://www.gatein.org/xml/ns/gatein_objects_1_2" + xmlns="http://www.gatein.org/xml/ns/gatein_objects_1_2"> <portal-name>classic</portal-name> <locale>en</locale> <access-permissions>Everyone</access-permissions> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,327 +1,392 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide-PicketLink_IDM_integration"> - <title>PicketLink IDM integration</title> - <para> - JBoss Enterprise Portal Platform uses the <literal>PicketLink IDM</literal> component to store necessary identity information about users, groups and memberships. While legacy interfaces are still used (<literal>org.exoplatform.services.organization</literal>) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework. - </para> - <para> - This section does not provide information about <literal>PicketLink IDM</literal> and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information. - </para> - <note> - <para> - It is important to fully understand the concepts behind this framework design before changing the default configuration. - </para> - </note> - <para> - The identity models represented in the <literal>org.exoplatform.services.organization</literal> interfaces and the one used in <emphasis role="bold">PicketLink IDM</emphasis> have some major differences. - </para> - <para> - For example; <literal>PicketLink IDM</literal> provides greater abstraction. It is possible for groups in the <emphasis role="bold">IDM</emphasis> framework to form memberships with many parents (which requires recursive ID translation), while the <literal>org.exoplatform.services.organization</literal> model allows only pure tree-like membership structures. - </para> - <para> - Additionally, <literal>org.exoplatform.services.organization</literal> <emphasis>membership</emphasis> concept needs to be translated into the IDM <emphasis>Role</emphasis> concept. Therefore <literal>PicketLink IDM</literal> model is used in a limited way. All these translations are applied by the integration layer. - </para> - <section id="sect-Reference_Guide-PicketLink_IDM_integration-Configuration_files"> - <title>Configuration files</title> - <para> - The main configuration file is <filename>02portal.war/WEB-INF/conf/organization/idm-configuration.xml</filename>: - </para> - <programlistingco> - <areaspec> - <area coords="6 90" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMServiceImpl" /> - <area coords="22 80" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMOrganizationServiceImpl" /> - </areaspec> - +<section id="sect-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration"> + <title>PicketLink IDM integration</title> + <para> + JBoss Enterprise Portal Platform uses the <literal>PicketLink IDM</literal> component to store necessary identity information about users, groups and memberships. While legacy interfaces are still used (<literal>org.exoplatform.services.organization</literal>) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework. + </para> + <para> + This section does not provide information about <literal>PicketLink IDM</literal> and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information. + </para> + <note> + <para> + It is important to fully understand the concepts behind this framework design before changing the default configuration. + </para> + + </note> + <para> + The identity models represented in the <literal>org.exoplatform.services.organization</literal> interfaces and the one used in <emphasis role="bold">PicketLink IDM</emphasis> have some major differences. + </para> + <para> + For example; <literal>PicketLink IDM</literal> provides greater abstraction. It is possible for groups in the <emphasis role="bold">IDM</emphasis> framework to form memberships with many parents (which requires recursive ID translation), while the <literal>org.exoplatform.services.organization</literal> model allows only pure tree-like membership structures. + </para> + <para> + Additionally, <literal>org.exoplatform.services.organization</literal> <emphasis>membership</emphasis> concept needs to be translated into the IDM <emphasis>Role</emphasis> concept. Therefore <literal>PicketLink IDM</literal> model is used in a limited way. All these translations are applied by the integration layer. + </para> + <section id="sect-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files"> + <title>Configuration Files</title> + <para> + The main configuration file is <filename>02portal.war/WEB-INF/conf/organization/idm-configuration.xml</filename>: + </para> + <programlistingco> + <areaspec> + <area coords="6 90" id="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl" /> + <area coords="22 80" id="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl" /> + + </areaspec> + <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_BackendConfiguration/default96.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMServiceImpl"> - <para> - The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMServiceImpl</emphasis> service has the following options: - </para> - <variablelist> - <varlistentry> - <term>config</term> - <listitem> - <para> - <parameter>(value-param)</parameter> - </para> - <para> - The PicketLink IDM configuration file. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hibernate.properties</term> - <listitem> - <para> - <parameter>(properties-param)</parameter> - </para> - <para> - A list of hibernate properties used to create SessionFactory that will be injected to JBoss Identity IDM configuration registry. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hibernate.annotations</term> - <listitem> - <para> - <parameter>(values-param)</parameter> - </para> - <para> - A list of annotated classes that will be added to Hibernate configuration. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>hibernate.mappings</term> - <listitem> - <para> - <parameter>(values-param)</parameter> - </para> - <para> - A list of xml files that will be added to hibernate configuration as mapping files. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>jndiName</term> - <listitem> - <para> - <parameter>(value-param)</parameter> - </para> - <para> - If the <literal>config</literal> parameter is not provided, this parameter will be used to perform JNDI lookup for IdentitySessionFactory. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>portalRealm</term> - <listitem> - <para> - <parameter>(value-param)</parameter> - </para> - <para> - The realm name that should be used to obtain proper IdentitySession. The default is <literal>PortalRealm</literal>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>apiCacheConfig</term> - <term>storeCacheConfig</term> - <listitem> - <para> - <parameter>(value-param)</parameter> - </para> - <para> - These options reference the JBoss cache configuration used for Picketlink. - </para> - </listitem> - </varlistentry> - </variablelist> - </callout> - <callout arearefs="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMOrganizationServiceImpl"> - <para> - The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis> key is a main entrypoint implementing <emphasis role="bold">org.exoplatform.services.organization.OrganizationService</emphasis> and is dependent on <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMService</emphasis> - </para> - <para> - The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis> service has the following options defined as fields of <parameter>object-param</parameter> of type <emphasis role="bold">org.exoplatform.services.organization.idm.Config</emphasis>: - </para> - <variablelist> - <varlistentry> - <term>defaultGroupType</term> - <listitem> - <para> - The name of the PicketLink IDM GroupType that will be used to store groups. The default is '<literal>GTN_GROUP_TYPE</literal>'. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>rootGroupName</term> - <listitem> - <para> - The name of the PicketLink IDM Group that will be used as a root parent. The default is '<literal>GTN_ROOT_GROUP</literal>' - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>passwordAsAttribute</term> - <listitem> - <para> - This parameter specifies if a password should be stored using PicketLink IDM Credential object or as a plain attribute. The default is <emphasis role="bold">false</emphasis>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>useParentIdAsGroupType</term> - <listitem> - <para> - This parameter stores the parent ID path as a group type in PicketLink IDM for any IDs not mapped with a specific type in '<literal>groupTypeMappings</literal>'. If this option is set to <emphasis>false</emphasis>, and no mappings are provided under '<literal>groupTypeMappings</literal>', then only one group with the given name can exist in the JBoss Enterprise Portal Platform group tree. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>pathSeparator</term> - <listitem> - <para> - When '<literal>userParentIdAsGroupType</literal>' is set to <emphasis>true</emphasis>, this value will be used to replace all &#34;/&#34; characters in IDs. The &#34;/&#34; character is not allowed to be used in group type name in PicketLink IDM. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>associationMembershipType</term> - <listitem> - <para> - If this option is used, then each Membership, created with MembershipType that is equal to the value specified here, will be stored in PicketLink IDM as simple Group-User association. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>groupTypeMappings</term> - <listitem> - <para> - This parameter maps groups added with JBoss Enterprise Portal Platform API as children of a given group ID, and stores them with a given group type name in PicketLink IDM. - </para> - <para> - If the parent ID ends with &#34;/*&#34;, then all child groups will have the mapped group type. Otherwise, only direct (first level) children will use this type. - </para> - <para> - This can be leveraged by LDAP if LDAP DN is configured in PicketLink IDM to only store a specific group type. This will then store the given branch in JBoss Enterprise Portal Platform group tree, while all other groups will remain in the database. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>forceMembershipOfMappedTypes</term> - <listitem> - <para> - Groups stored in PicketLink IDM with a type mapped in '<literal>groupTypeMappings</literal>' will automatically be members under the mapped parent. Group relationships linked by PicketLink IDM group association will not be necessary. - </para> - <para> - This parameter can be set to <emphasis>false</emphasis> if all groups are added via JBoss Enterprise Portal Platform APIs. This may be useful with LDAP configuration as, when set to true, it will make every entry added to LDAP appear in JBoss Enterprise Portal Platform. This, however, is not true for entries added via JBoss Enterprise Portal Platform management UI. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>ignoreMappedMembershipType</term> - <listitem> - <para> - If &#34;<literal>associationMembershipType</literal>&#34; option is used, and this option is set to <emphasis>true</emphasis>, then Membership with MembershipType configured to be stored as PicketLink IDM association will not be stored as PicketLink IDM Role. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term>useJTA</term> - <listitem> - <para> - This is a boolean option which determines whether JTA (Java Transaction API) will be used in Picketlink IDM. - </para> - </listitem> - </varlistentry> - </variablelist> - <para> - Additionally, <literal>JBossIDMOrganizationServiceImpl</literal> uses those defaults to perform identity management operations - </para> - <itemizedlist> - <listitem> - <para> - JBoss Enterprise Portal Platform User interface properties fields are persistent in JBoss Identity IDM using the attributes names: - </para> - <itemizedlist> - <listitem> - <para> - <parameter>firstName</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>lastName</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>email</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>createdDate</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>lastLoginTime</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>organizationId</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>password</parameter> (if password is configured to be stored as attribute) - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - JBoss Enterprise Portal Platform Group interface properties fields are persistent in JBoss Identity IDM using the attributes names: - </para> - <itemizedlist> - <listitem> - <para> - <parameter>label</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>description</parameter> - </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para> - JBoss Enterprise Portal Platform <literal>MembershipType</literal> interface properties fields are persistent in JBoss Identity IDM using those <literal>RoleType</literal> properties: - </para> - <itemizedlist> - <listitem> - <para> - <parameter>description</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>owner</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>create_date</parameter> - </para> - </listitem> - <listitem> - <para> - <parameter>modified_date</parameter> - </para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - </callout> - </calloutlist> - </programlistingco> - - <para> - The <emphasis role="bold">PicketLink IDM</emphasis> configuration file is shown below. To understand all the options it contains, please refer to the PicketLink IDM Reference Guide - </para> - + <calloutlist> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMServiceImpl"> + <para> + The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMServiceImpl</emphasis> service has the following options: + </para> + <variablelist> + <varlistentry> + <term>config</term> + <listitem> + <para> + <parameter>(value-param)</parameter> + </para> + <para> + The PicketLink IDM configuration file. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>hibernate.properties</term> + <listitem> + <para> + <parameter>(properties-param)</parameter> + </para> + <para> + A list of hibernate properties used to create SessionFactory that will be injected to JBoss Identity IDM configuration registry. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>hibernate.annotations</term> + <listitem> + <para> + <parameter>(values-param)</parameter> + </para> + <para> + A list of annotated classes that will be added to Hibernate configuration. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>hibernate.mappings</term> + <listitem> + <para> + <parameter>(values-param)</parameter> + </para> + <para> + A list of xml files that will be added to hibernate configuration as mapping files. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>jndiName</term> + <listitem> + <para> + <parameter>(value-param)</parameter> + </para> + <para> + If the <literal>config</literal> parameter is not provided, this parameter will be used to perform JNDI lookup for IdentitySessionFactory. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>portalRealm</term> + <listitem> + <para> + <parameter>(value-param)</parameter> + </para> + <para> + The realm name that should be used to obtain proper IdentitySession. The default is <literal>PortalRealm</literal>. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>apiCacheConfig</term> + <term>storeCacheConfig</term> + <listitem> + <para> + <parameter>(value-param)</parameter> + </para> + <para> + These options reference the JBoss cache configuration used for Picketlink. + </para> + + </listitem> + + </varlistentry> + + </variablelist> + + </callout> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-PicketLink_IDM_integration-Configuration_Files-JBossIDMOrganizationServiceImpl"> + <para> + The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis> key is a main entrypoint implementing <emphasis role="bold">org.exoplatform.services.organization.OrganizationService</emphasis> and is dependent on <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMService</emphasis> + </para> + <para> + The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis> service has the following options defined as fields of <parameter>object-param</parameter> of type <emphasis role="bold">org.exoplatform.services.organization.idm.Config</emphasis>: + </para> + <variablelist> + <varlistentry> + <term>defaultGroupType</term> + <listitem> + <para> + The name of the PicketLink IDM GroupType that will be used to store groups. The default is '<literal>GTN_GROUP_TYPE</literal>'. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>rootGroupName</term> + <listitem> + <para> + The name of the PicketLink IDM Group that will be used as a root parent. The default is '<literal>GTN_ROOT_GROUP</literal>' + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>passwordAsAttribute</term> + <listitem> + <para> + This parameter specifies if a password should be stored using PicketLink IDM Credential object or as a plain attribute. The default is <emphasis role="bold">false</emphasis>. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>useParentIdAsGroupType</term> + <listitem> + <para> + This parameter stores the parent ID path as a group type in PicketLink IDM for any IDs not mapped with a specific type in '<literal>groupTypeMappings</literal>'. If this option is set to <emphasis>false</emphasis>, and no mappings are provided under '<literal>groupTypeMappings</literal>', then only one group with the given name can exist in the JBoss Enterprise Portal Platform group tree. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>pathSeparator</term> + <listitem> + <para> + When '<literal>userParentIdAsGroupType</literal>' is set to <emphasis>true</emphasis>, this value will be used to replace all "/" characters in IDs. The "/" character is not allowed to be used in group type name in PicketLink IDM. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>associationMembershipType</term> + <listitem> + <para> + If this option is used, then each Membership, created with MembershipType that is equal to the value specified here, will be stored in PicketLink IDM as simple Group-User association. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>groupTypeMappings</term> + <listitem> + <para> + This parameter maps groups added with JBoss Enterprise Portal Platform API as children of a given group ID, and stores them with a given group type name in PicketLink IDM. + </para> + <para> + If the parent ID ends with "/*", then all child groups will have the mapped group type. Otherwise, only direct (first level) children will use this type. + </para> + <para> + This can be leveraged by LDAP if LDAP DN is configured in PicketLink IDM to only store a specific group type. This will then store the given branch in JBoss Enterprise Portal Platform group tree, while all other groups will remain in the database. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>forceMembershipOfMappedTypes</term> + <listitem> + <para> + Groups stored in PicketLink IDM with a type mapped in '<literal>groupTypeMappings</literal>' will automatically be members under the mapped parent. Group relationships linked by PicketLink IDM group association will not be necessary. + </para> + <para> + This parameter can be set to <emphasis>false</emphasis> if all groups are added via JBoss Enterprise Portal Platform APIs. This may be useful with LDAP configuration as, when set to true, it will make every entry added to LDAP appear in JBoss Enterprise Portal Platform. This, however, is not true for entries added via JBoss Enterprise Portal Platform management UI. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>ignoreMappedMembershipType</term> + <listitem> + <para> + If "<literal>associationMembershipType</literal>" option is used, and this option is set to <emphasis>true</emphasis>, then Membership with MembershipType configured to be stored as PicketLink IDM association will not be stored as PicketLink IDM Role. + </para> + + </listitem> + + </varlistentry> + <varlistentry> + <term>useJTA</term> + <listitem> + <para> + This is a boolean option which determines whether JTA (Java Transaction API) will be used in Picketlink IDM. + </para> + + </listitem> + + </varlistentry> + + </variablelist> + <para> + Additionally, <literal>JBossIDMOrganizationServiceImpl</literal> uses those defaults to perform identity management operations + </para> + <itemizedlist> + <listitem> + <para> + JBoss Enterprise Portal Platform User interface properties fields are persistent in JBoss Identity IDM using the attributes names: + </para> + <itemizedlist> + <listitem> + <para> + <parameter>firstName</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>lastName</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>email</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>createdDate</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>lastLoginTime</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>organizationId</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>password</parameter> (if password is configured to be stored as attribute) + </para> + + </listitem> + + </itemizedlist> + + </listitem> + <listitem> + <para> + JBoss Enterprise Portal Platform Group interface properties fields are persistent in JBoss Identity IDM using the attributes names: + </para> + <itemizedlist> + <listitem> + <para> + <parameter>label</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>description</parameter> + </para> + + </listitem> + + </itemizedlist> + + </listitem> + <listitem> + <para> + JBoss Enterprise Portal Platform <literal>MembershipType</literal> interface properties fields are persistent in JBoss Identity IDM using those <literal>RoleType</literal> properties: + </para> + <itemizedlist> + <listitem> + <para> + <parameter>description</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>owner</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>create_date</parameter> + </para> + + </listitem> + <listitem> + <para> + <parameter>modified_date</parameter> + </para> + + </listitem> + + </itemizedlist> + + </listitem> + + </itemizedlist> + + </callout> + + </calloutlist> + + </programlistingco> + + <para> + The <emphasis role="bold">PicketLink IDM</emphasis> configuration file is shown below. To understand all the options it contains, please refer to the PicketLink IDM Reference Guide + </para> + <programlisting language="XML" role="XML"><xi:include href="../../extras/Authentication_Identity_BackendConfiguration/default97.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </section> + </section> + + </section> + Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,63 +1,112 @@ -<?xml version='1.0' encoding='utf-8'?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" -[ -<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide-Advanced_Gadget_Administration"> - <title>Advanced Gadget Administration</title> - <section id="sect-Reference_Guide-Advanced_Gadget_Administration-Virtual_servers_for_gadget_rendering"> - <title>Virtual servers for gadget rendering</title> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration"> + <title>Advanced Gadget Administration</title> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration-Virtual_servers_for_gadget_rendering"> + <title>Virtual servers for gadget rendering</title> + <para> JBoss Enterprise Portal Platform recommends using two virtual hosts for security. If the gadget is running on a different domain than the container, it is unable to interfere with the portal by modifying code or cookies. </para> + <para> An example would be hosting the portal from <emphasis role="bold">http://www.sample.com</emphasis> and the gadgets from <emphasis role="bold">http://www.samplemodules.com</emphasis>. </para> + <para> To do this, configure the <emphasis>gadgets.hostName</emphasis>parameter in the <filename>server/<replaceable>PROFILE</replaceable>/deploy/gatein.ear/02portal.war/WEB-INF/conf/portal/application-registry-configuration.xml</filename>file. The value is the <emphasis role="bold">path/to/gadgetServer</emphasis>in <literal>GadgetRegistryService.xml</literal>: </para> <programlisting language="XML" role="XML"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default139.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> </programlisting> - <para> It is also possible to have multiple rendering servers. This helps to balance the rendering load across multiple servers. </para> + <para> - When deploying on the same server ensure the gadget initiates before anything that calls it (for example; the webapp <literal>eXoGadgets</literal>which uses <literal>org.exoplatform.application.gadget.GadgetRegister</literal>). + When deploying on the same server, ensure the gadget initiates before anything that calls it (for example; the webapp <literal>eXoGadgets</literal>which uses <literal>org.exoplatform.application.gadget.GadgetRegister</literal>). </para> - </section> - <section id="sect-Reference_Guide-Advanced_Gadget_Administration-Configuration"> - <title>Configuration</title> - <section id="sect-Reference_Guide-Configuration-Security_key"> - <title>Security key</title> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Advanced_Gadget_Administration-Configuration"> + <title>Configuration</title> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Security_key"> + <title>Security key</title> + <para> - A specific file called <emphasis role="bold">key.txt</emphasis>has to be generated for each installation of JBoss Enterprise Portal Platform to be secure. This file contains a secret key used to encrypt the security token used for authenticating the user. + In JBoss Enterprise Portal Platform, the gadget container uses three security files for authentication and authorization of gadgets: </para> + + <itemizedlist> + <listitem> + <para> + <filename>key.txt</filename> + </para> + </listitem> + + <listitem> + <para> + <filename>oauthkey.pem</filename> + </para> + </listitem> + + <listitem> + <para> + <filename>oauthkey_pub.pem</filename> + </para> + </listitem> + </itemizedlist> + <para> - In Linux systems this file can be generated with: + By default, they are located in the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/conf/gatein/gadgets</filename> directory are configured by system variables in the <filename><replaceable>&lt;JBOSS_HOME&gt;</replaceable>/server/<replaceable>&lt;JBOSS_HOME&gt;</replaceable>/conf/gatein/configuration.properties</filename> file. </para> -<programlisting language="XML" role="XML"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default140.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <para> + If you use other security files you must change the variables below to reference them: + </para> +<programlisting> +gatein.gadgets.securitytokenkeyfile=${gatein.conf.dir}/gadgets/key.txt +gatein.gadgets.signingkeyfile=${gatein.conf.dir}/gadgets/oauthkey.pem </programlisting> - <para> - This <filename>key.txt</filename>file should be placed in the <filename>/conf/gatein/gadgets</filename>folder of your profile. - </para> - </section> - <section id="sect-Reference_Guide-Configuration-Gadget_proxy_and_concat_configuration"> - <title>Gadget proxy and concat configuration</title> <para> + The <filename>key.txt</filename> file contains a secret key used to encrypt the security token used for user authentication. + </para> + <para> + When starting JBoss Enterprise Portal Platform, the <filename>key.txt</filename> file is read (as designated by the path set at <parameter>gatein.gadgets.securitytokenkeyfile</parameter>). + </para> + <para> + If the <filename>key.txt</filename> file is not found, JBoss Enterprise Portal Platform automatically generates a new file and saves it to the <parameter>gatein.gadgets.securitytokenkeyfile</parameter> path. + </para> + + <para> + The <filename>oauthkey.pem</filename> and <filename>oauthkey_pub.pem</filename> files are a key pair of RSA cryptography standard. + </para> + <para> + The <filename>oauthkey.pem</filename> file is known as a private key while <filename>oauthkey_pub.pem</filename> is a public key. They are the default keys of the gadget container which OAuth gadgets will use to authorize with external service providers. + </para> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Gadget_proxy_and_concat_configuration"> + <title>Gadget proxy and concat configuration</title> + + <para> These servers have to be on the same domain as the gadget server. You can configure the container in <filename><replaceable>JBOSS_HOME</replaceable>/server/<replaceable>&lt;PROFILE&gt;</replaceable>/deploy/gatein.ear/eXoGadgetServer.war:/WEB-INF/classes/containers/default/container.js</filename>. </para> <programlisting language="Java" role="Java"><xi:include href="../../extras/Gadget_Development_SetupGadgetServer/default141.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> </programlisting> - </section> - <section id="sect-Reference_Guide-Configuration-Proxy"> - <title>Proxy</title> + </section> + + <section id="sect-Reference_Guide_eXo_JCR_1.14-Configuration-Proxy"> + <title>Proxy</title> + <para> To allow external gadgets when the server is behind a proxy, add the following code to the beginning of the JVM: </para> <programlisting language="Java" role="Java">-Dhttp.proxyHost=proxyhostURL -Dhttp.proxyPort=proxyPortNumber -Dhttp.proxyUser=someUserName -Dhttp.proxyPassword=somePassword</programlisting> + </section> </section> </section> -</section> Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml =================================================================== --- epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-11-03 23:45:55 UTC (rev 7970) +++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalNavigationConfiguration.xml 2011-11-04 06:31:04 UTC (rev 7971) @@ -1,272 +1,298 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "Reference_Guide_eXo_JCR_1.14.ent"> %BOOK_ENTITIES; ]> -<chapter id="chap-Reference_Guide-Portal_Navigation_Configuration"> +<chapter id="chap-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration"> <title>Portal Navigation Configuration</title> - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Overview"> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview"> <title>Overview</title> - <para> + <para> There are three types of navigation available to portal users: </para> - <itemizedlist> + <itemizedlist> <listitem> <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" /> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation" /> </para> + </listitem> - <listitem> + <listitem> <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation" /> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Group_Navigation" /> </para> + </listitem> - <listitem> + <listitem> <para> - <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation" /> + <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-User_Navigation" /> </para> + </listitem> + </itemizedlist> - <para> + <para> These navigations are configured using the standard XML syntax in the file; <filename>02portal.war:/WEB-INF/conf/portal/portal-configuration.xml</filename>. </para> - + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/default144.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <para> This XML configuration defines where in the portal's <literal>WAR</literal> to look for configuration settings, and which portals, groups, and user specific views to include in <emphasis>portal/group/user</emphasis> navigation. </para> - <para> + <para> The first time the portal is launched those files will be used to create an initial navigation. That information will then be stored in the JCR content repository and can be modified and managed from the portal UI. </para> - <!--DOC NOTE: Added based on Gatein revision 6987--> - <para> + <!-- DOC NOTE: Added based on Gatein revision 6987 --> <para> Each portal, groups and users navigation is indicated by a configuration paragraph, for example: </para> -<programlistingco> + <programlistingco> <areaspec> - <area coords="5" id="area-Reference_Guide.Portalconf.predifinedOwner" /> - <area coords="10" id="area-Reference_Guide.Portalconf.ownerType" /> - <area coords="13" id="area-Reference_Guide.Portalconf.templateLocation" /> - <area coords="16" id="area-Reference_Guide.Portalconf.importMode" /> + <area coords="5" id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-predifinedOwner" /> + <area coords="10" id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-ownerType" /> + <area coords="13" id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-templateLocation" /> + <area coords="16" id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-importMode" /> + </areaspec> -<programlisting language="XML" role="XML"><![CDATA[<object-param> - <name>portal.configuration</name> - <description>description</description> - <object type="org.exoplatform.portal.config.NewPortalConfig"> - <field name="predefinedOwner"> - <collection type="java.util.HashSet"> - <value><string>classic</string></value> - </collection> - </field> - <field name="ownerType"> - <string>portal</string> - </field> - <field name="templateLocation"> - <string>war:/conf/portal/</string> - </field> - <field name="importMode"> - <string>conserve</string> - </field> - </object> -</object-param>]]> + +<programlisting language="XML" role="XML">&lt;object-param&gt; + &lt;name&gt;portal.configuration&lt;/name&gt; + &lt;description&gt;description&lt;/description&gt; + &lt;object type="org.exoplatform.portal.config.NewPortalConfig"&gt; + &lt;field name="predefinedOwner"&gt; + &lt;collection type="java.util.HashSet"&gt; + &lt;value&gt;&lt;string&gt;classic&lt;/string&gt;&lt;/value&gt; + &lt;/collection&gt; + &lt;/field&gt; + &lt;field name="ownerType"&gt; + &lt;string&gt;portal&lt;/string&gt; + &lt;/field&gt; + &lt;field name="templateLocation"&gt; + &lt;string&gt;war:/conf/portal/&lt;/string&gt; + &lt;/field&gt; + &lt;field name="importMode"&gt; + &lt;string&gt;conserve&lt;/string&gt; + &lt;/field&gt; + &lt;/object&gt; +&lt;/object-param&gt; </programlisting> -</programlistingco> -<calloutlist> - <callout arearefs="area-Reference_Guide.Portalconf.predifinedOwner"> - <para> - <parameter>predefinedOwner</parameter> defines the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. - </para> - </callout> - <callout arearefs="area-Reference_Guide.Portalconf.ownerType"> - <para> - <parameter>ownerType</parameter> define the type of portal navigation. It may be a portal, group or user - </para> - </callout> - <callout arearefs="area-Reference_Guide.Portalconf.templateLocation"> - <para> - <parameter>templateLocation</parameter> the classpath where contains all portal configuration files - </para> - </callout> - <callout arearefs="area-Reference_Guide.Portalconf.importMode"> - <para> - <parameter>importMode</parameter> The mode for navigation import. There are 4 types of import mode: - </para> - <itemizedlist> - <listitem> + </programlistingco> + + <calloutlist> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-predifinedOwner"> + <para> + <parameter>predefinedOwner</parameter> defines the navigation owner, portal will look for the configuration files in folder with this name, if there is no suitable folder, a default portal will be created with name is this value. + </para> + + </callout> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-ownerType"> + <para> + <parameter>ownerType</parameter> define the type of portal navigation. It may be a portal, group or user + </para> + + </callout> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-templateLocation"> + <para> + <parameter>templateLocation</parameter> the classpath where contains all portal configuration files + </para> + + </callout> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Overview-importMode"> + <para> + <parameter>importMode</parameter> The mode for navigation import. There are 4 types of import mode: + </para> + <itemizedlist> + <listitem> <para> <parameter>conserve</parameter>: Import data when it does not exist, otherwise do nothing. </para> - </listitem> - <listitem> + + </listitem> + <listitem> <para> <parameter>insert</parameter>: Import data when it does not exist, otherwise performs a strategy that adds new data only. </para> - </listitem> - <listitem> + + </listitem> + <listitem> <para> <parameter>merge</parameter>: Import data when it does not exist, update data when it exists. </para> - </listitem> - <listitem> + + </listitem> + <listitem> <para> <parameter>rewrite</parameter>: Overwrite data whatsoever. </para> - </listitem> - </itemizedlist> - </callout> -</calloutlist> - - <para> - Based on these parameters, the portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. - </para> - <para> - The portal configuration files will be stored in folders with path look like <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename>, all navigations are defined in the <filename>navigation.xml</filename> file, pages are defined in <filename>pages.xml</filename> and portal configuration is defined in <filename>{ownerType}.xml</filename>. - </para> - <para> - For example, with the above configuration, portal will look for all configuration files from <filename>war:/conf/portal/portal/classic path.</filename> - </para> + + </listitem> + + </itemizedlist> + + </callout> + + </calloutlist> + <para> + Based on these parameters, the portal will look for the configuration files and create a relevant portal navigation, pages and data import strategy. + </para> + <para> + The portal configuration files will be stored in folders with path look like <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename>, all navigations are defined in the <filename>navigation.xml</filename> file, pages are defined in <filename>pages.xml</filename> and portal configuration is defined in <filename>{ownerType}.xml</filename>. + </para> + <para> + For example, with the above configuration, portal will look for all configuration files from <filename>war:/conf/portal/portal/classic path.</filename> + </para> + </section> - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation"> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation"> <title>Portal Navigation</title> - <!-- Updated based on Gatein revision 6987 --> - <para> + <!-- Updated based on Gatein revision 6987 --> <para> The portal navigation incorporates the pages that can be accessed even when a user is not logged in (assuming the applicable permissions allow public access). For example; several portal navigations could be used when a company has multiple trademarks, and websites are set up for each of them. </para> - <para> + <para> The <emphasis>Classic</emphasis> portal is configured by three XML files in the <filename>02portal.war:/WEB-INF/conf/portal/portal/classic</filename> directory: </para> - <variablelist> + <variablelist> <varlistentry> <term>portal.xml</term> - <listitem> + <listitem> <para> This file describes the layout and portlets that will be shown on all pages. Usually the layout contains the banner, footer, menu and breadcrumbs portlets. JBoss Enterprise Portal Platform is extremely configurable as every view element (even the banner and footer) is a portlet. </para> - + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/portal.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <para> It is also possible to apply a nested container that can also contain portlets. Row, column or tab containers are then responsible for the layout of their child portlets. </para> - <!--Updated based on Gatein revision 6987--> - <para> + <!-- Updated based on Gatein revision 6987 --> <para> Each application references a portlet using the id <literal>portal#{portalName}:/{portletWarName}/{portletName}/{uniqueId}</literal>. </para> - <para> + <para> Use the <literal>page-body</literal> tag to define where JBoss Enterprise Portal Platform should render the current page. </para> - <para> - The defined <emphasis>classic</emphasis> portal is accessible to &#34;Everyone&#34; (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it. + <para> + The defined <emphasis>classic</emphasis> portal is accessible to "Everyone" (at <literal>/portal/public/classic</literal>) but only members of the group <literal>/platform/administrators</literal> can edit it. </para> + </listitem> + </varlistentry> - <varlistentry> + <varlistentry> <term>navigation.xml</term> - <listitem> + <listitem> <para> This file defines all the navigation nodes the portal will have. The syntax is simple and uses nested node tags. Each node references a page defined in <filename>pages.xml</filename> file. </para> - <!--Updated based on Gatein revision 6987--> - <para> + <!-- Updated based on Gatein revision 6987 --> <para> If the administrator wants to create node labels for each language, they will have to use <literal>xml:lang</literal> attribute in the label tag with value of <literal>xml:lang</literal> is the relevant locale. </para> - <para> + <para> Otherwise, if they want the node label is localized by resource bundle files, the <literal>#{...}</literal> syntax will be used, the enclosed property name serves as a key that is automatically passed to internationalization mechanism which replaces the literal property name with a localized value taken from the associated properties file matching the current locale. </para> - <!-- DOC NOTE: Replaced code navigation.xml with code from GateIn commit r3831 (as per instruction from theute) --> + <!-- DOC NOTE: Replaced code navigation.xml with code from GateIn commit r3831 (as per instruction from theute) --> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/navigation.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> + <para> This navigation tree can have multiple views inside portlets (such as the breadcrumbs portlet) that render the current view node, the site map or the menu portlets. </para> - <warning> + <warning> <para> For top nodes, the <emphasis role="bold">uri</emphasis> and the <emphasis role="bold">name</emphasis> of your navigation nodes must have the <emphasis>same</emphasis> value. For other nodes the <emphasis role="bold">uri</emphasis> is a relative path. </para> - <para> - For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node (<emphasis>&#60;name&#62;fileexplorer&#60;/name&#62; </emphasis>). + <para> + For example; <emphasis><uri>contentmanagement/fileexplorer</uri></emphasis> where '<literal>contentmanagement</literal> ' is the name of the parent node and '<literal>fileexplorer</literal>' is the name of the node (<emphasis>&lt;name&gt;fileexplorer&lt;/name&gt; </emphasis>). </para> + </warning> + </listitem> + </varlistentry> - <varlistentry> + <varlistentry> <term>Subnodes</term> - <listitem> + <listitem> <para> Subnodes can also be created using the following XML structure </para> - <programlistingco> + <programlistingco> <areaspec> - <area coords="9 40" id="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage" /> + <area coords="9 40" id="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation-subpage" /> + </areaspec> - + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/subpage.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <calloutlist> - <callout arearefs="area-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation-subpage"> + <calloutlist> + <callout arearefs="area-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation-subpage"> <para> This element defines the parent/child relationship between a page and a subnode. </para> + </callout> + </calloutlist> + </programlistingco> + + </listitem> + </varlistentry> - <varlistentry> + <varlistentry> <term>pages.xml</term> - <listitem> + <listitem> <para> - This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags (some usage examples of container tags can be found in <filename>02portal.war/WEB-INF/conf/portal/portal/sharedlayout.xml</filename>). - </para> - <para> - Each application can decide whether to render the portlet border, the window state, the icons or portlet's mode. + This configuration file structure is very similar to <filename>portal.xml</filename> and it can also contain container tags (some usage examples of container tags can be found in <filename>02portal.war/WEB-INF/conf/portal/portal/sharedlayout.xml</filename>). </para> -<!-- DOC NOTE: look into including some actual examples of 'container tags' from sharedlayout.xml in place here. --> - + <para> + Each application can decide whether to render the portlet border, the window state, the icons or portlet's mode. + </para> + <!-- DOC NOTE: look into including some actual examples of 'container tags' from sharedlayout.xml in place here. --> <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/pages.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> </listitem> + </varlistentry> + </variablelist> + </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-Group_Navigation"> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Group_Navigation"> <title>Group Navigation</title> - <para> + <para> Group navigations are dynamically added to the user navigation at login. This allows users to see the pages assigned to any groups they belong to in the menu. </para> - <para> - The group navigation menu is configured by two XML files (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). The syntax used in these files is the same as those covered in <xref linkend="sect-Reference_Guide-Portal_Navigation_Configuration-Portal_Navigation" />. + <para> + The group navigation menu is configured by two XML files (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). The syntax used in these files is the same as those covered in <xref linkend="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-Portal_Navigation" />. </para> - <para> + <para> They are located in <filename>02portal.war/WEB-INF/conf/portal/group<replaceable>/group-name-path/</replaceable></filename> directory (For example; <filename>02portal.war/WEB-INF/conf/portal/group/platform/administrators/</filename>). </para> + </section> - - <section id="sect-Reference_Guide-Portal_Navigation_Configuration-User_Navigation"> + <section id="sect-Reference_Guide_eXo_JCR_1.14-Portal_Navigation_Configuration-User_Navigation"> <title>User Navigation</title> - <para> + <para> User navigation is the set of nodes and pages that are owned by a user. They are part of the user's dashboard. </para> - <!-- DOC NOTE: Get an answer on the below!--> - <!-- This Paragraph:--> - <para> - Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory &#34;<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>&#34;. + <!-- DOC NOTE: Get an answer on the below! --> <!-- This Paragraph: --> <para> + Two files configure the user navigation (<filename>navigation.xml</filename> and <filename>pages.xml</filename>). They are located in the directory "<filename>02portal.war/WEB-INF/conf/portal/users/{userName}</filename>". </para> - <!--Became this paragraph in GateIn r6987 + <!-- Became this paragraph in GateIn r6987 <para> Three files configure the user navigation (<filename>navigation.xml</filename>, <filename>pages.xml</filename> and <filename>portlet-preferences.xml</filename>). They are located in the <filename>{templateLocation}/{ownerType}/{predefinedOwner}</filename> directory with <literal>ownerType</literal> is <literal>user</literal> and <literal>predefinedOwner</literal> is username that want to create the navigation. For example, if administrator want to create navigation for user <literal>root</literal>, he has to locate the configuration files in <filename>portal.war/WEB-INF/conf/portal/user/root </filename> </para> - Which is appropriate for EPP 5.1.1?--> - <para> + Which is appropriate for EPP 5.1.1? --> <para> The file <filename>eXoGadgets.war/WEB-INF/gadget.xml</filename> defines the gadgets that will be available on a user dashboard. </para> - <para> + <para> The example below shows a dashboard with all of the default gadgets included, as well as an extra currency converter gadget sourced from <ulink type="http" url="http://www.google.com/ig/directory?synd=open">Google Gadgets</ulink>. </para> - + <programlisting language="XML" role="XML"><xi:include href="../../extras/PortalDevelopment_DefaultPortalNavigationConfiguration/gadgets.xml" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </section> + </chapter> +