portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dlest...@apache.org
Subject svn commit: r226940 - in /portals/jetspeed-2/trunk: components/prefs/xdocs/ components/prefs/xdocs/images/ components/profiler/xdocs/ components/rdbms/xdocs/ components/registry/xdocs/ components/search/xdocs/ components/security/xdocs/ components/sso/...
Date Tue, 02 Aug 2005 04:08:57 GMT
Author: dlestrat
Date: Mon Aug  1 21:08:47 2005
New Revision: 226940

URL: http://svn.apache.org/viewcvs?rev=226940&view=rev
Log:
Adding PDF documentation support.

Added:
    portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-c.gif   (with props)
    portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-schema.gif   (with
props)
    portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
Modified:
    portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/prefs/xdocs/tasks.xml
    portals/jetspeed-2/trunk/components/profiler/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/rdbms/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/registry/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/search/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/security/xdocs/hierarchy.xml
    portals/jetspeed-2/trunk/components/security/xdocs/high-level-services.xml
    portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/sso/xdocs/navigation.xml
    portals/jetspeed-2/trunk/components/web-content/xdocs/navigation.xml
    portals/jetspeed-2/trunk/content-server/xdocs/navigation.xml

Added: portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-c.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-c.gif?rev=226940&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-c.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-schema.gif
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-schema.gif?rev=226940&view=auto
==============================================================================
Binary file - no diff available.

Propchange: portals/jetspeed-2/trunk/components/prefs/xdocs/images/preferences-schema.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml?rev=226940&view=auto
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml (added)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/index.xml Mon Aug  1 21:08:47 2005
@@ -0,0 +1,115 @@
+<?xml version="1.0" ?>
+<!--
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
+    http://www.apache.org/licenses/LICENSE-2.0
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+<document>
+    <properties>
+        <title>Jetspeed 2 Preferences</title>
+    </properties>
+    <body>
+        <section name="Preferences Overview">
+            <p>
+                The
+                <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/prefs/Preferences.html">java.util.prefs.Preferences
API</a>
+                provides a generic mechanism for storing user and system preferences, as
well as configuration data. Jetspeed 2 relies on this API to provide a
+                wide ranging of functionality to higher level services. Some of the Jetspeed
components leveraging the
+                <code>java.util.prefs.Preferences</code>
+                API are:
+                <ul>
+                    <li>
+                        Portlet Preferences: Portlet preferences are stored in the system
preferences tree. The following path structure is used to establish
+                        the location of a given portlet preference in the preferences tree:
+                        <code>/portlet_application/${Portlet Application Name}/portlets/${Portlet
Name}/preferences/${Preference Name}/values</code>
+                        . The preferences values are stored under the
+                        <code>values</code>
+                        node as a map of key/values.
+                    </li>
+                    <li>
+                        User Attributes: User attributes are stored in the user preferences
tree as follow. The following path structure is used to stored a
+                        user's attributes:
+                        <code>/user/${User Name}/userinfo</code>
+                        . The user attributes are stored as a preferences key/values map
under the userinfo node.
+                    </li>
+                    <li>
+                        Roles and groups hierarchy: Documentation on how roles and groups
hierarchy use the
+                        <code>Preferences</code>
+                        model can be found in the
+                        <a href="/multiproject/jetspeed-security/hierarchy.html#Leveraging_Preferences_to_Manage_Hierarchies">security
section</a>
+                        of the documentation.
+                    </li>
+                </ul>
+            </p>
+        </section>
+        <section name="Preferences Implementation Overview">
+            <p>
+                Jetspeed 2
+                <code>Preferences</code>
+                implementation leverages the following classes:
+            </p>
+            <p>
+                <img src="images/preferences-c.gif" border="0" />
+            </p>
+            <table>
+                <tr>
+                    <th>Class</th>
+                    <th>Description</th>
+                </tr>
+                <tr>
+                    <td>
+                        <code>PreferencesFactoryImpl</code>
+                    </td>
+                    <td>
+                        Implements the <code>java.util.prefs.PreferencesFactory</code>
that generates 
+                        <code>Preferences</code> objects.  The <code>PreferencesFactoryImpl</code>
is 
+                        configured through spring assembly (<code>prefs.xml</code>)
to use a 
+                        <code>PreferencesProvider</code> that encapsalutes the
backing store implementation.
+
+                    </td>
+                </tr>
+                <tr>
+                    <td>
+                        <code>PreferencesImpl</code>
+                    </td>
+                    <td>
+                        Extends the <code>java.util.prefs.AbstractPreferences</code>
and implements the SPI by
+                        leveraging the <code>PreferencesProvider</code> API.
 Jetspeed <code>Preferences</code>
