From do-not-reply at jboss.org Mon Apr 12 12:02:27 2010
Content-Type: multipart/mixed; boundary="===============0255032625386498209=="
MIME-Version: 1.0
From: do-not-reply at jboss.org
To: gatein-commits at lists.jboss.org
Subject: [gatein-commits] gatein SVN: r2590 - in
 portal/trunk/docs/reference-guide/en: modules and 1 other directory.
Date: Mon, 12 Apr 2010 12:02:27 -0400
Message-ID: <201004121602.o3CG2RoG012660@svn01.web.mwc.hst.phx2.redhat.com>

--===============0255032625386498209==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable

Author: mstruk
Date: 2010-04-12 12:02:26 -0400 (Mon, 12 Apr 2010)
New Revision: 2590

Added:
   portal/trunk/docs/reference-guide/en/modules/APIs.xml
Modified:
   portal/trunk/docs/reference-guide/en/master.xml
Log:
Added a short chapter on Organization API

Modified: portal/trunk/docs/reference-guide/en/master.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- portal/trunk/docs/reference-guide/en/master.xml	2010-04-12 11:39:54 UTC=
 (rev 2589)
+++ portal/trunk/docs/reference-guide/en/master.xml	2010-04-12 16:02:26 UTC=
 (rev 2590)
@@ -1,13 +1,13 @@
-<?xml version=3D"1.0" encoding=3D"UTF-8"?>
-<!DOCTYPE book 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;
+<?xml version=3D"1.0" encoding=3D"UTF-8"?>
+<!DOCTYPE book 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;
 ]>
 =

-<book lang=3D"en">
-	<bookinfo>
-		<title>GateIn Reference Guide</title>
+<book lang=3D"en">
+	<bookinfo>
+		<title>GateIn Reference Guide</title>
 		<subtitle>
 <!--
 LT 20010312: could not find a way to configure image scaling properly (tri=
ed width, scale, etc...). Feel free to investigate.
@@ -21,7 +21,7 @@
 				</imageobject>
 			</mediaobject>
 =

-               </subtitle>
+               </subtitle>
 =

 =

 		<authorgroup>
@@ -37,42 +37,42 @@
 			      <firstname>eXo Platform</firstname>
 			      <surname></surname>
 			   </author>
-
-			<editor>
-				<firstname>Scott</firstname>
-				<surname>Mumford</surname>
-				<affiliation>
-					<shortaffil>Red Hat</shortaffil>
-					<orgdiv>Engineering Content Services</orgdiv>
-				</affiliation>
-				<email>smumford(a)redhat.com</email>
-			</editor>
-			<editor>
-				<firstname>Thomas</firstname>
-				<surname>Heute</surname>
-				<affiliation>
-					<shortaffil>Red Hat</shortaffil>
-					<orgdiv>JBoss Engineering</orgdiv>
-				</affiliation>
-				<email>theute(a)redhat.com</email>
-			</editor>
-			<editor>
-				<firstname>Luc</firstname>
-				<surname>Texier</surname>
-				<affiliation>
+
+			<editor>
+				<firstname>Scott</firstname>
+				<surname>Mumford</surname>
+				<affiliation>
 					<shortaffil>Red Hat</shortaffil>
-                                        <orgdiv>JBoss Engineering, Managem=
ent</orgdiv>
-				</affiliation>
-				<email>ltexier(a)redhat.com</email>
+					<orgdiv>Engineering Content Services</orgdiv>
+				</affiliation>
+				<email>smumford(a)redhat.com</email>
 			</editor>
