[gatein-commits] gatein SVN: r8909 - in epp/docs/branches/6.0/Reference_Guide/en-US: modules and 1 other directories.

Author: jaredmorgs Date: 2012-10-17 17:49:55 -0400 (Wed, 17 Oct 2012) New Revision: 8909 Added: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml Log: BZ#856430 - Reordered Authentication and Identity chapter to promote sections to chapters, and added the SAML2 file I forgot to commit yesterday Modified: epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/Reference_Guide.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -11,7 +11,17 @@ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/PortletDevelopment.xml"/> <part> <title>Authentication and Authorization</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/PasswordEncryption.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/BackendConfiguration.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/OrganizationAPI.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/AccessingUserProfile.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml" encoding="UTF-8"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/SSO.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/LDAP.xml"/> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules/AuthenticationAndIdentity/SAML2.xml" encoding="UTF-8"/> </part> <part> <title>Web Services for Remote Portlets (WSRP)</title> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AccessingUserProfile.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,31 +1,23 @@ -<?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 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; ]> -<section id="sect-Reference_Guide-Accessing_User_Profile"> - <title>Accessing User Profile</title> - <para> - The following code retrieves the details for a logged-in user: - </para> - -<programlisting language="Java" role="Java"><xi:include href="../../extras/Authentication_Identity_AccessingUserProfile/default91.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - <para> - Below are two alternatives for retrieving the Organization Service: - </para> - <orderedlist> - <listitem> - -<programlisting language="Java" role="Java"><xi:include href="../../extras/Authentication_Identity_AccessingUserProfile/default92.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </listitem> - <listitem> - -<programlisting language="Java" role="Java"><xi:include href="../../extras/Authentication_Identity_AccessingUserProfile/default93.java" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - - </listitem> - - </orderedlist> -</section> - - +<chapter id="sect-Reference_Guide-Accessing_User_Profile"> + <title>Accessing User Profile</title> + <para> + The following code retrieves the details for a logged-in user: + </para> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AccessingUserProfile/default91.java" parse="text"/></programlisting> + <para> + Below are two alternatives for retrieving the Organization Service: + </para> + <orderedlist> + <listitem> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AccessingUserProfile/default92.java" parse="text"/></programlisting> + </listitem> + <listitem> + <programlisting language="Java" role="Java"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_AccessingUserProfile/default93.java" parse="text"/></programlisting> + </listitem> + </orderedlist> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,9 +1,9 @@ <?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_Authorization_Intro"> +<!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="sect-Reference_Guide-Authentication_Authorization_Intro"> <title>Authentication and Authorization intro</title> <section id="sect-Reference_Guide-Authentication_Authorization_Intro-Authentication"> <title>Authentication Overview</title> @@ -611,4 +611,4 @@ </itemizedlist> </section> </section> -<!-- Ending section Authorization overview --></section> +<!-- Ending section Authorization overview --></chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,9 +1,9 @@ <?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"> +<!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; ]> -<section id="sect-Reference_Guide-Authentication_Token_Configuration"> +<chapter id="sect-Reference_Guide-Authentication_Token_Configuration"> <title>Authentication Token Configuration</title> <section id="sect-Reference_Guide-Authentication_Token_Configuration-The_Token_Service"> <title>The Token Service</title> @@ -98,4 +98,4 @@ </listitem> </orderedlist> </section> -</section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/BackendConfiguration.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,33 +1,31 @@ -<?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 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; ]> -<section id="sect-Reference_Guide-PicketLink_IDM_integration"> - <title>PicketLink IDM integration</title> - <para> +<chapter 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> + 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> + <note> + <para> It is important to fully understand the concepts behind this framework design before changing the default configuration. </para> - - </note> - <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> + <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> + <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> - - <!-- DOCS NOTE: The "Configuration Files" section has been commented out as the configuration parameters require more work than time allows before the 5.2.0 release. +<!-- DOCS NOTE: The "Configuration Files" section has been commented out as the configuration parameters require more work than time allows before the 5.2.0 release. The content of this section are entirely wrong and needs to be rewritten. The config file in the first programlisting has been updated to the version in EPP 5.2.0, however time constraints prevented this from being actioned before the 5.2.0 GA release. @@ -391,9 +389,4 @@ <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> --></chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/CoreOrganizationInitializer.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,10 +1,9 @@ <?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" [ - +<!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"> ]> -<section id="sect-CoreOrganizationInitializer"> - <title><remark>BZ#801424 </remark>Create Users and Groups without Organization API</title> +<chapter id="sect-CoreOrganizationInitializer"> + <title>Create Users and Groups without Organization API</title> <para>CoreOrganizationInitializer is a plug-in that creates users and groups outside the portal user interface, without the Organization API. The plug-in performs the function of the Organization API with regard to triggering listeners for users and groups at creation time. The plug-in prevents issues with missing JCR objects, resulting from incorrectly provisioned users and groups.</para> <para>The plug-in is particularly useful when using the Site Publisher add-on, and directly adding users or groups to a LDAP server through LDIF files, or into a database using SQL. </para> <section> @@ -212,4 +211,4 @@ </varlistentry> </variablelist> </section> -</section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/LDAP.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,9 +1,8 @@ <?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" [ - +<!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"> ]> -<section id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration"> +<chapter id="sect-Reference_Guide_eXo_JCR_1.14-LDAP_Integration"> <title>LDAP Integration</title> <note> <title>Notational Device</title> @@ -748,4 +747,4 @@ </programlistingco> </example> </section> -</section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/OrganizationAPI.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,126 +1,106 @@ -<?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 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; ]> -<section id="sect-Reference_Guide-Organization_API"> - <title>Organization API</title> - <para> - The <literal>exo.platform.services.organization</literal> package has five main components: - </para> - <variablelist> - <varlistentry> - <term>User</term> - <listitem> - <para> - The <literal>User</literal> component contains basic information about a user; such as username, password, first name, last name, and email address. - </para> +<chapter id="sect-Reference_Guide-Organization_API"> + <title>Organization API</title> + <para> + The <literal>exo.platform.services.organization</literal> package has five main components: + </para> + <variablelist> + <varlistentry> + <term>User</term> + <listitem> + <para> + The <literal>User</literal> component contains basic information about a user; such as username, password, first name, last name, and email address. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>User Profile</term> + <listitem> + <para> + The <literal>User Profile</literal> component contains extra information about a user, such as user&apos;s personal information, and business information. You can also add additional information about a user if your application requires it. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Group</term> + <listitem> + <para> + The <literal>Group</literal> component contains a group graph. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Membership Type</term> + <listitem> + <para> + The <literal>Membership Type</literal> component contains a list of predefined membership types. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>Membership</term> + <listitem> + <para> + The <literal>Membership</literal> component connects a User, a Group and a Membership Type. + </para> + <para> + A user can have one or more memberships within a group. For example: <emphasis>User A</emphasis> can have the &apos;<emphasis>member</emphasis>&apos; and &apos;<emphasis>admin</emphasis>&apos; memberships in group <emphasis>/user</emphasis>. A user belongs to a group if he has at least one membership in that group. + </para> + </listitem> + </varlistentry> + </variablelist> + <para> + The <literal>OrganizationService</literal> component is an additional component that serves as an entry point into the Organization API. It provides handling functionality for the five components. + </para> + <para> + <mediaobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/AuthenticationAndIdentity/OrganizationServiceClassDiagram.png" format="PNG"/> + </imageobject> + <imageobject role="fo"> + <imagedata align="center" scalefit="1" fileref="images/AuthenticationAndIdentity/OrganizationServiceClassDiagram.png" format="PNG"/> + </imageobject> + </mediaobject> - </listitem> - - </varlistentry> - <varlistentry> - <term>User Profile</term> - <listitem> - <para> - The <literal>User Profile</literal> component contains extra information about a user, such as user's personal information, and business information. You can also add additional information about a user if your application requires it. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Group</term> - <listitem> - <para> - The <literal>Group</literal> component contains a group graph. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Membership Type</term> - <listitem> - <para> - The <literal>Membership Type</literal> component contains a list of predefined membership types. - </para> - - </listitem> - - </varlistentry> - <varlistentry> - <term>Membership</term> - <listitem> - <para> - The <literal>Membership</literal> component connects a User, a Group and a Membership Type. - </para> - <para> - A user can have one or more memberships within a group. For example: <emphasis role="bold">User A</emphasis> can have the '<emphasis>member</emphasis>' and '<emphasis>admin</emphasis>' memberships in group <emphasis role="bold">/user</emphasis>. A user belongs to a group if he has at least one membership in that group. - </para> - - </listitem> - - </varlistentry> - - </variablelist> - <para> - The <literal>OrganizationService</literal> component is an additional component that serves as an entry point into the Organization API. It provides handling functionality for the five components. - </para> - <para> - <mediaobject> - <imageobject role="html"> - <imagedata align="center" fileref="images/AuthenticationAndIdentity/OrganizationServiceClassDiagram.png" format="PNG" /> - </imageobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/AuthenticationAndIdentity/OrganizationServiceClassDiagram.png" format="PNG" scalefit="1" /> - </imageobject> - - </mediaobject> - - </para> - <para> - By exposing the Organization API, the <literal>OrganizationService</literal> component provides developers with access to handler objects for managing each of the five components: - </para> - <itemizedlist> - <listitem> - <para> - UserHandler - </para> - - </listitem> - <listitem> - <para> - UserProfileHandler - </para> - - </listitem> - <listitem> - <para> - GroupHandler - </para> - - </listitem> - <listitem> - <para> - MembershipTypeHandler - </para> - - </listitem> - <listitem> - <para> - MembershipHandler - </para> - - </listitem> - - </itemizedlist> - <para> - The five central API components are designed to be similar to persistent entities and handlers are specified similarly to data access objects (DAO). - </para> - <para> - <emphasis>Organization API</emphasis> simply describes a contract, meaning it is not a concrete implementation. The described components are interfaces, allowing for different concrete implementations. In practical terms the existing implementation can be replaced with a different one. - </para> -</section> - - + </para> + <para> + By exposing the Organization API, the <literal>OrganizationService</literal> component provides developers with access to handler objects for managing each of the five components: + </para> + <itemizedlist> + <listitem> + <para> + UserHandler + </para> + </listitem> + <listitem> + <para> + UserProfileHandler + </para> + </listitem> + <listitem> + <para> + GroupHandler + </para> + </listitem> + <listitem> + <para> + MembershipTypeHandler + </para> + </listitem> + <listitem> + <para> + MembershipHandler + </para> + </listitem> + </itemizedlist> + <para> + The five central API components are designed to be similar to persistent entities and handlers are specified similarly to data access objects (DAO). + </para> + <para> + <emphasis>Organization API</emphasis> simply describes a contract, meaning it is not a concrete implementation. The described components are interfaces, allowing for different concrete implementations. In practical terms the existing implementation can be replaced with a different one. + </para> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PasswordEncryption.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,11 +1,11 @@ <?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 "Book_Name.ent"> +<!ENTITY % BOOK_ENTITIES SYSTEM "../../Reference_Guide.ent"> %BOOK_ENTITIES; ]> -<section id="sect-Reference_Guide-Authentication_and_Identity-Password_Encryption"> +<chapter id="sect-Reference_Guide-Authentication_and_Identity-Password_Encryption"> <title>Password Encryption</title> -<!-- The warning and first listitem below were relocated from sect-Reference_Guide-Authentication_Token_Configuration as security and plain-text password issues were being expanded on (from JBEPP-610) --> <warning> + <warning> <title>Username and passwords stored in clear text</title> <para> The <emphasis>Remember Me</emphasis> feature of JBoss Enterprise Portal Platform uses a token mechanism to be able to authenticate returning users without requiring an explicit login. However, to be able to authenticate these users, the token needs to store the username and password in clear text in the JCR. @@ -59,4 +59,4 @@ </procedure> </listitem> </orderedlist> -</section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/PredefinedUserConfiguration.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,9 +1,9 @@ <?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"> +<!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; ]> -<section id="sect-Reference_Guide-Predefined_User_Configuration"> +<chapter id="sect-Reference_Guide-Predefined_User_Configuration"> <title>Predefined User Configuration</title> <section id="sect-Reference_Guide-Predefined_User_Configuration-Overview"> <title>Overview</title> @@ -78,4 +78,4 @@ </note> <programlisting language="XML" role="XML"><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../extras/Authentication_Identity_PredefinedUserConfiguration/default101.xml" parse="text"/></programlisting> </section> -</section> +</chapter> Added: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml =================================================================== (Binary files differ) Property changes on: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SAML2.xml ___________________________________________________________________ Added: svn:mime-type + application/xml Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity/SSO.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -1,9 +1,9 @@ <?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"> +<!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; ]> -<section id="sect-Reference_Guide-SSO_Single_Sign_On"> +<chapter id="sect-Reference_Guide-SSO_Single_Sign_On"> <title>SSO - Single Sign On</title> <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Overview"> <title>Overview and Configuration Assumptions</title> @@ -62,10 +62,6 @@ Remove <filename>JBOSS_HOME/server/PROFILE/deploy/gatein-sample-extension.ear</filename> and <filename>JBOSS_HOME/server/PROFILE/deploy/gatein-sample-portal.ear</filename> which are packaged by default with JBoss Enterprise Portal Platform. </para> --> </warning> </section> - <section> - <title>SSO Conf</title> - <para/> - </section> <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Enabling_SSO_using_JBoss_SSO_Valve"> <title>Enabling SSO using JBoss SSO Valve</title> <!-- Source Metadata @@ -536,7 +532,7 @@ </para> </section> <section id="sect-Reference_Guide-SSO_Single_Sign_On_-Java_Open_Single_Sign_On_Project"> - <title><remark>BZ#794433</remark>Java Open Single Sign-On Project</title> + <title>Java Open Single Sign-On Project</title> <para>Configuring JOSSO for JBoss Enterprise Application Platform requires an Apache server instance to host JOSSO. JBoss Enterprise Application Platform communicates with the JOSSO Apache instance through the Single Sign On plug-in.</para> <para> This Single Sign On plug-in enables seamless integration between JBoss Enterprise Portal Platform and the Java Open Single Sign-On Project (JOSSO) Single Sign On Framework. Details about JOSSO can be found at <ulink url="http://www.josso.org"/> . @@ -1386,4 +1382,4 @@ </para> </section> </section> -</section> +</chapter> Modified: epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml =================================================================== --- epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2012-10-17 04:11:04 UTC (rev 8908) +++ epp/docs/branches/6.0/Reference_Guide/en-US/modules/AuthenticationAndIdentity.xml 2012-10-17 21:49:55 UTC (rev 8909) @@ -5,15 +5,4 @@ ]> <chapter id="chap-Reference_Guide-Authentication_and_Identity"> <title>Authentication and Identity</title> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/AuthenticationAuthorizationOverview.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/PasswordEncryption.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/PredefinedUserConfiguration.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/AuthenticationTokenConfiguration.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/BackendConfiguration.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/OrganizationAPI.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/AccessingUserProfile.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/SSO.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/LDAP.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/CoreOrganizationInitializer.xml" encoding="UTF-8"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="AuthenticationAndIdentity/SAML2.xml" encoding="UTF-8"/> </chapter>