You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by at...@apache.org on 2007/03/04 03:13:24 UTC
svn commit: r514329 [1/7] - in /portals/jetspeed-2/trunk/xdocs: ./ guides/
style/
Author: ate
Date: Sat Mar 3 18:13:22 2007
New Revision: 514329
URL: http://svn.apache.org/viewvc?view=rev&rev=514329
Log:
no content change, just setting svn:eol-style native
Modified:
portals/jetspeed-2/trunk/xdocs/download.xml (props changed)
portals/jetspeed-2/trunk/xdocs/faq.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/features.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml (props changed)
portals/jetspeed-2/trunk/xdocs/getting-started-installer.xml (props changed)
portals/jetspeed-2/trunk/xdocs/getting-started-source.xml (props changed)
portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-app-servers.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-components.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-database.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-decorators.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-dir-structure.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-j2-development.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-jpt.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-l10n.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-layouts.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-migration.xml (props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-pipeline.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-portal-assembly.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-portal-design.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-portlet-bridges.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-profiler.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-profiling-ip.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-properties.xml (props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-psml.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-security-declarative-psml.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-security.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-simple-jsf-portlet.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-simple-portlet.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-simple-velocity-portlet.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-site.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-sso.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-tomcat-sso-cross-context-j2-realm.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/guides/guide-user-attributes.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/how-to-help.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/j1-users.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/jetspeed-eclipse.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/portlets-community.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/release-notes.xml (props changed)
portals/jetspeed-2/trunk/xdocs/style/maven-j2.css (contents, props changed)
portals/jetspeed-2/trunk/xdocs/style/project.css (contents, props changed)
portals/jetspeed-2/trunk/xdocs/supporting-projects.xml (contents, props changed)
portals/jetspeed-2/trunk/xdocs/who-uses-j2.xml (props changed)
Propchange: portals/jetspeed-2/trunk/xdocs/download.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/faq.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/faq.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/faq.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/faq.xml Sat Mar 3 18:13:22 2007
@@ -1,30 +1,30 @@
-<?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>Frequently Asked Questions</title>
- <subtitle>Jetspeed-2 FAQs</subtitle>
- <authors>
- <person name="David Le Strat" email="dlestrat@apache.org" />
- </authors>
- </properties>
- <body>
- <section name="FAQs">
- </section>
- </body>
-</document>
-
+<?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>Frequently Asked Questions</title>
+ <subtitle>Jetspeed-2 FAQs</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="FAQs">
+ </section>
+ </body>
+</document>
+
Propchange: portals/jetspeed-2/trunk/xdocs/faq.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/features.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/features.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/features.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/features.xml Sat Mar 3 18:13:22 2007
@@ -1,180 +1,179 @@
-<?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>Features</title>
- <subtitle>Features</subtitle>
- <authors>
- <person name="David Le Strat" email="dlestrat@apache.org" />
- <person name="Marky Goldstein" email="ready@rosa.com" />
- <person name="David Sean Taylor" email="taylor@apache.org" />
- </authors>
- </properties>
- <body>
- <section name="Features">
-<p>
- The Apache Portals Jetspeed Team is pleased to present the Jetspeed-2 Open Source Enterprise Portal. This open source project has matured past several releases,
- and has been fully-compliant with the Portlet Specification 1.0 (JSR-168) since version 2.0.
- Jetspeed-2 has passed the TCK (Test Compatibility Kit) suite and is fully CERTIFIED to the Java Portlet Standard.
- </p>
- <subsection name="Standardized">
- <ul>
- <li>Fully compliant with Java Portlet API Standard 1.0 (JSR 168)</li>
- <li>Passed JSR-168 TCK Compatibility Test Suite</li>
- <li>J2EE Security based on JAAS Standard, JAAS DB Portal Security Policy</li>
- <li>LDAP Support for User Authentication</li>
- </ul>
+<?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>Features</title>
+ <subtitle>Features</subtitle>
+ <authors>
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Marky Goldstein" email="ready@rosa.com" />
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Features">
+ <p>
+ The Apache Portals Jetspeed Team is pleased to present the Jetspeed-2 Open Source Enterprise Portal. This open source project has matured past several releases,
+ and has been fully-compliant with the Portlet Specification 1.0 (JSR-168) since version 2.0.
+ Jetspeed-2 passes the TCK (Test Compatibility Kit) suite and is fully CERTIFIED to the Java Portlet Standard.
+ </p>
+ <subsection name="Standardized">
+ <ul>
+ <li>Fully compliant with Java Portlet API Standard 1.0 (JSR 168)</li>
+ <li>Passed JSR-168 TCK Compatibility Test Suite</li>
+ <li>J2EE Security based on JAAS Standard, JAAS DB Portal Security Policy</li>
+ <li>LDAP Support for User Authentication</li>
+ </ul>
</subsection>
<subsection name='Portal Engine Features'>
- <ul>
- <li>The Jetspeed Portal - Server-Side Parallel JSR-168 Portlet Rendering Engine</li>
- <li>The Jetspeed Desktop - Web 2.0 Client-Side JSR-168 Portlet Rendering Engine</li>
- <li>Full Support for JSR-168 Portlet Caching and per portlet cache configuration</li>
- <li>Portlet Timeout Tracking with mimimal render time limits</li>
- <li>Portlet Service Manager for automated removal of slow or dead portlets.</li>
- </ul>
+ <ul>
+ <li>The Jetspeed Portal - Server-Side Parallel JSR-168 Portlet Rendering Engine</li>
+ <li>The Jetspeed Desktop - Web 2.0 Client-Side JSR-168 Portlet Rendering Engine</li>
+ <li>Full Support for JSR-168 Portlet Caching and per portlet cache configuration</li>
+ <li>Portlet Timeout Tracking with mimimal render time limits</li>
+ <li>Portlet Service Manager for automated removal of slow or dead portlets.</li>
+ </ul>
</subsection>
<subsection name="Customization Features">
- <ul>
- <li>Portal Page Customizer</li>
- <li>Desktop Page Customizer</li>
- <li>Nested Fragment Customization</li>
- <li>Drag and drop moving of portlets</li>
- <li>Resizing of desktop portlet windows</li>
- <li>Portlet Selector with Portlet Categorizations, Full-Text Search of Portlets</li>
- <li>Customizable Themes (Skins)</li>
- </ul>
+ <ul>
+ <li>Portal Page Customizer</li>
+ <li>Desktop Page Customizer</li>
+ <li>Nested Fragment Customization</li>
+ <li>Drag and drop moving of portlets</li>
+ <li>Resizing of desktop portlet windows</li>
+ <li>Portlet Selector with Portlet Categorizations, Full-Text Search of Portlets</li>
+ <li>Customizable Themes (Skins)</li>
+ </ul>
</subsection>
<subsection name='Security'>
- <ul>
- <li>Portlet-level Security checks based on Security Constraints or Security Permissions</li>
- <li>Declarative Security Constraints and JAAS Database Security Policy</li>
- <li>Fully swappable Security Constraint or Security Permission support</li>
- <li>Jetspeed SSO (Single Sign-on)</li>
- <li>Delegation of Security</li>
- </ul>
+ <ul>
+ <li>Portlet-level Security checks based on Security Constraints or Security Permissions</li>
+ <li>Declarative Security Constraints and JAAS Database Security Policy</li>
+ <li>Fully swappable Security Constraint or Security Permission support</li>
+ <li>Jetspeed SSO (Single Sign-on)</li>
+ <li>Delegation of Security</li>
+ </ul>
</subsection>
<subsection name="Distributed Cluster Support">
- <ul>
- <li>Jetspeed Distributed Cluster - support for distributed deployments of the portal on multiple application server platforms</li>
- <li>Distributed Cache for portal components including preferences, registry and portlet entities.</li>
- <li>Distributed invalidation of portlet cache</li>
- </ul>
+ <ul>
+ <li>Jetspeed Distributed Cluster - support for distributed deployments of the portal on multiple application server platforms</li>
+ <li>Distributed Cache for portal components including preferences, registry and portlet entities.</li>
+ <li>Distributed invalidation of portlet cache</li>
+ </ul>
</subsection>
<subsection name="Foundation Component Architecture">
- <ul>
- <li>Spring-based Components and Scalable Architecture</li>
- <li>Configurable Pipeline Request Processor</li>
- <li>Auto Deployment of Portlet Applications</li>
- <li>Jetspeed Component Java API</li>
- <li>Jetspeed AJAX XML API</li>
- <li>PSML: Extended Portlet Site Markup Language
- <ul><li>Database Persistent</li>
- <li>Content Management Facilities</li>
- <li>Security Constraints</li></ul>
- </li>
- <li>Full security maintenance using LDAP is now supported for many LDAP providers</li>
- </ul>
- </subsection>
+ <ul>
+ <li>Spring-based Components and Scalable Architecture</li>
+ <li>Configurable Pipeline Request Processor</li>
+ <li>Auto Deployment of Portlet Applications</li>
+ <li>Jetspeed Component Java API</li>
+ <li>Jetspeed AJAX XML API</li>
+ <li>PSML: Extended Portlet Site Markup Language
+ <ul><li>Database Persistent</li>
+ <li>Content Management Facilities</li>
+ <li>Security Constraints</li></ul>
+ </li>
+ <li>Full security maintenance using LDAP is now supported for many LDAP providers</li>
+ </ul>
+ </subsection>
<subsection name="Portal Core Features">
- <ul>
- <li>Runtime Portlet API Standard Role-based Security</li>
- <li>Portal Content Management and Navigations: Pages, Menus, Folders, Links</li>
- <li>PSML Folder CMS Navigations, Menus, Links</li>
- <li>Rules-based Profiler for page and resource location</li>
- <li>Role-based Aggregation of Visible Pages</li>
- <li>Integrates with most popular databases including Derby, MySQL, MS SQL, Postgres, Oracle, DB2</li>
- <li>Client independent capability engine (html, xhtml, wml,vml)</li>
- <li>Internationalization: Localized Portal Resources in 12 Languages</li>
- <li>Statistics Logging Engine</li>
- <li>Portlet Registry</li>
- <li>Full Text Search of Portlet Resources with Lucene</li>
- <li>User Registration</li>
- <li>Forgotten Password</li>
- <li>Rich Login and Password Configuration Management</li>
- <li>Custom Portlet Modes and Window States - a "print" PortletMode and "solo" WindowState are now standard supported</li>
- </ul>
- </subsection>
- <subsection name="Administrative Portlets">
- <ul>
- <li>User, Role, Group, Password, and Profile Management</li>
- <li>Portal Site Manager</li>
- <li>Remote Portal Application Deployer (RPAD) - hot deploy portlet applications from remote locations on the Web</li>
- <li>JSR 168 Generic User Attributes Editor</li>
- <li>JSR 168 Preferences Editor</li>
- <li>SSO Manager</li>
- <li>Permission Management (JAAS Security)</li>
- <li>Security Constraints Management</li>
- <li>Portlet Application and Lifecycle Management</li>
- <li>Profiler Administration</li>
- <li>Statistics Reports</li>
- <li>Portlet Out of Service Manager</li>
- </ul>
- </subsection>
- <subsection name="Web Framework Support and Sample Portlets">
- <ul>
- <li>Bridges to other Web Frameworks: JSF, Struts, PHP, Perl, Velocity</li>
- <li>Sample Portlets:
- <ul><li>RSS, IFrame, Calendar XSLT, Struts Petstore, Bookmark, Database Browser</li>
- <li>Integration with Display Tags, Spring MVC</li></ul>
- </li>
- </ul>
- </subsection>
+ <ul>
+ <li>Runtime Portlet API Standard Role-based Security</li>
+ <li>Portal Content Management and Navigations: Pages, Menus, Folders, Links</li>
+ <li>PSML Folder CMS Navigations, Menus, Links</li>
+ <li>Rules-based Profiler for page and resource location</li>
+ <li>Role-based Aggregation of Visible Pages</li>
+ <li>Integrates with most popular databases including Derby, MySQL, MS SQL, Postgres, Oracle, DB2</li>
+ <li>Client independent capability engine (html, xhtml, wml,vml)</li>
+ <li>Internationalization: Localized Portal Resources in 12 Languages</li>
+ <li>Statistics Logging Engine</li>
+ <li>Portlet Registry</li>
+ <li>Full Text Search of Portlet Resources with Lucene</li>
+ <li>User Registration</li>
+ <li>Forgotten Password</li>
+ <li>Rich Login and Password Configuration Management</li>
+ <li>Custom Portlet Modes and Window States - a "print" PortletMode and "solo" WindowState are now standard supported</li>
+ </ul>
+ </subsection>
+ <subsection name="Administrative Portlets">
+ <ul>
+ <li>User, Role, Group, Password, and Profile Management</li>
+ <li>Portal Site Manager</li>
+ <li>Remote Portal Application Deployer (RPAD) - hot deploy portlet applications from remote locations on the Web</li>
+ <li>JSR 168 Generic User Attributes Editor</li>
+ <li>JSR 168 Preferences Editor</li>
+ <li>SSO Manager</li>
+ <li>Permission Management (JAAS Security)</li>
+ <li>Security Constraints Management</li>
+ <li>Portlet Application and Lifecycle Management</li>
+ <li>Profiler Administration</li>
+ <li>Statistics Reports</li>
+ <li>Portlet Out of Service Manager</li>
+ </ul>
+ </subsection>
+ <subsection name="Web Framework Support and Sample Portlets">
+ <ul>
+ <li>Bridges to other Web Frameworks: JSF, Struts, PHP, Perl, Velocity</li>
+ <li>Sample Portlets:
+ <ul><li>RSS, IFrame, Calendar XSLT, Struts Petstore, Bookmark, Database Browser</li>
+ <li>Integration with Display Tags, Spring MVC</li></ul>
+ </li>
+ </ul>
+ </subsection>
<subsection name='Data Migration Features'>
- <ul>
- <li>XML Import/Export Utility for all Jetspeed database data to support data migration over versions</li>
- <li>All initial portal data seeded with XML</li>
- <li>XML Schemas for all XML content</li>
- </ul>
- </subsection>
- <subsection name="Portal Design Features">
- <ul>
- <li>Deployment Jetspeed Portlet and Page Skins (Decorators) CSS Components</li>
- <li>Configurable CSS Page Layouts</li>
- <li>Easy to Use Velocity Macro Language for Skin and Layout Components</li>
- </ul>
- </subsection>
- <subsection name="Development Tools">
- <ul>
- <li>Automated Maven-1 Build</li>
- <li>Automated Maven-2 Build</li>
- <li>Jetspeed-2 Maven Plugin for Custom Portal Development</li>
- <li>Maven-2 Profiles and Archetypes</li>
- <li>AutoDeployment of Portlet Applications, Portal Resources</li>
- <li>Deployment Tools</li>
- <li>Plugin Goals integrated with Auto Deployment Feature</li>
- <li>XML Schemas for PSML, jetspeed-portlet.xml, and Jetspeed XML (seed data)</li>
- </ul>
+ <ul>
+ <li>XML Import/Export Utility for all Jetspeed database data to support data migration over versions</li>
+ <li>All initial portal data seeded with XML</li>
+ <li>XML Schemas for all XML content</li>
+ </ul>
+ </subsection>
+ <subsection name="Portal Design Features">
+ <ul>
+ <li>Deployment Jetspeed Portlet and Page Skins (Decorators) CSS Components</li>
+ <li>Configurable CSS Page Layouts</li>
+ <li>Easy to Use Velocity Macro Language for Skin and Layout Components</li>
+ </ul>
+ </subsection>
+ <subsection name="Development Tools">
+ <ul>
+ <li>Automated Maven-1 Build</li>
+ <li>Automated Maven-2 Build</li>
+ <li>Jetspeed-2 Maven Plugin for Custom Portal Development</li>
+ <li>Maven-2 Profiles and Archetypes</li>
+ <li>AutoDeployment of Portlet Applications, Portal Resources</li>
+ <li>Deployment Tools</li>
+ <li>Plugin Goals integrated with Auto Deployment Feature</li>
+ <li>XML Schemas for PSML, jetspeed-portlet.xml, and Jetspeed XML (seed data)</li>
+ </ul>
</subsection>
<subsection name='Other Features'>
- <ul>
- <li>Installation choice of either Demo Portal or Minimal Starter Portal</li>
- <li>In-depth Jetspeed 2 Tutorial</li>
- </ul>
- </subsection>
- <subsection name="Application Servers Supported">
- <ul>
- <li>Tomcat 5.0.x</li>
- <li>Tomcat 5.5.x</li>
- <li>Websphere 5.1, 6.0</li>
- <li>JBoss</li>
- </ul>
- </subsection>
- </section>
- </body>
-</document>
-
+ <ul>
+ <li>Installation choice of either Demo Portal or Minimal Starter Portal</li>
+ <li>In-depth Jetspeed 2 Tutorial</li>
+ </ul>
+ </subsection>
+ <subsection name="Application Servers Supported">
+ <ul>
+ <li>Tomcat 5.0.x</li>
+ <li>Tomcat 5.5.x</li>
+ <li>Websphere 5.1, 6.0</li>
+ <li>JBoss</li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/trunk/xdocs/features.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/trunk/xdocs/getting-started-binary.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/trunk/xdocs/getting-started-installer.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/trunk/xdocs/getting-started-source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml Sat Mar 3 18:13:22 2007
@@ -1,36 +1,36 @@
-<?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>Guide to Federated Security</title>
- <subtitle>Federated Security Configuration Overview</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylor@apache.org" />
- </authors>
-</properties>
-<body>
-<section name="Configuring Jetspeed-2 Federated Security">
-<p>
-1. override web.xml in custom build
-2. edit web.xml
- * remove security-constraints "Login"
- * remove LoginProxy, LoginServlet, LoginError, LoginRedirector, ...
- * remove servlet-mapping for above servlets
-</p>
-</section>
-</body>
+<?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>Guide to Federated Security</title>
+ <subtitle>Federated Security Configuration Overview</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+</properties>
+<body>
+<section name="Configuring Jetspeed-2 Federated Security">
+<p>
+1. override web.xml in custom build
+2. edit web.xml
+ * remove security-constraints "Login"
+ * remove LoginProxy, LoginServlet, LoginError, LoginRedirector, ...
+ * remove servlet-mapping for above servlets
+</p>
+</section>
+</body>
</document>
Propchange: portals/jetspeed-2/trunk/xdocs/guide-federated-security.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml Sat Mar 3 18:13:22 2007
@@ -1,90 +1,90 @@
-<?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 Aggregation</title>
- <subtitle>Guide to Jetspeed Aggregation</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylor@apache.org" />
- </authors>
- </properties>
- <body>
- <section name="What is Aggregation?">
- <p>
- The portal provides a consolidated view of multiple content sources, or portlets, in a single browser display.
- The process of consolidating and rendering this content together is known as aggregation.
- In Jetspeed, the aggregator is made up of several pluggable Spring components that plug into the Jetspeed engine.
- </p>
- </section>
- <section name='Supported Aggregators'>
- <p>List of Aggregators:</p>
- <table>
- <tr>
- <th>Component Name</th>
- <th>Description</th>
- <th>Multithreaded?</th>
- <th>JSR-168 Caching?</th>
- </tr>
- <tr>
- <td>PageAggregator</td>
- <td>Given a PSML page, aggregates the content of all portlets on that page.</td>
- <td>no</td>
- <td>yes</td>
- </tr>
- <tr>
- <td>AsyncPageAggregator</td>
- <td>A multi-threaded, asynchronous PSML page aggregator.</td>
- <td>yes</td>
- <td>yes</td>
- </tr>
- <tr>
- <td>PortletAggregator</td>
- <td>Renders the content of one single portlet.</td>
- <td>no*</td>
- <td>yes</td>
- </tr>
- </table>
- <i>* multi-threading is accomplished with the Jetspeed Desktop combined with the PortletAggregator</i>
- </section>
- <section name="Aggregator Spring Configuration">
- <p>
- </p>
- <source test="">
- <![CDATA[
+<?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 Aggregation</title>
+ <subtitle>Guide to Jetspeed Aggregation</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="What is Aggregation?">
+ <p>
+ The portal provides a consolidated view of multiple content sources, or portlets, in a single browser display.
+ The process of consolidating and rendering this content together is known as aggregation.
+ In Jetspeed, the aggregator is made up of several pluggable Spring components that plug into the Jetspeed engine.
+ </p>
+ </section>
+ <section name='Supported Aggregators'>
+ <p>List of Aggregators:</p>
+ <table>
+ <tr>
+ <th>Component Name</th>
+ <th>Description</th>
+ <th>Multithreaded?</th>
+ <th>JSR-168 Caching?</th>
+ </tr>
+ <tr>
+ <td>PageAggregator</td>
+ <td>Given a PSML page, aggregates the content of all portlets on that page.</td>
+ <td>no</td>
+ <td>yes</td>
+ </tr>
+ <tr>
+ <td>AsyncPageAggregator</td>
+ <td>A multi-threaded, asynchronous PSML page aggregator.</td>
+ <td>yes</td>
+ <td>yes</td>
+ </tr>
+ <tr>
+ <td>PortletAggregator</td>
+ <td>Renders the content of one single portlet.</td>
+ <td>no*</td>
+ <td>yes</td>
+ </tr>
+ </table>
+ <i>* multi-threading is accomplished with the Jetspeed Desktop combined with the PortletAggregator</i>
+ </section>
+ <section name="Aggregator Spring Configuration">
+ <p>
+ </p>
+ <source test="">
+ <![CDATA[
<!-- Default portlet timeout in milliseconds:
Zero means no portlet timeout option by default.
-->
<constructor-arg>
<value>0</value>
- </constructor-arg>
-]]>
- </source>
- <p>
- </p>
-
- </section>
-
- <section name="Changing the Page Aggregator to Multithreaded">
- <p>
- The default aggregator is single-threaded. To switch to multi-threaded,
- edit the <b>pipelines.xml</b> spring configuration file:
- </p>
- <source test="">
- <![CDATA[
+ </constructor-arg>
+]]>
+ </source>
+ <p>
+ </p>
+
+ </section>
+
+ <section name="Changing the Page Aggregator to Multithreaded">
+ <p>
+ The default aggregator is single-threaded. To switch to multi-threaded,
+ edit the <b>pipelines.xml</b> spring configuration file:
+ </p>
+ <source test="">
+ <![CDATA[
<!-- Before -->
<bean id="aggregatorValve"
class="org.apache.jetspeed.aggregator.AggregatorValve"
@@ -103,32 +103,32 @@
<constructor-arg>
<ref bean="org.apache.jetspeed.aggregator.AsyncPageAggregator"/>
</constructor-arg>
- </bean>
-]]>
- </source>
- <p>
- </p>
-
- </section>
- <section name="jetspeed-portlet.xml Parameters">
- <p>
- For the multithreaded aggregator, you can override the default setting
- for rendering timeout for a specific portlet. This value is set in milliseconds
- and represents the timeout value that Jetspeed will give the portlet to complete
- rendering before it gives up.
- </p>
- <source test="">
- <![CDATA[
+ </bean>
+]]>
+ </source>
+ <p>
+ </p>
+
+ </section>
+ <section name="jetspeed-portlet.xml Parameters">
+ <p>
+ For the multithreaded aggregator, you can override the default setting
+ for rendering timeout for a specific portlet. This value is set in milliseconds
+ and represents the timeout value that Jetspeed will give the portlet to complete
+ rendering before it gives up.
+ </p>
+ <source test="">
+ <![CDATA[
<portlet>
<portlet-name>PickANumberPortlet</portlet-name>
<js:metadata name="timeout">3000</js:metadata>
</portlet>
]]>
- </source>
- <p>
- </p>
-
- </section>
-
- </body>
-</document>
+ </source>
+ <p>
+ </p>
+
+ </section>
+
+ </body>
+</document>
Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-aggregation.xml
------------------------------------------------------------------------------
svn:eol-style = native
Modified: portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml?view=diff&rev=514329&r1=514328&r2=514329
==============================================================================
--- portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml (original)
+++ portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml Sat Mar 3 18:13:22 2007
@@ -1,917 +1,917 @@
-<?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>AJAX XML API</title>
- <subtitle>Documentation for Jetspeed-2 AJAX XML API</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylor@apache.org"/>
- </authors>
- </properties>
- <body>
-<section name="AJAX XML API Overview">
-<p>
-The Jetspeed XML AJAX API is an XML-based API provided to AJAX clients for making
-asynchronous requests to Jetspeed-2 services. </p>
-<p>
-Typical use cases:
-</p>
-<ul>
- <li><b>Page Customization and Portlet Placement</b> - To move, copy, add, or remove portlets on a page</li>
- <li><b>Layout Selection</b> - change the layout (number of rows and columns, size of columns) on a page</li>
- <li><b>Theme and Decorator Selection</b> - change the page theme and portlet decorators on a page.</li>
- <li><b>Portlet Selectors</b> - provide a select-list of portlets to the end user</li>
- <li><b>Security Configuration</b> - configure the security constraints or policy on a resource (page, portlet, folder, link, fragment), or portal wide</li>
- <li><b>Menu Configuration</b> - create and edit menus for the Jetspeed Site</li>
- <li><b>General Administration</b> - all use cases for general administration have not yet been explored.</li>
-</ul>
-<subsection name='Secured Access'>
-<p>
-All AJAX XML API requests run through
-a standard Jetspeed <a href='guide-pipeline.html'>Pipeline</a> request. This means that you can configure your AJAX
-request with the usual array of Jetspeed components. The default AJAX pipeline secures
-access to all requests. Each AJAX action may have its own security constraints. All
-requests made to a page will use the declarative security constraints configured for that page.
-AJAX request actions are enforced under edit or view mode, depending on the nature of the action.
-</p>
-</subsection>
-</section>
-<section name='API'>
-<p>
-The AJAX XML API is simply a HTTP request-based API, communicating over a simple REST (Representational State Transfer) protocol.
-The API is accessed over HTTP via the "ajaxapi" servlet path on the portal URL:
-<source><![CDATA[
-http://hostname/contextname/ajaxapi
-]]></source>
-</p>
-<subsection name='Request Parameters and the Page'>
-<p>Request Parameters specify the requested API action, and additional API parameters.
-The page that a request is referencing is implied in the HTTP URL.
-Thus if we are making a request to modify a page, the page is specified in the HTTP URL:
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/db-browser.psml
-]]></source>
-The page location algorithm using standard Jetspeed Profiling rules to locate the page.
-A page is actually not required in the URL, since the <a href='guide-profiler.html'>Jetspeed Profiler</a> will locate the page
-for you. Example:
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi
-]]></source>
-goes to the default page for the current user.
-</p>
-<p>Request Parameters are specific to each API. One request parameter, the "action" parameter,
- is almost always required, (except in the default case). The default action is "action=getpage"
-which returns an XML representation of the profile-located page in <a href='guide-psml.html'>PSML</a>. (PSML is an XML format).
-See the table below for specific examples of request parameters.
-</p>
-<p>Here are the APIs currently available:
-</p>
-</subsection>
-<subsection name='Get Page'>
-<table>
- <tr>
- <td>API:</td>
- <td>getpage</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxGetPage</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Get Page retrieves a page from the Page Manager store in <a href='guide-psml.html'>PSML</a> format.
- </td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>getportlets (optional, this is the default action)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/content.psml
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
-<status>success</status>
-<action>getpage</action>
- <page hidden="false">
- <defaults layout-decorator="tigris" portlet-decorator="tigris"/>
- <name>public.psml</name>
- <path>/Public/public.psml</path>
- <title>Public Share</title>
- <short-title>Public Share</short-title>
- <metadata name="title" xml:lang="es">Carpeta compartida</metadata>
- <fragment id="ps-1000" type="layout" name="jetspeed-layouts::VelocityTwoColumns" decorator="">
- <fragment id="ps-1001" type="portlet" name="rss::RSS" decorator="">
- <property name="row" value="0"/>
- <property name="column" value="0"/>
- </fragment>
- <fragment id="ps-1002" type="portlet" name="demo::BookmarkPortlet" decorator="">
- <property name="row" value="1"/>
- <property name="column" value="1"/>
- </fragment>
- <fragment id="ps-1003" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
- <property name="row" value="0"/>
- <property name="column" value="1"/>
- </fragment>
- <fragment id="P-1080bff9b03-10000" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
- <property name="row" value="1"/>
- <property name="column" value="0"/>
- </fragment>
- </fragment>
-</page>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name='Move Absolute'>
-<table>
- <tr>
- <td>API:</td>
- <td>moveabs</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxMovePortletAbsolute</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Move a portlet on a page to an absolute position specified in the row and col request parameters.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>moveabs</td>
- </tr>
- <tr>
- <td>id</td>
- <td>the portlet PSML fragment id of the portlet to be moved</td>
- </tr>
- <tr>
- <td>row</td>
- <td>the absolute new row location to place the portlet fragment (zero based)</td>
- </tr>
- <tr>
- <td>col</td>
- <td>the absolute new column location to place the portlet fragment (zero based)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=moveabs&id=ps-1003&row=0&col=1
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>moveabs</action>
- <id>ps-1003</id>
- <old_position>
- <col>1</col>
- <row>1</row>
- </old_position>
- <new_position>
- <col>1</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name='Move Relative'>
-<table>
- <tr>
- <td>APIs:</td>
- <td>moveleft, moveright, moveup, movedown</td>
- </tr>
- <tr>
- <td>Components:</td>
- <td>AjaxMovePortletLeft, AjaxMovePortletRight, AjaxMovePortletUp, AjaxMoveDown</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Move a portlet on a page relatively one position, based on the action.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>moveleft, moveright, moveup, movedown</td>
- </tr>
- <tr>
- <td>id</td>
- <td>the portlet PSML fragment id of the portlet to be moved</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=movedown&id=ps-1003
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>movedown</action>
- <id>ps-1003</id>
- <old_position>
- <col>1</col>
- <row>0</row>
- </old_position>
- <new_position>
- <col>1</col>
- <row>1</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-
-</table>
-</subsection>
-<subsection name='Move'>
-<table>
- <tr>
- <td>API:</td>
- <td>move</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxMovePortlet</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Move a portlet on a page to a cartesian position (x,y,z,width,height) from request parameters.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>move</td>
- </tr>
- <tr>
- <td>id</td>
- <td>the portlet PSML fragment id of the portlet to be moved</td>
- </tr>
- <tr>
- <td>x</td>
- <td>the portlet cartesian X position</td>
- </tr>
- <tr>
- <td>y</td>
- <td>the portlet cartesian Y position</td>
- </tr>
- <tr>
- <td>z</td>
- <td>the portlte cartesian Z position</td>
- </tr>
- <tr>
- <td>width</td>
- <td>the width of the portlet</td>
- </tr>
- <tr>
- <td>height</td>
- <td>the height cartesian Y position</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=move&id=ps-1003&x=100&y=250&width=200&height=300
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>move</action>
- <id>ps-1003</id>
- <old_position>
- <x>50</x>
- <y>155</row>
- </old_position>
- <new_position>
- <x>100</x>
- <y>250</y>
- </new_position>
-</js>
-]]></source>
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name='Add Portlet'>
-<table>
- <tr>
- <td>API:</td>
- <td>add</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxAddPortlet</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Adds a new portlet to the current page. The portlet can be added at a specified row and column.
- If either the row or column or not specified, defaults to zero respectively.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>add</td>
- </tr>
- <tr>
- <td>id</td>
- <td>The portlet full name to be placed on the page, using Jetspeed Portlet Naming (PortletApplicationName::PortletName)</td>
- </tr>
- <tr>
- <td>row</td>
- <td>optional: the absolute new row location to place the new portlet fragment (zero based)</td>
- </tr>
- <tr>
- <td>col</td>
- <td>optional: the absolute new column location to place the new portlet fragment (zero based)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=add&id=jsf-demo::CalendarPortlet
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>add</action>
- <id>jsf-demo::CalendarPortlet</id>
- <new_position>
- <col>0</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name='Remove Portlet'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>remove</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxRemovePortlet</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Removes a new portlet from the current page.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>remove</td>
- </tr>
- <tr>
- <td>id</td>
- <td>the portlet PSML fragment id of the portlet to be removed</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=remove&id=ps-1003
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>remove</action>
- <id>jsf-demo::CalendarPortlet</id>
- <new_position>
- <col>0</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name='Get Portlets'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>getportlets</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxGetPortlets</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Get Portlets retrieves the (sorted) portlet list available to the current subject, filtered
- the portlet list, and returning portlets which the current subject may view.
- The Jetspeed (JAAS) security policy enforces this filtering. Portlets are returned
- in XML format, with name, displayName, and description for each portlet.</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>page</td>
- <td>implied in the URL</td>
- </tr>
- <tr>
- <td>action</td>
- <td>getportlets</td>
- </tr>
- <tr>
- <td>filter</td>
- <td>not yet implemented. A query filter to be defined.</td>
- </tr>
-
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi?action=getportlets
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
-<status>success</status>
-<action>getportlets</action>
--
- <portlets>
-<portlet name="demo::AttributeScopePortlet" displayName="Attribute Scope Demo" description="$portlet.Description">
- </portlet>
-<portlet name="demo::BookmarkPortlet" displayName="Bookmark Portlet" description="Bookmark Portlet">
- </portlet>
-<portlet name="demo::BookmarkPortletForXHTMLBasic" displayName="Bookmark Portlet for XHTML Basic" description="Bookmark Portlet for XHTML Basic">
- </portlet>
-<portlet name="demo::CSSDemoPortlet" displayName="CSS Demo Portlet" description="$portlet.Description">
- </portlet>
-....
-<portlet name="rss::RSS" displayName="RSS Portlet" description="RSS Portlet">
- </portlet>
-<portlet name="rss::RomeRSS" displayName="Rome RSS Portlet" description="Rome RSS Portlet">
- </portlet>
-</portlets>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-
-<subsection name='Permissions'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>permissions</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxSecurityPermissions</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Security Permissions Maintenance to add, update, and remove permissions from the Jetspeed security policy</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>action</td>
- <td>permissions</td>
- </tr>
- <tr>
- <td>method</td>
- <td>the method to execute: must be of value: add | update | remove</td>
- </tr>
- <tr>
- <td>type</td>
- <td>the type of permission being manipulated: portlet | folder | page</td>
- </tr>
- <tr>
- <td>resource</td>
- <td>the name of the portal resource being manipulated</td>
- </tr>
- <tr>
- <td>roles</td>
- <td>comma-separated list of roles, only valid for methods: add, update</td>
- </tr>
- <tr>
- <td>actions</td>
- <td>comma-separated list of actions, only valid for methods: add, update</td>
- </tr>
- <tr>
- <td>oldactions</td>
- <td>comma-separated list of previous actions, only valid for methods: update</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi?action=permissions&method=add&type=portlet&resource=demo::*&roles=role1,role2,role3&actions=view,edit
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>permissions</action>
- <resource>demo::*</resource>
- <type>portlet</type>
- <actions>view,edit</actions>
- <actions>role1,role2,role3</actions>
-</js>
-]]></source>
- </td>
- </tr>
-</table>
-</subsection>
-
-<subsection name='getmenus'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>getmenus</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxGetMenus</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Retrieves all menus for the current page (implied in URL)</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>action</td>
- <td>getmenus</td>
- </tr>
- <tr>
- <td>page</td>
- <td>(implied in URL)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/default-page.psml?action=getmenus
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>getmenus</action>
- <menus>
- <menu type="standard">navigations</menu>
- <menu type="standard">back</menu>
- <menu type="standard">pages</menu>
- <menu type="standard">breadcrumbs</menu>
- <menu type="custom">site-navigations</menu>
- <menu type="custom">additional-links</menu>
- <menu type="custom">page-navigations</menu>
- </menus>
-</js>
-]]></source>
- </td>
- </tr>
-</table>
-</subsection>
-
-<subsection name='getmenu'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>getmenu</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxGetMenu</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Retrieves the menu definition for a given menu</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>action</td>
- <td>getmenu</td>
- </tr>
- <tr>
- <td>menu</td>
- <td>name of the menu to retrieve (menu definition may change per page)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi?action=getmenu&name=breadcrumbs
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
-<status>success</status>
-<action>getmenu</action>
-<menu>
- <name>breadcrumbs</name>
- <title>You are here:</title>
- <short-title>You are here:</short-title>
- <skin>breadcrumbs</skin>
- <url>/default-page.psml</url>
- <hidden>false</hidden>
- <selected>true</selected>
- <option>
- <type>folder</type>
- <title>Root Folder</title>
- <short-title>Root Folder</short-title>
- <skin>breadcrumbs</skin>
- <url>/</url>
- <hidden>false</hidden>
- <selected>true</selected>
- </option>
- <option>
- <type>page</type>
- <title>Welcome to Jetspeed 2</title>
- <short-title>Welcome to Jetspeed 2</short-title>
- <skin>blue</skin>
- <url>/default-page.psml</url>
- <hidden>false</hidden>
- <selected>true</selected>
- </option>
-</menu>
-</js>
-]]></source>
- </td>
- </tr>
-</table>
-</subsection>
-
-<subsection name='window'>
-<table>
-
- <tr>
- <td>API:</td>
- <td>getmenus</td>
- </tr>
- <tr>
- <td>Component:</td>
- <td>AjaxChangeWindow</td>
- </tr>
- <tr>
- <td>Description:</td>
- <td>Changes a portlet window's Window State or Portlet Mode</td>
- </tr>
- <tr>
- <td>Parameters:</td>
- <table>
- <tr>
- <td>action</td>
- <td>window</td>
- </tr>
- <tr>
- <td>id</td>
- <td>window id of the portlet to be modified</td>
- </tr>
- <tr>
- <td>state</td>
- <td>A portlet api valid window state or extended window state (normal | maximized | minimized)</td>
- </tr>
- <tr>
- <td>mode</td>
- <td>A portlet api valid portlet mode or extended portlet mode (view | edit | help | print)</td>
- </tr>
- <tr>
- <td>page</td>
- <td>Implied in URL</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API example:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi?action=window&state=maximized&mode=edit&id=um-2
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML Response:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>window</action>
- <id>um-2</id>
- <state>maximized</state>
- <mode>edit</mode>
-</js>
-]]></source>
- </td>
- </tr>
-</table>
-</subsection>
-</section>
-
-<section name='Spring Assembly'>
-<p>
-The <code>AjaxRequestService</code> is a Spring component that handles AJAX requests.
-It is hooked into the AJAX <a href='guide-pipeline.html'>Pipeline</a> for special processing
-of AJAX request. Here is the Spring Assembly. Each API is configured in the Ajax Service.
-</p>
-<source><![CDATA[
-<bean id="AjaxRequestService" class="org.apache.jetspeed.ajax.AjaxRequestServiceImpl">
- <constructor-arg index="0">
- <map>
- <entry key="move">
- <ref bean="AjaxMove"/>
- </entry>
- <entry key="moveabs">
- <ref bean="AjaxMovePortletAbsolute"/>
- </entry>
- <entry key="moveleft">
- <ref bean="AjaxMovePortletLeft"/>
- </entry>
- <entry key="moveright">
- <ref bean="AjaxMovePortletRight"/>
- </entry>
- <entry key="moveup">
- <ref bean="AjaxMovePortletUp"/>
- </entry>
- <entry key="movedown">
- <ref bean="AjaxMovePortletDown"/>
- </entry>
- <entry key="add">
- <ref bean="AjaxAddPortlet"/>
- </entry>
- <entry key="remove">
- <ref bean="AjaxRemovePortlet"/>
- </entry>
- <entry key="getportlets">
- <ref bean="AjaxGetPortlets"/>
- </entry>
- <entry key="getpage">
- <ref bean="AjaxGetPage"/>
- </entry>
- <entry key="getpages">
- <ref bean="AjaxGetPages"/>
- </entry>
- <entry key="window">
- <ref bean="AjaxChangeWindow"/>
- </entry>
- <entry key="getmenus">
- <ref bean="AjaxGetMenus"/>
- </entry>
- <entry key="getmenu">
- <ref bean="AjaxGetMenu"/>
- </entry>
- <entry key="permissions">
- <ref bean="AjaxSecurityPermissions"/>
- </entry>
- </map>
- </constructor-arg>
- <constructor-arg index="1">
- <ref bean="AjaxVelocityEngine"/>
- </constructor-arg>
-</bean>
-]]></source>
-
-</section>
-</body>
-</document>
-
+<?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>AJAX XML API</title>
+ <subtitle>Documentation for Jetspeed-2 AJAX XML API</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org"/>
+ </authors>
+ </properties>
+ <body>
+<section name="AJAX XML API Overview">
+<p>
+The Jetspeed XML AJAX API is an XML-based API provided to AJAX clients for making
+asynchronous requests to Jetspeed-2 services. </p>
+<p>
+Typical use cases:
+</p>
+<ul>
+ <li><b>Page Customization and Portlet Placement</b> - To move, copy, add, or remove portlets on a page</li>
+ <li><b>Layout Selection</b> - change the layout (number of rows and columns, size of columns) on a page</li>
+ <li><b>Theme and Decorator Selection</b> - change the page theme and portlet decorators on a page.</li>
+ <li><b>Portlet Selectors</b> - provide a select-list of portlets to the end user</li>
+ <li><b>Security Configuration</b> - configure the security constraints or policy on a resource (page, portlet, folder, link, fragment), or portal wide</li>
+ <li><b>Menu Configuration</b> - create and edit menus for the Jetspeed Site</li>
+ <li><b>General Administration</b> - all use cases for general administration have not yet been explored.</li>
+</ul>
+<subsection name='Secured Access'>
+<p>
+All AJAX XML API requests run through
+a standard Jetspeed <a href='guide-pipeline.html'>Pipeline</a> request. This means that you can configure your AJAX
+request with the usual array of Jetspeed components. The default AJAX pipeline secures
+access to all requests. Each AJAX action may have its own security constraints. All
+requests made to a page will use the declarative security constraints configured for that page.
+AJAX request actions are enforced under edit or view mode, depending on the nature of the action.
+</p>
+</subsection>
+</section>
+<section name='API'>
+<p>
+The AJAX XML API is simply a HTTP request-based API, communicating over a simple REST (Representational State Transfer) protocol.
+The API is accessed over HTTP via the "ajaxapi" servlet path on the portal URL:
+<source><![CDATA[
+http://hostname/contextname/ajaxapi
+]]></source>
+</p>
+<subsection name='Request Parameters and the Page'>
+<p>Request Parameters specify the requested API action, and additional API parameters.
+The page that a request is referencing is implied in the HTTP URL.
+Thus if we are making a request to modify a page, the page is specified in the HTTP URL:
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/db-browser.psml
+]]></source>
+The page location algorithm using standard Jetspeed Profiling rules to locate the page.
+A page is actually not required in the URL, since the <a href='guide-profiler.html'>Jetspeed Profiler</a> will locate the page
+for you. Example:
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi
+]]></source>
+goes to the default page for the current user.
+</p>
+<p>Request Parameters are specific to each API. One request parameter, the "action" parameter,
+ is almost always required, (except in the default case). The default action is "action=getpage"
+which returns an XML representation of the profile-located page in <a href='guide-psml.html'>PSML</a>. (PSML is an XML format).
+See the table below for specific examples of request parameters.
+</p>
+<p>Here are the APIs currently available:
+</p>
+</subsection>
+<subsection name='Get Page'>
+<table>
+ <tr>
+ <td>API:</td>
+ <td>getpage</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxGetPage</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Get Page retrieves a page from the Page Manager store in <a href='guide-psml.html'>PSML</a> format.
+ </td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>getportlets (optional, this is the default action)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/content.psml
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+<status>success</status>
+<action>getpage</action>
+ <page hidden="false">
+ <defaults layout-decorator="tigris" portlet-decorator="tigris"/>
+ <name>public.psml</name>
+ <path>/Public/public.psml</path>
+ <title>Public Share</title>
+ <short-title>Public Share</short-title>
+ <metadata name="title" xml:lang="es">Carpeta compartida</metadata>
+ <fragment id="ps-1000" type="layout" name="jetspeed-layouts::VelocityTwoColumns" decorator="">
+ <fragment id="ps-1001" type="portlet" name="rss::RSS" decorator="">
+ <property name="row" value="0"/>
+ <property name="column" value="0"/>
+ </fragment>
+ <fragment id="ps-1002" type="portlet" name="demo::BookmarkPortlet" decorator="">
+ <property name="row" value="1"/>
+ <property name="column" value="1"/>
+ </fragment>
+ <fragment id="ps-1003" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
+ <property name="row" value="0"/>
+ <property name="column" value="1"/>
+ </fragment>
+ <fragment id="P-1080bff9b03-10000" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
+ <property name="row" value="1"/>
+ <property name="column" value="0"/>
+ </fragment>
+ </fragment>
+</page>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+<subsection name='Move Absolute'>
+<table>
+ <tr>
+ <td>API:</td>
+ <td>moveabs</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxMovePortletAbsolute</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Move a portlet on a page to an absolute position specified in the row and col request parameters.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>moveabs</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>the portlet PSML fragment id of the portlet to be moved</td>
+ </tr>
+ <tr>
+ <td>row</td>
+ <td>the absolute new row location to place the portlet fragment (zero based)</td>
+ </tr>
+ <tr>
+ <td>col</td>
+ <td>the absolute new column location to place the portlet fragment (zero based)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=moveabs&id=ps-1003&row=0&col=1
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>moveabs</action>
+ <id>ps-1003</id>
+ <old_position>
+ <col>1</col>
+ <row>1</row>
+ </old_position>
+ <new_position>
+ <col>1</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+<subsection name='Move Relative'>
+<table>
+ <tr>
+ <td>APIs:</td>
+ <td>moveleft, moveright, moveup, movedown</td>
+ </tr>
+ <tr>
+ <td>Components:</td>
+ <td>AjaxMovePortletLeft, AjaxMovePortletRight, AjaxMovePortletUp, AjaxMoveDown</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Move a portlet on a page relatively one position, based on the action.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>moveleft, moveright, moveup, movedown</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>the portlet PSML fragment id of the portlet to be moved</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=movedown&id=ps-1003
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>movedown</action>
+ <id>ps-1003</id>
+ <old_position>
+ <col>1</col>
+ <row>0</row>
+ </old_position>
+ <new_position>
+ <col>1</col>
+ <row>1</row>
+ </new_position>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+
+</table>
+</subsection>
+<subsection name='Move'>
+<table>
+ <tr>
+ <td>API:</td>
+ <td>move</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxMovePortlet</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Move a portlet on a page to a cartesian position (x,y,z,width,height) from request parameters.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>move</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>the portlet PSML fragment id of the portlet to be moved</td>
+ </tr>
+ <tr>
+ <td>x</td>
+ <td>the portlet cartesian X position</td>
+ </tr>
+ <tr>
+ <td>y</td>
+ <td>the portlet cartesian Y position</td>
+ </tr>
+ <tr>
+ <td>z</td>
+ <td>the portlte cartesian Z position</td>
+ </tr>
+ <tr>
+ <td>width</td>
+ <td>the width of the portlet</td>
+ </tr>
+ <tr>
+ <td>height</td>
+ <td>the height cartesian Y position</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=move&id=ps-1003&x=100&y=250&width=200&height=300
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>move</action>
+ <id>ps-1003</id>
+ <old_position>
+ <x>50</x>
+ <y>155</row>
+ </old_position>
+ <new_position>
+ <x>100</x>
+ <y>250</y>
+ </new_position>
+</js>
+]]></source>
+ </td>
+ </tr>
+</table>
+</subsection>
+<subsection name='Add Portlet'>
+<table>
+ <tr>
+ <td>API:</td>
+ <td>add</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxAddPortlet</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Adds a new portlet to the current page. The portlet can be added at a specified row and column.
+ If either the row or column or not specified, defaults to zero respectively.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>add</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>The portlet full name to be placed on the page, using Jetspeed Portlet Naming (PortletApplicationName::PortletName)</td>
+ </tr>
+ <tr>
+ <td>row</td>
+ <td>optional: the absolute new row location to place the new portlet fragment (zero based)</td>
+ </tr>
+ <tr>
+ <td>col</td>
+ <td>optional: the absolute new column location to place the new portlet fragment (zero based)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=add&id=jsf-demo::CalendarPortlet
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>add</action>
+ <id>jsf-demo::CalendarPortlet</id>
+ <new_position>
+ <col>0</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+<subsection name='Remove Portlet'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>remove</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxRemovePortlet</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Removes a new portlet from the current page.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>remove</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>the portlet PSML fragment id of the portlet to be removed</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=remove&id=ps-1003
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>remove</action>
+ <id>jsf-demo::CalendarPortlet</id>
+ <new_position>
+ <col>0</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+<subsection name='Get Portlets'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>getportlets</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxGetPortlets</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Get Portlets retrieves the (sorted) portlet list available to the current subject, filtered
+ the portlet list, and returning portlets which the current subject may view.
+ The Jetspeed (JAAS) security policy enforces this filtering. Portlets are returned
+ in XML format, with name, displayName, and description for each portlet.</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>implied in the URL</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>getportlets</td>
+ </tr>
+ <tr>
+ <td>filter</td>
+ <td>not yet implemented. A query filter to be defined.</td>
+ </tr>
+
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi?action=getportlets
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+<status>success</status>
+<action>getportlets</action>
+-
+ <portlets>
+<portlet name="demo::AttributeScopePortlet" displayName="Attribute Scope Demo" description="$portlet.Description">
+ </portlet>
+<portlet name="demo::BookmarkPortlet" displayName="Bookmark Portlet" description="Bookmark Portlet">
+ </portlet>
+<portlet name="demo::BookmarkPortletForXHTMLBasic" displayName="Bookmark Portlet for XHTML Basic" description="Bookmark Portlet for XHTML Basic">
+ </portlet>
+<portlet name="demo::CSSDemoPortlet" displayName="CSS Demo Portlet" description="$portlet.Description">
+ </portlet>
+....
+<portlet name="rss::RSS" displayName="RSS Portlet" description="RSS Portlet">
+ </portlet>
+<portlet name="rss::RomeRSS" displayName="Rome RSS Portlet" description="Rome RSS Portlet">
+ </portlet>
+</portlets>
+</js>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+
+<subsection name='Permissions'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>permissions</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxSecurityPermissions</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Security Permissions Maintenance to add, update, and remove permissions from the Jetspeed security policy</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>action</td>
+ <td>permissions</td>
+ </tr>
+ <tr>
+ <td>method</td>
+ <td>the method to execute: must be of value: add | update | remove</td>
+ </tr>
+ <tr>
+ <td>type</td>
+ <td>the type of permission being manipulated: portlet | folder | page</td>
+ </tr>
+ <tr>
+ <td>resource</td>
+ <td>the name of the portal resource being manipulated</td>
+ </tr>
+ <tr>
+ <td>roles</td>
+ <td>comma-separated list of roles, only valid for methods: add, update</td>
+ </tr>
+ <tr>
+ <td>actions</td>
+ <td>comma-separated list of actions, only valid for methods: add, update</td>
+ </tr>
+ <tr>
+ <td>oldactions</td>
+ <td>comma-separated list of previous actions, only valid for methods: update</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi?action=permissions&method=add&type=portlet&resource=demo::*&roles=role1,role2,role3&actions=view,edit
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>permissions</action>
+ <resource>demo::*</resource>
+ <type>portlet</type>
+ <actions>view,edit</actions>
+ <actions>role1,role2,role3</actions>
+</js>
+]]></source>
+ </td>
+ </tr>
+</table>
+</subsection>
+
+<subsection name='getmenus'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>getmenus</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxGetMenus</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Retrieves all menus for the current page (implied in URL)</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>action</td>
+ <td>getmenus</td>
+ </tr>
+ <tr>
+ <td>page</td>
+ <td>(implied in URL)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/default-page.psml?action=getmenus
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>getmenus</action>
+ <menus>
+ <menu type="standard">navigations</menu>
+ <menu type="standard">back</menu>
+ <menu type="standard">pages</menu>
+ <menu type="standard">breadcrumbs</menu>
+ <menu type="custom">site-navigations</menu>
+ <menu type="custom">additional-links</menu>
+ <menu type="custom">page-navigations</menu>
+ </menus>
+</js>
+]]></source>
+ </td>
+ </tr>
+</table>
+</subsection>
+
+<subsection name='getmenu'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>getmenu</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxGetMenu</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Retrieves the menu definition for a given menu</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>action</td>
+ <td>getmenu</td>
+ </tr>
+ <tr>
+ <td>menu</td>
+ <td>name of the menu to retrieve (menu definition may change per page)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi?action=getmenu&name=breadcrumbs
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+<status>success</status>
+<action>getmenu</action>
+<menu>
+ <name>breadcrumbs</name>
+ <title>You are here:</title>
+ <short-title>You are here:</short-title>
+ <skin>breadcrumbs</skin>
+ <url>/default-page.psml</url>
+ <hidden>false</hidden>
+ <selected>true</selected>
+ <option>
+ <type>folder</type>
+ <title>Root Folder</title>
+ <short-title>Root Folder</short-title>
+ <skin>breadcrumbs</skin>
+ <url>/</url>
+ <hidden>false</hidden>
+ <selected>true</selected>
+ </option>
+ <option>
+ <type>page</type>
+ <title>Welcome to Jetspeed 2</title>
+ <short-title>Welcome to Jetspeed 2</short-title>
+ <skin>blue</skin>
+ <url>/default-page.psml</url>
+ <hidden>false</hidden>
+ <selected>true</selected>
+ </option>
+</menu>
+</js>
+]]></source>
+ </td>
+ </tr>
+</table>
+</subsection>
+
+<subsection name='window'>
+<table>
+
+ <tr>
+ <td>API:</td>
+ <td>getmenus</td>
+ </tr>
+ <tr>
+ <td>Component:</td>
+ <td>AjaxChangeWindow</td>
+ </tr>
+ <tr>
+ <td>Description:</td>
+ <td>Changes a portlet window's Window State or Portlet Mode</td>
+ </tr>
+ <tr>
+ <td>Parameters:</td>
+ <table>
+ <tr>
+ <td>action</td>
+ <td>window</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>window id of the portlet to be modified</td>
+ </tr>
+ <tr>
+ <td>state</td>
+ <td>A portlet api valid window state or extended window state (normal | maximized | minimized)</td>
+ </tr>
+ <tr>
+ <td>mode</td>
+ <td>A portlet api valid portlet mode or extended portlet mode (view | edit | help | print)</td>
+ </tr>
+ <tr>
+ <td>page</td>
+ <td>Implied in URL</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API example:</td>
+ <td>
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi?action=window&state=maximized&mode=edit&id=um-2
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response:</td>
+ <td>
+<source><![CDATA[
+<js>
+ <status>success</status>
+ <action>window</action>
+ <id>um-2</id>
+ <state>maximized</state>
+ <mode>edit</mode>
+</js>
+]]></source>
+ </td>
+ </tr>
+</table>
+</subsection>
+</section>
+
+<section name='Spring Assembly'>
+<p>
+The <code>AjaxRequestService</code> is a Spring component that handles AJAX requests.
+It is hooked into the AJAX <a href='guide-pipeline.html'>Pipeline</a> for special processing
+of AJAX request. Here is the Spring Assembly. Each API is configured in the Ajax Service.
+</p>
+<source><![CDATA[
+<bean id="AjaxRequestService" class="org.apache.jetspeed.ajax.AjaxRequestServiceImpl">
+ <constructor-arg index="0">
+ <map>
+ <entry key="move">
+ <ref bean="AjaxMove"/>
+ </entry>
+ <entry key="moveabs">
+ <ref bean="AjaxMovePortletAbsolute"/>
+ </entry>
+ <entry key="moveleft">
+ <ref bean="AjaxMovePortletLeft"/>
+ </entry>
+ <entry key="moveright">
+ <ref bean="AjaxMovePortletRight"/>
+ </entry>
+ <entry key="moveup">
+ <ref bean="AjaxMovePortletUp"/>
+ </entry>
+ <entry key="movedown">
+ <ref bean="AjaxMovePortletDown"/>
+ </entry>
+ <entry key="add">
+ <ref bean="AjaxAddPortlet"/>
+ </entry>
+ <entry key="remove">
+ <ref bean="AjaxRemovePortlet"/>
+ </entry>
+ <entry key="getportlets">
+ <ref bean="AjaxGetPortlets"/>
+ </entry>
+ <entry key="getpage">
+ <ref bean="AjaxGetPage"/>
+ </entry>
+ <entry key="getpages">
+ <ref bean="AjaxGetPages"/>
+ </entry>
+ <entry key="window">
+ <ref bean="AjaxChangeWindow"/>
+ </entry>
+ <entry key="getmenus">
+ <ref bean="AjaxGetMenus"/>
+ </entry>
+ <entry key="getmenu">
+ <ref bean="AjaxGetMenu"/>
+ </entry>
+ <entry key="permissions">
+ <ref bean="AjaxSecurityPermissions"/>
+ </entry>
+ </map>
+ </constructor-arg>
+ <constructor-arg index="1">
+ <ref bean="AjaxVelocityEngine"/>
+ </constructor-arg>
+</bean>
+]]></source>
+
+</section>
+</body>
+</document>
+
Propchange: portals/jetspeed-2/trunk/xdocs/guides/guide-ajax-api.xml
------------------------------------------------------------------------------
svn:eol-style = native
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org