Author: smumford Date: 2010-05-11 01:03:42 -0400 (Tue, 11 May 2010) New Revision: 3036 Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml Log: Minor edits Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036) @@ -5,26 +5,29 @@ ]> <section id="sect-Reference_Guide-Authentication_Token_Configuration"> <title>Authentication Token Configuration</title> - <section id="sect-Reference_Guide-Authentication_Token_Configuration-What_is_Token_Service"> - <title>What is Token Service?</title> + <section id="sect-Reference_Guide-Authentication_Token_Configuration-The_Token_Service"> + <title>The Token Service</title> <para> - <emphasis>Token Service</emphasis> is used in authentication. + The <emphasis>Token Service</emphasis> is used in authentication. </para> <para> The token system prevents user account information being sent in clear text mode within inbound requests. This increases authentication security. </para> <para> - Token service allows administrators to create, delete, retrieve and clean tokens as required. The service also defines a validity period of any given token. The token becomes invalid once this period expires. + The token service allows administrators to create, delete, retrieve and clean tokens as required. The service also defines a validity period of any given token. The token becomes invalid once this period expires. </para> </section> <section id="sect-Reference_Guide-Authentication_Token_Configuration-Implementing_the_Token_Service_API"> <title>Implementing the Token Service API</title> <para> - All token services used in &PRODUCT; authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class. The following <emphasis role="bold">AbstractTokenService</emphasis> methods represent the contract between authentication runtime, and a token service implementation. + All token services used in &PRODUCT; authentication must be implemented by subclassing an <emphasis role="bold">AbstractTokenService</emphasis> abstract class. </para> + <para> + The following <emphasis role="bold">AbstractTokenService</emphasis> methods represent the contract between authentication runtime, and a token service implementation. + </para> -<programlisting role="JAVA"> +<programlisting language="Java" role="JAVA"> public Token getToken(String id) throws PathNotFoundException, RepositoryException; public Token deleteToken(String id) throws PathNotFoundException, RepositoryException; public String[] getAllTokens(); @@ -37,9 +40,9 @@ </section> <section id="sect-Reference_Guide-Authentication_Token_Configuration-Configuring_token_services"> - <title>Configuring token services</title> + <title>Configuring Token Services</title> <para> - Token services configuration includes specifying the token validity period. The token service is configured as a portal component (in portal scope, as opposed to root scope - more about that in Foundations chapter). + Token services configuration includes specifying the token validity period. The token service is configured as a portal component. </para> <para> In the example below, <emphasis>CookieTokenService</emphasis> is a subclass of <emphasis role="bold">AbstractTokenService</emphasis> so it has a property which specifies the validity period of the token. @@ -57,19 +60,18 @@ <area coords="9" id="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-unit" /> </areaspec> -<programlisting>&lt;component&gt; - &lt;key&gt;org.exoplatform.web.security.security.CookieTokenService&lt;/key&gt; - &lt;type&gt;org.exoplatform.web.security.security.CookieTokenService&lt;/type&gt; - &lt;init-params&gt; - &lt;values-param&gt; - &lt;name&gt;service.configuration&lt;/name&gt; - &lt;value&gt;jcr-token&lt;/value&gt; - &lt;value&gt;7&lt;/value&gt; - &lt;value&gt;DAY&lt;/value&gt; - &lt;/values-param&gt; - &lt;/init-params&gt; -&lt;/component&gt; -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<component> + <key>org.exoplatform.web.security.security.CookieTokenService</key> + <type>org.exoplatform.web.security.security.CookieTokenService</type> + <init-params> + <values-param> + <name>service.configuration</name> + <value>jcr-token</value> + <value>7</value> + <value>DAY</value> + </values-param> + </init-params> +</component>]]></programlisting> <calloutlist> <callout arearefs="area-Reference_Guide-Authentication_Token_Configuration-Configure_token_services-name"> <para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036) @@ -9,7 +9,7 @@ &PRODUCT; uses PicketLink IDM component to keep the necessary identity information (users, groups, memberships, etc.). While legacy interfaces are still used (org.exoplatform.services.organization) for identity management, there is a wrapper implementation that delegates to PicketLink IDM framework. </para> <para> - This section doesn't provide information about PicketLink IDM and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information. + This section does not provide information about PicketLink IDM and its configuration. Please, refer to the appropriate project documentation (<ulink url="http://jboss.org/picketlink/IDM.html" />) for further information. </para> <note> <para> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 04:15:40 UTC (rev 3035) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2010-05-11 05:03:42 UTC (rev 3036) @@ -8,21 +8,24 @@ <section id="sect-Reference_Guide-Predefined_User_Configuration-Overview"> <title>Overview</title> <para> - To specify the initial Organization configuration, the content of <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml </literal> should be edited. This file uses the portal XML configuration schema. It lists several configuration plugins. + The initial Organization configuration should be specified by editing the content of <literal>02portal.war:/WEB-INF/conf/organization/organization-configuration.xml</literal>. This file uses the portal XML configuration schema. It lists several configuration plugins. </para> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_adding_users_groups_and_membership_types"> <title>Plugin for adding users, groups and membership types</title> <para> - The plugin of type <literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal> is used to specify a list of membership types, a list of groups, and a list of users to be created. + The plugin type <literal>org.exoplatform.services.organization.OrganizationDatabaseInitializer</literal> is used to specify a list of membership types, a list of groups and a list of users to be created. </para> <para> The <emphasis role="bold">checkDatabaseAlgorithm</emphasis> initialization parameter determines how the database update is performed. </para> <para> - If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry doesn't yet exist in the database, it is created. If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty. + If its value is set to <emphasis role="bold">entry</emphasis> it means that each user, group and membership listed in the configuration is checked each time &PRODUCT; is started. If the entry doesn't yet exist in the database, it is created. </para> + <para> + If <emphasis role="bold">checkDatabaseAlgorithm</emphasis> parameter value is set to <emphasis role="bold">empty</emphasis>, the configuration data will be updated to the database only if the database is empty. + </para> </section> <section id="sect-Reference_Guide-Predefined_User_Configuration-Membership_types"> @@ -153,47 +156,50 @@ <section id="sect-Reference_Guide-Predefined_User_Configuration-Plugin_for_monitoring_user_creation"> <title>Plugin for monitoring user creation</title> <para> - The plugin of type <literal>org.exoplatform.services.organization.impl.NewUserEventListener </literal> specifies which groups all the newly created users should become members of. It specifies the groups and the memberships to use (while group is just a set of users, a membership type represents a user's role within a group). It also specifies a list of users that should not be processed (i.e. administrative users like 'root'). + The plugin type <literal>org.exoplatform.services.organization.impl.NewUserEventListener</literal> specifies which groups all the newly created users should become members of. </para> + <para> + It specifies the group memberships and the membership types to use (while a <emphasis>group</emphasis> is just a set of users, a membership <emphasis>type</emphasis> represents a user's role within a group). It also specifies a list of users that should not be processed (such as administrative users like '<literal>root</literal>'). + </para> <note> + <title>Terminology</title> <para> - The terms 'membership' and 'membership type' refer to the same thing, and are used interchangeably. + The terms '<emphasis role="bold">membership</emphasis>' and '<emphasis role="bold">membership type</emphasis>' refer to the same thing, and are used interchangeably. </para> </note> -<programlisting role="XML">&lt;component-plugin&gt; - &lt;name&gt;new.user.event.listener&lt;/name&gt; - &lt;set-method&gt;addListenerPlugin&lt;/set-method&gt; - &lt;type&gt;org.exoplatform.services.organization.impl.NewUserEventListener&lt;/type&gt; - &lt;description&gt;this listener assign group and membership to a new created user&lt;/description&gt; - &lt;init-params&gt; - &lt;object-param&gt; - &lt;name&gt;configuration&lt;/name&gt; - &lt;description&gt;description&lt;/description&gt; - &lt;object type="org.exoplatform.services.organization.impl.NewUserConfig"&gt; - &lt;field name="group"&gt; - &lt;collection type="java.util.ArrayList"&gt; - &lt;value&gt; - &lt;object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup"&gt; - &lt;field name="groupId"&gt;&lt;string&gt;/user&lt;/string&gt;&lt;/field&gt; - &lt;field name="membership"&gt;&lt;string&gt;member&lt;/string&gt;&lt;/field&gt; - &lt;/object&gt; - &lt;/value&gt; - &lt;/collection&gt; - &lt;/field&gt; - &lt;field name="ignoredUser"&gt; - &lt;collection type="java.util.HashSet"&gt; - &lt;value&gt;&lt;string&gt;exo&lt;/string&gt;&lt;/value&gt; - &lt;value&gt;&lt;string&gt;root&lt;/string&gt;&lt;/value&gt; - &lt;value&gt;&lt;string&gt;company&lt;/string&gt;&lt;/value&gt; - &lt;value&gt;&lt;string&gt;community&lt;/string&gt;&lt;/value&gt; - &lt;/collection&gt; - &lt;/field&gt; - &lt;/object&gt; - &lt;/object-param&gt; - &lt;/init-params&gt; -&lt;/component-plugin&gt; -</programlisting> +<programlisting language="XML" role="XML"><![CDATA[<component-plugin> + <name>new.user.event.listener</name> + <set-method>addListenerPlugin</set-method> + <type>org.exoplatform.services.organization.impl.NewUserEventListener</type> + <description>this listener assign group and membership to a new created user</description> + <init-params> + <object-param> + <name>configuration</name> + <description>description</description> + <object type="org.exoplatform.services.organization.impl.NewUserConfig"> + <field name="group"> + <collection type="java.util.ArrayList"> + <value> + <object type="org.exoplatform.services.organization.impl.NewUserConfig$JoinGroup"> + <field name="groupId"><string>/user</string></field> + <field name="membership"><string>member</string></field> + </object> + </value> + </collection> + </field> + <field name="ignoredUser"> + <collection type="java.util.HashSet"> + <value><string>exo</string></value> + <value><string>root</string></value> + <value><string>company</string></value> + <value><string>community</string></value> + </collection> + </field> + </object> + </object-param> + </init-params> +</component-plugin>]]></programlisting> </section> </section> Modified: portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml =================================================================== --- portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 04:15:40 UTC (rev 3035) +++ portal/branches/EPP_5_0_0_Branch_Docs/Enterprise_Portal_Platform_Reference_Guide/en-US/modules/GadgetDevelopment/SetupGadgetServer.xml 2010-05-11 05:03:42 UTC (rev 3036) @@ -57,7 +57,7 @@ These servers have to be on the same domain as the gadget server. You can configure the container in <filename>eXoGadgetServer:/WEB-INF/classes/containers/default/container.js</filename>. </para> -<programlisting>"gadgets.content-rewrite" : { +<programlisting language="Java" role="JAVA">"gadgets.content-rewrite" : { "include-urls": ".*", "exclude-urls": "", "include-tags": ["link", "script", "embed", "img", "style"],