+                        implementation can be configured to validate that preferences map
key/values are created
+                        for predefined keys.  A <code>PropertyManager</code>
enforces the checks if enabled.
+                    </td>
+                </tr>
+                <tr>
+                    <td>
+                        <code>PreferencesProvider</code>
+                    </td>
+                    <td>
+                        Encapsulates the preferences implementation again a specific backing
store.  In Jetspeed 2, the
+                        default implementation is provided by 
+                        <code>org.apache.jetspeed.prefs.impl.PersistenceBrokerPreferencesProvider</code>
+                    </td>
+                </tr>
+            </table>
+            <subsection name="Preferences Database Schema">
+                <p>
+                    The following database schema is being used in Jetspeed 2 to store <code>Preferences</code>

+                    in a relational database model.
+                </p>
+                <p>
+                    <img src="images/preferences-schema.gif" border="0"/>
+                </p>
+            </subsection>    
+        </section>
+    </body>
+</document>
+

Modified: portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/navigation.xml Mon Aug  1 21:08:47 2005
@@ -1,26 +1,29 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-    <menu name="Misc.">
-      <item name="Tasks" href="tasks.html"/>
-    </menu>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-prefs.pdf" img="../../images/pdf.gif"
/>
+        </links>
+        <menu name="Misc.">
+            <item name="Preferences Overview" href="index.html" />
+            <item name="Tasks" href="tasks.html" />
+        </menu>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/prefs/xdocs/tasks.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/prefs/xdocs/tasks.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/prefs/xdocs/tasks.xml (original)
+++ portals/jetspeed-2/trunk/components/prefs/xdocs/tasks.xml Mon Aug  1 21:08:47 2005
@@ -21,14 +21,7 @@
   <body>
     <section name="Tasks">
       <p>
-        Currently this is just a listing of tasks.
-      </p>
-      <p>
-        <ul>
-<li>
-  Remove unused classes.
-</li>
-        </ul>
+        See <a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10492">JIRA</a>
for a list of tasks.
       </p>
     </section>
   </body>

Modified: portals/jetspeed-2/trunk/components/profiler/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/profiler/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/profiler/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/profiler/xdocs/navigation.xml Mon Aug  1 21:08:47
2005
@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-profiler.pdf" img="../../images/pdf.gif"
/>
+        </links>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/rdbms/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/rdbms/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/rdbms/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/rdbms/xdocs/navigation.xml Mon Aug  1 21:08:47 2005
@@ -1,26 +1,28 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-    <menu name="Misc.">
-      <item name="Tasks" href="tasks.html"/>
-    </menu>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-rdbms.pdf" img="../../images/pdf.gif"
/>
+        </links>
+        <menu name="Misc.">
+            <item name="Tasks" href="tasks.html" />
+        </menu>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/registry/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/registry/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/registry/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/registry/xdocs/navigation.xml Mon Aug  1 21:08:47
2005
@@ -1,26 +1,28 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-    <menu name="Misc.">
-      <item name="Tasks" href="tasks.html"/>
-    </menu>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-registry.pdf" img="../../images/pdf.gif"
/>
+        </links>
+        <menu name="Misc.">
+            <item name="Tasks" href="tasks.html" />
+        </menu>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/search/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/search/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/search/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/search/xdocs/navigation.xml Mon Aug  1 21:08:47 2005
@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-search.pdf" img="../../images/pdf.gif"
/>
+        </links>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/security/xdocs/hierarchy.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/security/xdocs/hierarchy.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/security/xdocs/hierarchy.xml (original)
+++ portals/jetspeed-2/trunk/components/security/xdocs/hierarchy.xml Mon Aug  1 21:08:47 2005
@@ -79,7 +79,7 @@
             </p>
             <p>
                 See Jetspeed 2