-<!--
-			<othercredit>
-				<affiliation>
-					<orgname><emphasis role=3D"bold"><ulink type=3D"http" url=3D"http://w=
ww.jboss.org/gatein/">GateIn Portal</ulink></emphasis> and <emphasis role=
=3D"bold"><ulink type=3D"http" url=3D"http://www.exoplatform.com/portal/pub=
lic/website/">Exo Platform</ulink></emphasis> teams</orgname>
-				</affiliation>
-				<contrib>Original product documentation by:</contrib>
+			<editor>
+				<firstname>Thomas</firstname>
+				<surname>Heute</surname>
+				<affiliation>
+					<shortaffil>Red Hat</shortaffil>
+					<orgdiv>JBoss Engineering</orgdiv>
+				</affiliation>
+				<email>theute(a)redhat.com</email>
+			</editor>
+			<editor>
+				<firstname>Luc</firstname>
+				<surname>Texier</surname>
+				<affiliation>
+					<shortaffil>Red Hat</shortaffil>
+                                        <orgdiv>JBoss Engineering, Managem=
ent</orgdiv>
+				</affiliation>
+				<email>ltexier(a)redhat.com</email>
+			</editor>
+<!--
+			<othercredit>
+				<affiliation>
+					<orgname><emphasis role=3D"bold"><ulink type=3D"http" url=3D"http://w=
ww.jboss.org/gatein/">GateIn Portal</ulink></emphasis> and <emphasis role=
=3D"bold"><ulink type=3D"http" url=3D"http://www.exoplatform.com/portal/pub=
lic/website/">Exo Platform</ulink></emphasis> teams</orgname>
+				</affiliation>
+				<contrib>Original product documentation by:</contrib>
 			</othercredit>
--->
+-->
 		</authorgroup>
 =

 =

@@ -143,6 +143,9 @@
    <!-- WSRP -->
    <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"module=
s/WSRP.xml"/>
 =

+   <!-- APIs -->
+   <xi:include xmlns:xi=3D"http://www.w3.org/2001/XInclude" href=3D"module=
s/APIs.xml"/>
+
    <!--
        11_Support
        http://www.exoplatform.com/portal/public/en/forum?portal:componentI=
d=3Dforum&portal:type=3Daction&portal:isSecure=3Dfalse&uicomponent=3DUIBrea=
dcumbs&op=3DChangePath&objectId=3DforumCategory88afa455c0a8020100a6752323da=
4b60

Added: portal/trunk/docs/reference-guide/en/modules/APIs.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- portal/trunk/docs/reference-guide/en/modules/APIs.xml	                 =
       (rev 0)
+++ portal/trunk/docs/reference-guide/en/modules/APIs.xml	2010-04-12 16:02:=
26 UTC (rev 2590)
@@ -0,0 +1,42 @@
+<?xml version=3D'1.0' encoding=3D'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=3D"chap-Reference_Guide-APIs">
+	<title>APIs</title>
+	<section id=3D"sect-Reference_Guide-APIs-Organization_API">
+		<title>Organization API</title>
+		<para>
+         The <literal>exo.platform.services.organization</literal> package=
 has five main components: user, user profile, group, membership type and m=
embership.
+         There is an additional component that serves as an entry point in=
to Organization API - <literal>OrganizationService</literal> component,
+         that provides handling functionality for the five components.
+      </para>
+      <para>
+         The <literal>User</literal> component contains basic information =
about a user - such as
+         username, password, first name, last name, and email. The <litera=
l>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 appl=
ication requires it.
+         The <literal>Group</literal> component contains a group graph. Th=
e <literal>Membership Type</literal> component
+         contains a list of predefined membership types.
+         Finally, the <literal>Membership</literal> component connects a U=
ser, a Group and a Membership Type.
+      </para>
+      <para>
+         A user can have one or more memberships within a group, for examp=
le: user A can have the 'member' and 'admin' memberships in group /user.
+         A user belongs to a group if he has at least one membership in th=
at group.
+      </para>
+      <para>
+         Exposing the Organization API to developers the OrganizationServi=
ce component provides developers with access
+         to handler objects for managing each of the five components - Use=
rHandler, UserProfileHandler, GroupHandler, MembershipTypeHandler, and Memb=
ershipHandler.
+      </para>
+      <para>
+         The five central API components are really designed like persiste=
nt entities, and handlers are really specified like data access objects (DA=
O).
+      </para>
+      <para>
+         Organization API simply describes a contract, meaning it is not a=
 concrete implementation. The described components are interfaces,
+         allowing for different concrete implementations. In practial term=
s that means, you can replace the existing implementation with a different =
one.
+      </para>
+	</section>
+
+</chapter>
+


--===============0255032625386498209==--