[gatein-commits] gatein SVN: r2194 - in portal/trunk/docs/reference-guide/en/modules: configuration and 3 other directories.
do-not-reply at jboss.org
do-not-reply at jboss.org
Thu Mar 11 23:51:56 EST 2010
Author: smumford
Date: 2010-03-11 23:51:54 -0500 (Thu, 11 Mar 2010)
New Revision: 2194
Modified:
portal/trunk/docs/reference-guide/en/modules/Configuration.xml
portal/trunk/docs/reference-guide/en/modules/Development.xml
portal/trunk/docs/reference-guide/en/modules/Foundations.xml
portal/trunk/docs/reference-guide/en/modules/Gadgets.xml
portal/trunk/docs/reference-guide/en/modules/Integration.xml
portal/trunk/docs/reference-guide/en/modules/Introduction.xml
portal/trunk/docs/reference-guide/en/modules/Portlets.xml
portal/trunk/docs/reference-guide/en/modules/SSO.xml
portal/trunk/docs/reference-guide/en/modules/WSRP.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Dashboard_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/JavaScript_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/development/Accessing_User_Profile.xml
portal/trunk/docs/reference-guide/en/modules/development/Ajax_Loading_Mask_Layer_Deactivation.xml
portal/trunk/docs/reference-guide/en/modules/development/Dynamic_Layouts.xml
portal/trunk/docs/reference-guide/en/modules/development/Internationalization_Configuration.xml
portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml
portal/trunk/docs/reference-guide/en/modules/development/Portal_Lifecycle.xml
portal/trunk/docs/reference-guide/en/modules/development/Right_To_Left_Framework.xml
portal/trunk/docs/reference-guide/en/modules/development/Upload_Component.xml
portal/trunk/docs/reference-guide/en/modules/development/XML_Resource_Bundles.xml
portal/trunk/docs/reference-guide/en/modules/gadgets/Gadgets.xml
portal/trunk/docs/reference-guide/en/modules/gadgets/Setup_a_Gadget_Server.xml
portal/trunk/docs/reference-guide/en/modules/portlets/AJAX_in_GateIn_Framework.xml
portal/trunk/docs/reference-guide/en/modules/portlets/Create_a_WebUI_Portlet.xml
portal/trunk/docs/reference-guide/en/modules/portlets/Groovy_Templates.xml
portal/trunk/docs/reference-guide/en/modules/portlets/Portlet_Lifecycle.xml
portal/trunk/docs/reference-guide/en/modules/portlets/Standard.xml
portal/trunk/docs/reference-guide/en/modules/portlets/WebUI.xml
Log:
Various mechanical fixes. See JIRA GTNPORTAL-718 for info
Modified: portal/trunk/docs/reference-guide/en/modules/Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Configuration">
<title>Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/Development.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Development.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Development.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Development">
<title>Development</title>
Modified: portal/trunk/docs/reference-guide/en/modules/Foundations.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Foundations.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Foundations.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -2,6 +2,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">
%BOOK_ENTITIES;
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Foundations" xmlns:x="http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
Modified: portal/trunk/docs/reference-guide/en/modules/Gadgets.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Gadgets.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Gadgets.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Gadget_development">
<!--
Modified: portal/trunk/docs/reference-guide/en/modules/Integration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Integration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Integration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Integration">
<!--
Modified: portal/trunk/docs/reference-guide/en/modules/Introduction.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Introduction.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Introduction.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -2,6 +2,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">
%BOOK_ENTITIES;
+<!ENTITY % BOOK_ENTITIES SYSTEM "../Reference_Guide.ent">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Introduction">
<title>Introduction</title>
Modified: portal/trunk/docs/reference-guide/en/modules/Portlets.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/Portlets.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/Portlets.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-Portlet_development">
<title>Portlet development</title>
Modified: portal/trunk/docs/reference-guide/en/modules/SSO.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/SSO.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/SSO.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<chapter id="chap-Reference_Guide-SSO_Single_Sign_On">
<title>SSO - Single Sign On</title>
@@ -12,7 +14,7 @@
When logging into the portal users gain access to many systems through portlets using a single identity. In many cases, however, the portal infrastructure must be integrated with other SSO enabled systems. There are many different Identity Management solutions available. In most cases each SSO framework provides a unique way to plug into a Java EE application.
</para>
<section id="sect-Reference_Guide-Overview_of_SSO-Prerequisite">
- <title>Prerequisite</title>
+ <title>Prerequisites</title>
<para>
In this tutorial, the SSO server is installed in a Tomcat installation. Tomcat can be obtained from <ulink type="http" url="http://tomcat.apache.org">http://tomcat.apache.org</ulink>.
</para>
Modified: portal/trunk/docs/reference-guide/en/modules/WSRP.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/WSRP.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/WSRP.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
<!ENTITY % entities SYSTEM "../Reference_Guide.ent">
%entities;
]>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Authentication_Token_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Authentication_Token_Configuration">
<title>Authentication Token Configuration</title>
@@ -54,7 +56,6 @@
<area coords="8" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-time" />
<area coords="9" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-unit" />
</areaspec>
-
<programlisting role="XML"><component>
<key>org.exoplatform.web.security.security.CookieTokenService</key>
<type>org.exoplatform.web.security.security.CookieTokenService</type>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Dashboard_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Dashboard_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Dashboard_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Dashboard_configuration">
<title>Dashboard configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Data_Injector_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Data_Injector_Configuration">
<title>Data Injector Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Database_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -3,6 +3,8 @@
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Database_Configuration">
<title>Database Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Default_Portal_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,12 +1,14 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Default_Portal_Configuration">
<title>Default Portal Configuration</title>
<section id="sect-Reference_Guide-Default_Portal_Configuration-Overview">
<title>Overview</title>
<para>
- The default portal will be accessed if the user doesn't specify another portal. For example: <literal>http://hostname:port/portal/</literal>. The default portal also be used at startup to determine if the tomcat database is empty or not.
+ The default portal will be accessed if the user doesn't specify another portal. For example: <literal>http://hostname:port/portal/</literal>. The default portal also be used at startup to determine if the database is empty.
</para>
</section>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/IDM_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -2,6 +2,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">
%BOOK_ENTITIES;
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-PicketLink_IDM_integration">
<title>PicketLink IDM integration</title>
@@ -35,11 +37,10 @@
<area coords="5" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMServiceImpl" />
<area coords="22" id="area-Reference_Guide-PicketLink_IDM_integration-Configuration_files-JBossIDMOrganizationServiceImpl" />
</areaspec>
-
<programlisting role="XML"><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">
-
+
<component>
<key>org.exoplatform.services.organization.idm.PicketLinkIDMService</key>
<type>org.exoplatform.services.organization.idm.PicketLinkIDMServiceImpl</type>
@@ -54,8 +55,8 @@
</value-param>
</init-params>
</component>
-
-
+
+
<component>
<key>org.exoplatform.services.organization.OrganizationService</key>
<type>org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</type>
@@ -66,26 +67,26 @@
<field name="useParentIdAsGroupType">
<boolean>true</boolean>
</field>
-
+
<field name="forceMembershipOfMappedTypes">
<boolean>true</boolean>
</field>
-
+
<field name="pathSeparator">
<string>.</string>
</field>
-
+
<field name="rootGroupName">
<string>GTN_ROOT_GROUP</string>
</field>
-
+
<field name="groupTypeMappings">
<map type="java.util.HashMap">
<entry>
<key><string>/</string></key>
<value><string>root_type</string></value>
</entry>
-
+
<!-- Sample mapping -->
<!--
<entry>
@@ -97,24 +98,24 @@
<value><string>organization_type</string></value>
</entry>
-->
-
+
</map>
</field>
-
+
<field name="associationMembershipType">
<string>member</string>
</field>
-
+
<field name="ignoreMappedMembershipType">
<boolean>false</boolean>
</field>
</object>
</object-param>
</init-params>
-
-
+
+
</component>
-
+
</configuration>
</programlisting>
<calloutlist>
@@ -122,127 +123,180 @@
<para>
The <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMServiceImpl</emphasis> service has following options:
</para>
- <itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>config</term>
<listitem>
<para>
- <emphasis role="bold">config</emphasis> - (value-param) - PicketLink IDM configuration file
+ (value-param)
</para>
- </listitem>
- <listitem>
<para>
- <emphasis role="bold">jndiName</emphasis> - (value-param) - in case 'config' parameter is not
- provided this will be used to perform JNDI lookup for IdentitySessionFactory
+ PicketLink IDM configuration file
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>hibernate.properties</term>
<listitem>
<para>
- <emphasis role="bold">portalRealm</emphasis> - (value-param) - name of a realm that should be used to
- obtain proper IdentitySession - default is 'PortalRealm'.
+ (properties-param)
</para>
- </listitem>
- </itemizedlist>
- </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 dependant on <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMService</emphasis>
- </para>
- <para>
- <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis>
- service has following options defined as fields of object-param type
- <emphasis role="bold">org.exoplatform.services.organization.idm.Config</emphasis>:
- </para>
-
- <itemizedlist>
- <listitem>
<para>
- <emphasis role="bold">defaultGroupType</emphasis> - Name of PicketLink IDM GroupType that will be used to store groups.
- Default is 'GTN_GROUP_TYPE'
+ 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>
- <emphasis role="bold">rootGroupName</emphasis> - Name of PicketLink IDM Group that will be used as a root parent.
- Default is 'GTN_ROOT_GROUP'
+ A list of annotated classes that will be added to hibernate configuration.
</para>
</listitem>
- <listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>hibernate.mappings</term>
+ <listitem>
<para>
- <emphasis role="bold">passwordAsAttribute</emphasis> - (default false) - Specifies if password should be stored using
- PicketLink IDM Credential object or as a plain attribute
+ A list of xml files that will be added to hibernate configuration as mapping files.
</para>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>jndiName</term>
<listitem>
<para>
- <emphasis role="bold">useParentIdAsGroupType</emphasis> - For all ids not mapped with type in 'groupTypeMappings'
- option use parent id path
- as a group type to store group in PicketLink IDM. The effect of setting
- this option to false and not providing any mappings under 'groupTypeMappings' option
- is that there can be only one group with a given name in whole GateIn group tree
+ (value-param)
</para>
- </listitem>
- <listitem>
<para>
- <emphasis role="bold">pathSeparator</emphasis> - When 'userParentIdAsGroupType is set to true this value will be used to
- replace all "/" chars in id. This is because "/" is not allowed to be
- used in group type name in PicketLink IDM
+ If the 'config' parameter is not provided this parameter will be used to perform JNDI lookup for IdentitySessionFactory
</para>
</listitem>
- <listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>portalRealm</term>
+ <listitem>
<para>
- <emphasis role="bold">associationMembershipType</emphasis> - If this option is used then each Membership created with
- MembrshipType that is equal to value specified here will be stored in PicketLink IDM as simple
- Group-User association
+ (value-param)
</para>
- </listitem>
- <listitem>
<para>
- <emphasis role="bold">groupTypeMappings</emphasis> - Map groups added with GateIn API as a childs of a given group ID to be stored with a given
- group type name in PicketLink IDM. If parent ID ends with "/*" then all child groups will
- have the mapped group type. Otherwise only direct (first level) children will use this type.
-
- This can be leveraged by LDAP setup. Given LDAP DN configured in PicketLink IDM to
- store specific group type will then store one given branch in GateIn group tree while
- all other groups will remain in DB.
+ The name of a realm that should be used to obtain proper IdentitySession. The default is 'PortalRealm'.
</para>
</listitem>
- <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 dependant on <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMService</emphasis>
+ </para>
+ <para>
+ <emphasis role="bold">org.exoplatform.services.organization.idm.PicketLinkIDMOrganizationServiceImpl</emphasis>
+ service has following options defined as fields of object-param type
+ <emphasis role="bold">org.exoplatform.services.organization.idm.Config</emphasis>:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term>defaultGroupType</term>
+ <listitem>
<para>
- <emphasis role="bold">forceMembershipOfMappedTypes</emphasis> - Group stored in PicketLink IDM with a type mapped in 'groupTypeMappings' will
- automatically be member under mapped parent. Normally groups are linked by
- PicketLink IDM group association - such relationship won't be needed then. It can
- be set to false if all groups are added via GateIn APIs
- This option may be useful with LDAP config as it will make (if set to true) every entry
- added to LDAP (not via GateIn management UI) appear in GateIn
+ The name of the PicketLink IDM GroupType that will be used to store groups. The default is 'GTN_GROUP_TYPE'.
</para>
</listitem>
- <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 'GTN_ROOT_GROUP'
+ </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 false.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>useParentIdAsGroupType</term>
+ <listitem>
<para>
- <emphasis role="bold">ignoreMappedMembershipType</emphasis> - if "associationMembershipType" option is used and this option is set to true
- then Membership with MembershipType configured to be stored as PicketLink IDM association
- will not be stored as PicketLink IDM Role
+ This parameter stores the parent ID path as a group type in PicketLink IDM for any IDs not mapped with a specific type in 'groupTypeMappings'. If this option is set to false and no mappings are provided under 'groupTypeMappings' only one group with a given name can exist in the &PRODUCT; group tree.
</para>
- </listitem>
- </itemizedlist>
-
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>pathSeparator</term>
+ <listitem>
+ <para>
+ When 'userParentIdAsGroupType is set to true, 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 MembrshipType 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 the &PRODUCT; API as a child 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 the &PRODUCT; 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 'groupTypeMappings' will automatically be a member under the mapped parent. Group relationships linked by PicketLink IDM group association will not be necessary.
+ </para>
+ <para>
+ This parameter can be set to false if all groups are added via &PRODUCT; APIs. This may be useful with LDAP configuration as, when set to true, it will make every entry added to LDAP appear in &PRODUCT;. This is not true for entries added via the &PRODUCT; management UI, however.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>ignoreMappedMembershipType</term>
+ <listitem>
+ <para>
+ If "associationMembershipType" option is used and this option is set to true then Membership with MembershipType configured to be stored as PicketLink IDM association will not be stored as PicketLink IDM Role.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>
Additionally <emphasis role="bold">JBossIDMOrganizationServiceImpl</emphasis> uses those defaults to perform identity management operations
</para>
<itemizedlist>
<listitem>
<para>
- GateIn User interface properties fields are persisted in JBoss Identity IDM using those attributes names: firstName, lastName, email, createdDate, lastLoginTime, organizationId, password (if password is configured to be stored as attribute)
+ &PRODUCT; User interface properties fields are persisted in JBoss Identity IDM using those attributes names: firstName, lastName, email, createdDate, lastLoginTime, organizationId, password (if password is configured to be stored as attribute)
</para>
</listitem>
<listitem>
<para>
- GateIn Group interface properties fields are persisted in JBoss Identity IDM using those attributes names: label, description
+ &PRODUCT; Group interface properties fields are persisted in JBoss Identity IDM using those attributes names: label, description
</para>
</listitem>
<listitem>
<para>
- GateIn MembershipType interface properties fields are persisted in JBoss Identity IDM using those RoleType properties: description, owner, create_date, modified_date
+ &PRODUCT; MembershipType interface properties fields are persisted in JBoss Identity IDM using those RoleType properties: description, owner, create_date, modified_date
</para>
</listitem>
</itemizedlist>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/JavaScript_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/JavaScript_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/JavaScript_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Javascript_Configuration">
<title>Javascript Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Default_Permission_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Portal_Default_Permission_Configuration">
<title>Portal Default Permission Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Portal_Navigation_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Portal_Navigation_Configuration">
<title>Portal Navigation Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Predefined_User_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Predefined_User_Configuration">
<title>Predefined User Configuration</title>
Modified: portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/configuration/Skin_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -3,6 +3,8 @@
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
%BOOK_ENTITIES;
+<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Skin_Configuration">
<title>Skin Configuration</title>
@@ -97,12 +99,10 @@
<programlistingco>
<areaspec>
<area coords="3" id="area-Reference_Guide-Skin_Configuration-Coreskin" />
-
<area coords="4"
id="area-Reference_Guide-Skin_Configuration-Stylesheets" />
</areaspec>
-
- <programlisting><head>
+<programlisting><head>
...
<link id="CoreSkin" rel="stylesheet" type="text/css" href="/eXoResources/skin/Stylesheet.css" />
<link id="web_FooterPortlet" rel="stylesheet" type="text/css" href= "/web/skin/portal/webui/component/UIFooterPortlet/DefaultStylesheet.css" />
@@ -112,13 +112,11 @@
...
</head>
</programlisting>
-
<calloutlist>
<callout arearefs="area-Reference_Guide-Skin_Configuration-Coreskin">
<para>Portal skin stylesheet
(<literal>id="CoreSkin"</literal>).</para>
</callout>
-
<callout arearefs="area-Reference_Guide-Skin_Configuration-Stylesheets">
<para>Portlets skins stylesheets (all
others). Each portlet within the page may contribute its
Modified: portal/trunk/docs/reference-guide/en/modules/development/Accessing_User_Profile.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Accessing_User_Profile.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Accessing_User_Profile.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Accessing_User_Profile">
<title>Accessing User Profile</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Ajax_Loading_Mask_Layer_Deactivation.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Ajax_Loading_Mask_Layer_Deactivation.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Ajax_Loading_Mask_Layer_Deactivation.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Deactivation_of_the_Ajax_Loading_Mask_Layer_">
<title>Deactivation of the Ajax Loading Mask Layer </title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Dynamic_Layouts.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Dynamic_Layouts.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Dynamic_Layouts.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Dynamic_Layouts">
<title>Dynamic Layouts</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Internationalization_Configuration.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Internationalization_Configuration.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Internationalization_Configuration.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Internationalization_Configuration">
<title>Internationalization Configuration</title>
@@ -93,7 +95,6 @@
<area coords="7" id="area-Reference_Guide-i18n.locales.configuration.description" />
<area coords="22" id="area-Reference_Guide-i18n.locales.configuration.orientation" />
</areaspec>
-
<programlisting><?xml version="1.0" encoding="UTF-8"?>
<locales-config>
<locale-config>
@@ -102,14 +103,14 @@
<input-encoding>UTF-8</input-encoding>
<description>Default configuration for english locale</description>
</locale-config>
-
+
<locale-config>
<locale>fr</locale>
<output-encoding>UTF-8</output-encoding>
<input-encoding>UTF-8</input-encoding>
<description>Default configuration for the french locale</description>
</locale-config>
-
+
<locale-config>
<locale>ar</locale>
<output-encoding>UTF-8</output-encoding>
@@ -161,7 +162,6 @@
<area coords="11" id="area-Reference_Guide-i18n.rb.service.init_resources" />
<area coords="24" id="area-Reference_Guide-i18n.rb.service.portal_resource_names" />
</areaspec>
-
<programlisting><component>
<key>org.exoplatform.services.resources.ResourceBundleService</key>
<type>org.exoplatform.services.resources.impl.SimpleResourceBundleService</type>
Modified: portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/JavaScript_Inter_Application_Communication.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-JavaScript_Inter_Application_Communication">
<title>JavaScript Inter Application Communication</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Portal_Lifecycle.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Portal_Lifecycle.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Portal_Lifecycle.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Portal_Lifecycle">
<title>Portal Lifecycle</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Right_To_Left_Framework.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Right_To_Left_Framework.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Right_To_Left_Framework.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-RTL_Right_To_Left_Framework">
<title>RTL (Right To Left) Framework</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/Upload_Component.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/Upload_Component.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/Upload_Component.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Upload_Component">
<title>Upload Component</title>
Modified: portal/trunk/docs/reference-guide/en/modules/development/XML_Resource_Bundles.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/development/XML_Resource_Bundles.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/development/XML_Resource_Bundles.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-XML_Resources_Bundles">
<title>XML Resources Bundles</title>
Modified: portal/trunk/docs/reference-guide/en/modules/gadgets/Gadgets.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/gadgets/Gadgets.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/gadgets/Gadgets.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Gadgets">
<title>Gadgets</title>
Modified: portal/trunk/docs/reference-guide/en/modules/gadgets/Setup_a_Gadget_Server.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/gadgets/Setup_a_Gadget_Server.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/gadgets/Setup_a_Gadget_Server.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Setup_a_Gadget_Server">
<title>Setup a Gadget Server</title>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/AJAX_in_GateIn_Framework.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/AJAX_in_GateIn_Framework.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/AJAX_in_GateIn_Framework.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-AJAX_Framework">
<title>AJAX Framework</title>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/Create_a_WebUI_Portlet.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/Create_a_WebUI_Portlet.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/Create_a_WebUI_Portlet.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Create_a_WebUI_Portlet">
<title>Create a WebUI Portlet</title>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/Groovy_Templates.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/Groovy_Templates.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/Groovy_Templates.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Groovy_Templates">
<title>Groovy Templates</title>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/Portlet_Lifecycle.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/Portlet_Lifecycle.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/Portlet_Lifecycle.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Portlet_Lifecycle">
<title>Portlet Lifecycle</title>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/Standard.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/Standard.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/Standard.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Portlet_Primer">
<title>Portlet Primer</title>
@@ -179,7 +181,6 @@
<area coords="10" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure.portlet" />
<area coords="11" id="area-Reference_Guide-Deploying_your_first_Portlet-Package_Structure.web" />
</areaspec>
-
<programlisting>|-- SimplestHelloWorld-0.0.1.war
| `-- WEB-INF
| |-- classes
@@ -226,16 +227,15 @@
<area coords="16" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.write" />
<area coords="17" id="area-Reference_Guide-Deploying_your_first_Portlet-Portlet_Class.close" />
</areaspec>
-
<programlisting role="JAVA">package org.gatein.portal.examples.portlets;
-
+
import java.io.IOException;
import java.io.PrintWriter;
-
+
import javax.portlet.GenericPortlet;
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
-
+
public class SimplestHelloWorldPortlet extends GenericPortlet
{
public void doView(RenderRequest request,
@@ -307,7 +307,6 @@
<area coords="12" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.supports" />
<area coords="15" id="area-Reference_Guide-Deploying_your_first_Portlet-Application_Descriptors.portletinfo" />
</areaspec>
-
<programlisting>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -467,11 +466,10 @@
<area coords="25" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.requestDispatcher" />
<area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.include" />
</areaspec>
-
<programlisting role="JAVA">package org.gatein.portal.examples.portlets;
-
+
import java.io.IOException;
-
+
import javax.portlet.ActionRequest;
import javax.portlet.ActionResponse;
import javax.portlet.GenericPortlet;
@@ -480,10 +478,10 @@
import javax.portlet.RenderRequest;
import javax.portlet.RenderResponse;
import javax.portlet.UnavailableException;
-
+
public class JSPHelloUserPortlet extends GenericPortlet
{
-
+
public void doView(RenderRequest request, RenderResponse response)
throws PortletException, IOException
{
@@ -570,7 +568,6 @@
<area coords="5" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.getActionParameter" />
<area coords="6" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-Portlet_Class.setRenderParameter" />
</areaspec>
-
<programlisting role="JAVA">...
public void processAction(ActionRequest aRequest, ActionResponse aResponse) throws PortletException, IOException,
UnavailableException
@@ -626,24 +623,23 @@
<area coords="30" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library.method3.1" />
<area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSP_files_and_the_Portlet_Tag_Library.method3.2" />
</areaspec>
-
<programlisting><%@ taglib uri="http://java.sun.com/portlet" prefix="portlet" %>
-
+
<div class="portlet-section-header">Welcome !</div>
-
+
<br/>
-
+
<div class="portlet-font">Welcome on the JSP Hello User portlet,
my name is GateIn Portal. What's yours ?</div>
-
+
<br/>
-
+
<div class="portlet-font">Method 1: We simply pass the parameter to the render phase:<br/>
<a href="<portlet:renderURL><portlet:param name="yourname" value="John Doe"/>
</portlet:renderURL>">John Doe</a></div>
-
+
<br/>
-
+
<div class="portlet-font">Method 2: We pass the parameter to the render phase, using valid XML:
Please check the source code to see the difference with Method 1.
<portlet:renderURL var="myRenderURL">
@@ -651,11 +647,11 @@
</portlet:renderURL>
<br/>
<a href="<%= myRenderURL %>">John Doe</a></div>
-
+
<br/>
-
+
<div class="portlet-font">Method 3: We use a form:<br/>
-
+
<portlet:actionURL var="myActionURL"/>
<form action="<%= myActionURL %>" method="POST">
<span class="portlet-form-field-label">Name:</span>
@@ -742,7 +738,6 @@
<area coords="26" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.edit" />
<area coords="31" id="area-Reference_Guide-JavaServer_Pages_Portlet_Example-JSF_example_using_the_JBoss_Portlet_Bridge.help" />
</areaspec>
-
<programlisting><?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -766,17 +761,17 @@
<name>javax.portlet.faces.defaultViewId.view</name>
<value>/jsf/welcome.jsp</value>
</init-param>
-
+
<init-param>
<name>javax.portlet.faces.defaultViewId.edit</name>
<value>/jsf/edit.jsp</value>
</init-param>
-
+
<init-param>
<name>javax.portlet.faces.defaultViewId.help</name>
<value>/jsf/help.jsp</value>
</init-param>
-
+
</portlet>
</portlet-app>
</programlisting>
Modified: portal/trunk/docs/reference-guide/en/modules/portlets/WebUI.xml
===================================================================
--- portal/trunk/docs/reference-guide/en/modules/portlets/WebUI.xml 2010-03-12 04:48:39 UTC (rev 2193)
+++ portal/trunk/docs/reference-guide/en/modules/portlets/WebUI.xml 2010-03-12 04:51:54 UTC (rev 2194)
@@ -1,5 +1,7 @@
<?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">
+%BOOK_ENTITIES;
]>
<section id="sect-Reference_Guide-Web_User_Interface_WebUI">
<title>Web User Interface - WebUI</title>
More information about the gatein-commits
mailing list