-                <a href="/multiproject/jetspeed-prefs/index.html">Preferences implementation
section</a>
+                <a href="../../multiproject/jetspeed-prefs/index.html">Preferences
implementation section</a>
                 for more information.
             </p>
             <subsection name="How does this work?">
@@ -122,7 +122,7 @@
                     Group and roles hierarchy are stored in the
                     <code>Preferences</code>
                     layer as follow (the output of <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/util/prefs/Preferences.html#exportNode(java.io.OutputStream)">
-                    exportNode()</a> for Jetspeed's RBMS <code>Preferences</code>
implementation):
+                    exportNode()</a> for <a href="/multiprojectjetspeed-prefs/index.html">Jetspeed's
RBMS Preferences</a> implementation):
                     <source>
                         <![CDATA[
 <preferences EXTERNAL_XML_VERSION="1.0">

Modified: portals/jetspeed-2/trunk/components/security/xdocs/high-level-services.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/security/xdocs/high-level-services.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/security/xdocs/high-level-services.xml (original)
+++ portals/jetspeed-2/trunk/components/security/xdocs/high-level-services.xml Mon Aug  1
21:08:47 2005
@@ -1,29 +1,97 @@
 <?xml version="1.0" ?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <document>
-  <properties>
-    <title>Jetspeed 2 Security - High Level Security Services</title>
-  </properties>
-  <body>
-    <section name="High Level Security Services Overview">
-      <p>
-        To do.
-      </p>
-    </section>
-  </body>
+    <properties>
+        <title>Jetspeed 2 Security - High Level Security Services</title>
+    </properties>
+    <body>
+        <section name="High Level Security Services Overview">
+            <p>
+                Jetspeed 2 provides the four following high level security services:
+                <ul>
+                    <li>
+                        <code>UserManager</code>
+                        : Service providing user management capabilities.
+                    </li>
+                    <li>
+                        <code>GroupManager</code>
+                        : Service providing group management capabilities.
+                    </li>
+                    <li>
+                        <code>RoleManager</code>
+                        : Service providing role management capabilities.
+                    </li>
+                    <li>
+                        <code>PermissionManager</code>
+                        : Service providing permission management capabilities.
+                    </li>
+                </ul>
+            </p>
+        </section>
+        <section name="Using High Level Security Services in Portlets">
+            <p>
+                In order to access Jetspeed high level security services in your portlets,
Jetspeed provide a custom
+                extension to the <code>portlet.xml</code> metadata.  All Jetspeed
custom metadata is located in the 
+                <code>jetspeed-portlet.xml</code> configuration file in the <code>WEB-INF</code>
folder of the portlet
+                application.  The custom <code>js:services</code> tag provides
the ability to expose portal services
+                to a portlet through the <code>javax.portlet.PortletContext</code>.
+            </p>
+            <p>
+                Jetspeed portal services are configured in the spring assembly file located
in the portal 
+                <code>WEB-INF/assembly/jetspeed-services</code> configuration
file.  The UserManager for instance
+                is configured as follow:
+                <source><![CDATA[
+<!-- Portlet Services  -->
+<bean id="PortalServices" 
+  	 class="org.apache.jetspeed.services.JetspeedPortletServices" >
+   <constructor-arg>
+      <map>
+  	     ...
+  	     <entry key="UserManager">
+  	   	    <ref bean="org.apache.jetspeed.security.UserManager"/>
+  	   	 </entry>
+  	   	 ...
+      </map>
+   </constructor-arg>
+</bean>]]>
+                </source>
+            </p>
+            <p>
+                The <code>UserManager</code> services is then available to be
loaded in a specific portlet
+                <code>PortletContext</code>.  Portlet developers need to specify
the portal services they
+                would like to use.  The following example shows how to expose the portal
<code>UserManager</code> 
+                to a portlet application:
+                <source><![CDATA[
+<js:services>
+   <js:service name='UserManager'/>
+</js:services>]]>
+                </source>   
+            </p>
+            <p>
+                Once a portal service is loaded in the portlet context, the portlet implementation
(which typically
+                extends <code>javax.portlet.GenericPortlet</code>) can access
the service as follow:
+                <source><![CDATA[
+PortletContext context = getPortletContext();
+userManager = (UserManager) context.getAttribute(CommonPortletServices.CPS_USER_MANAGER_COMPONENT);
+]]>
+                </source>
+                where <code>CommonPortletServices.CPS_USER_MANAGER_COMPONENT = "cps:UserManager"</code>
+            </p>
+        </section>
+    </body>
 </document>
 

Modified: portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/security/xdocs/navigation.xml Mon Aug  1 21:08:47
2005
@@ -18,20 +18,22 @@
     <body>
         <links>
             <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-security.pdf" img="../../images/pdf.gif"
/>
         </links>
         <menu name="Jetspeed 2 Security Documentation">
             <item name="Overview" href="index.html" />
-            <item name="Architecture Overview" href="arch.html"/>
+            <item name="Architecture Overview" href="arch.html" />
             <item name="Authentication" href="atn.html">
                 <item name="Login Module" href="login-module.html" />
-                <item name="Authentication SPI" href="atn-spi.html"/>
-                <item name="Credentials Management" href="credentials.html"/>
+                <item name="Authentication SPI" href="atn-spi.html" />
+                <item name="Credentials Management" href="credentials.html" />
             </item>
             <item name="Authorization" href="atz.html">
-                <item name="JAAS Authorization" href="atz-jaas.html"/>
-                <item name="PermissionManager Overview" href="permission.html"/>
-                <item name="Authorization/Security Mapping SPI" href="atz-spi.html"/>
-                <item name="Hierarchy Management" href="hierarchy.html"/>
+                <item name="JAAS Authorization" href="atz-jaas.html" />
+                <item name="PermissionManager Overview" href="permission.html" />
+                <item name="Authorization/Security Mapping SPI" href="atz-spi.html" />
+                <item name="Hierarchy Management" href="hierarchy.html" />
             </item>
             <item name="High Level Security Services" href="high-level-services.html"
/>
             <item name="Security Services Configuration" href="config.html" />

Modified: portals/jetspeed-2/trunk/components/sso/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/sso/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/sso/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/sso/xdocs/navigation.xml Mon Aug  1 21:08:47 2005
@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-sso.pdf" img="../../images/pdf.gif"
/>
+        </links>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/components/web-content/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/components/web-content/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/components/web-content/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/components/web-content/xdocs/navigation.xml Mon Aug  1 21:08:47
2005
@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/jetspeed-web-content.pdf" img="../../images/pdf.gif"
/>
+        </links>
+    </body>
 </project>

Modified: portals/jetspeed-2/trunk/content-server/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/portals/jetspeed-2/trunk/content-server/xdocs/navigation.xml?rev=226940&r1=226939&r2=226940&view=diff
==============================================================================
--- portals/jetspeed-2/trunk/content-server/xdocs/navigation.xml (original)
+++ portals/jetspeed-2/trunk/content-server/xdocs/navigation.xml Mon Aug  1 21:08:47 2005
@@ -1,26 +1,28 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
 <!--
-Copyright 2004 The Apache Software Foundation
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
+    Copyright 2004 The Apache Software Foundation
+    
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+    
     http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+    
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
 -->
 <project>
-  <body>
-    <links>
-      <item name="Jetspeed 2" href="../../index.html"/>
-    </links>
-    <menu name="Misc.">
-      <item name="Tasks" href="tasks.html"/>
-    </menu>
-  </body>
+    <body>
+        <links>
+            <item name="Jetspeed 2" href="../../index.html" />
+            <!-- Cannot access ${pom.id}... Hard coding pdf name. -->
+            <item name="PDF Documentation" href="/content-server.pdf" img="../../images/pdf.gif"
/>
+        </links>
+        <menu name="Misc.">
+            <item name="Tasks" href="tasks.html" />
+        </menu>
+    </body>
 </project>



---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org


Mime
View raw message