Return-Path: Delivered-To: apmail-portals-jetspeed-dev-archive@www.apache.org Received: (qmail 615 invoked from network); 2 Dec 2008 08:55:04 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 2 Dec 2008 08:55:04 -0000 Received: (qmail 80961 invoked by uid 500); 2 Dec 2008 08:55:14 -0000 Delivered-To: apmail-portals-jetspeed-dev-archive@portals.apache.org Received: (qmail 80923 invoked by uid 500); 2 Dec 2008 08:55:14 -0000 Mailing-List: contact jetspeed-dev-help@portals.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: "Jetspeed Developers List" Delivered-To: mailing list jetspeed-dev@portals.apache.org Received: (qmail 80911 invoked by uid 99); 2 Dec 2008 08:55:14 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Dec 2008 00:55:14 -0800 X-ASF-Spam-Status: No, hits=-2000.0 required=10.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 02 Dec 2008 08:53:42 +0000 Received: by eris.apache.org (Postfix, from userid 65534) id 36DA92388A27; Tue, 2 Dec 2008 00:53:32 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r722405 [7/17] - in /portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade: ./ src/ src/site/ src/site/resources/ src/site/resources/css/ src/site/resources/images/ src/site/resources/images/layouts/ src/site/resources/images/portlet... Date: Tue, 02 Dec 2008 08:53:28 -0000 To: jetspeed-dev@portals.apache.org From: woonsan@apache.org X-Mailer: svnmailer-1.0.8 Message-Id: <20081202085332.36DA92388A27@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,185 @@ + + + + + + Getting Started with Jetspeed 2 using the installer + + Installing Jetspeed-2 with the installer + + + + + +
+ +

+ Jetspeed 2.1.3 provides 2 installers: +

+

+

+ To run the standard (minimal) installer: +

+ +java -jar jetspeed-2.1.3-installer.jar + +

+To run the Jetspeed Demo installer: +

+ +java -jar jetspeed-2.1.3-demo-installer.jar + +

+ The installers are capable of running on headless (i.e. no gui) machines, and will detect so automatically.
+ To force the installer in text mode manually, pass in the text parameter: +

+ +java -jar jetspeed-2.1.3-installer.jar text + + + +

+ The installer will ask you to choose a database for storing the Jetspeed database. We provide a default Derby database for demo systems. + The Derby database runs in embedded mode inside the Jetspeed/Tomcat JVM. All other databases require additional configuration. + If you selected Derby, you can go with the default parameters provided. For all other databases you must first create an area to hold the Jetspeed tables. + For some databases this area is called a catalog, others call it a schema, while others call it a database. Consult your + database documentation for details on how to create a catalog or schema to hold the Jetspeed tables. Additionally, you may need to create a database user + to access the Jetspeed tables. Often it is required to grant access to the schemas (catalogs) for the given user. +

+

Jetspeed supported database list: +

    +
  • DB2
    • +
  • Derby (default)
    • +
  • MS SQL
    • +
  • My SQL
    • +
  • PostgreSQL
    • +
  • Oracle (9i or higher)
    • +
  • SapDB
    • +
  • Manual database setup
    • +
+

+

If you choose the manual database setup, then the database scripts will not be run and you will need to configure the database manually after the installation. + All database scripts are provided in the installation under the database directory. For your specific database, look for the corresponding directory name. + During installation, you will be prompted for the following fields after chosing your database types (except for Derby): +

    +
  • A username
    • +
  • A password
    • +
  • A JDBC connection string
    • +
  • A JDBC driver name
    • +
  • The location of a valid JDBC driver. The installer will copy this driver to the installed location in Tomcat.
    • +
+ The connections strings are only partially completed in the well-known format of the particular databaes. + Please take care to complete the values in your connection string for your database. The driver name should be the right + driver class for your database at the time of the making of this installation. Please ensure that a newer driver is not required for your database. + Note also that the location of the JDBC driver must be selected. We have not provided the file system path to the jar file but only the likely file name. + You may want to check and see if newer versions of the driver are available. +

+

+ Once you have entered all of your parameters, the installer will test the database connection before proceeding. + If the connection fails, please go back to the connection configuration setup and provide the correct parameters. + If you choose to continue, the database scripts will not be run and you will need to configure the database manually after the installation. + Once the installer verifies the database connection, you are ready to proceed with installation process. +

+

+ Please take note of the location where you are installing on your file system.
+ Also, on a Windows platform make sure to use a location path without spaces, e.g. NOT under C:\Program Files. +

+ + +

+ Once you have completed a successful install, you are ready to start the Jetspeed Portal. + On linux, here is an example where you have installed to the default location: +

+ +cd ~/jetspeed-2.1.3/bin +./startup.sh + +

+ On windows, here is an example where you have installed to the default location: +

+ + cd C:\Apache\Jetspeed-2.1.3\bin + startup.bat + +

+ The very first invocation of the portal requires anywhere from 10 seconds to 30 seconds for initial + startup and final installation. After starting the server, start up a web browser + and navigate to http://localhost:8080/jetspeed/portal +

+ + +

+All preconfigured users have the same password as username (for example the admin user has the password admin) +If you installed with the Minimal installer, two test accounts are available: +

+ +admin -- System administrator, super user +devmgr -- Delegated security manager, can manage users with the "dev" (developer) role + +

+If you installed with the Demo installer, several additional test accounts are available: +

+ +admin -- System administrator, super user +manager - Has system administration rights, but not super user +user -- A sample user demonstrating with with a home page and advanced profiled menus +tomcat -- A sample user demonstrating a user without a home page +jetspeed -- A sample user demonstrating discovery of pages by both group and role fallback profiling algorithms +subsite -- Example of how to setup users with a primary subsite role fallback profiling rules +subsite2 -- Example of how to setup users with a secondary subsite role fallback profiling rules +devmgr -- Delegated security manager, can manage users with the "dev" (developer) role + + + +

+The Jetspeed Desktop is a client-side JSR-168 aggregation engine. +To accesss the Desktop, navigate your browser to http://localhost:8080/jetspeed/desktop +When switching between the /desktop and the /portal URLs, logout to start a new session. +

+ + +

+ After running the installation, you can manually reinitialize the database or even switch to another database. + To do so, we provide an Ant script found under the database directory of your installed Jetspeed portal. + The database configuration is defined in the database.properties file. To reinitialize or change the database, + go to the database directory and edit the database.properties file, save it, and then run ant. +

+

Here is a sample database configuration file: +

+ +; Jetspeed Enterprise Portal 2.1 Database setup configuration +; db.type supported values: db2, derby, mssql, mysql, oracle, postgres, sapdb +db.type=mysql +: for db.type other than derby, the properties below need to be specified +db.username=j2 +db.password=abracadabra +jdbc.url=jdbc:mysql://localhost:3306/prod-2 +jdbc.driver.class=com.mysql.jdbc.Driver + +

If you are configuring a database for the first time after choosing Manual database setup in the installer, or want to try out + a different type of database, make sure to copy the specific JDBC driver for the database to the Tomcat shared/lib folder before running ant.
+ Note: for Derby, the needed driver is already placed there or available from the database/lib directory of your installed Jetspeed portal.

+ +
+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-installer.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,442 @@ + + + + + + Getting Started with Jetspeed 2 using a Source Release (deprecated) + + Getting ready to modify Jetspeed + + + + + + + + +
+ +
    +
  • + Unless otherwise specified, you should be + running all maven build commands from within the + Jetspeed directory (if you are just building + Jetspeed) or from within your custom portal + directory. +
    • +
  • + You must use "/" as a file seperator on both + *nix and windows, e.g. c:/windows, and /home. +
    • +
+ + +

+ Below is a listing of common conventions used within + this document. +

+

+ Variables are represented as ${ + some_variable + }. This may signify a setting in Jetspeed or may + represent a setting within your environment. + Properties files are also capable of specifying + variables within them. +

+

+ For example, ${org.apache.jetspeed.server.home} + references either a property defined further up in + the properties file, a variable that has been + defined somehwere within the build process or + defined in another build file within Jetspeed. +

+
    +
  • + ${USER_HOME} + : This is the user's home directory. For Windows + systems, this generally c:\Documents and + Settings\${userName} where ${userName} is the + name you use to log into windows. +
    + ${USER.HOME} is synonymous with ${USER_HOME} + within this document. +
    • +
  • + ${CATALINA_HOME} + : This is the location of your tomcat + installation, e.g. + c:/tomcat + . +
    • +
+ + +

+ + Subversion (SVN) + + is used in the Jetspeed project to manage the source + files. SVN is very similar to CVS. For those user's + on Windows system who prefer non-command line access + we suggest using + + TortoiseSVN + + which plugs into your Windows Explorer view. For + those using the Eclipse IDE, the + Subclipse + plugin is available for SVN access. +

+ + +

+ We will not go into the specifics of Maven as that + is beyond the scope of this document. However, here + are a few bits of standard maven jargon we feel is + important for you to know. +

+

+ You will see mention of a + maven repository + in this document. When you install Maven the .maven/ + directory is created in your ${USER_HOME) directory. +
+ Under .maven/ you will see a + repository + directory. This is were Maven stores all the jars + that it downloads when you run your builds. This is + also were Maven puts your jars and wars that you + build. They will be stored in a directory structure + that has the format of + ${groupId}/${projectId}/jars/${projectId}-{$version}.jar + for jar files and + ${groupId}/${projectId}/wars/${projectId}.war for + war files. The ${groupId}, ${projectId} and + ${version} variables are discussed later on in this + document. Jar and war files will also be created in + your project in the + /target + directory. +

+ +
+ + +
+

+ Now we're going to configure, setup and build a new + custom portal application using the Jetspeed-2 + maven-plugin. +

+ +

+ Maven2 install the plugins by it self, make sure you mention your repositories in your settings.xml +

+ + +

+ Once you have the maven-plugin installed and set + properties as needed, generate a default portal + configuration using the plugin as follows: + + + +

+ + +

+ You would need specify you database which would be used to creating portal schema. + jetspeed pluin have created an jetspeed-mvn-settings.xml, in root of project location + you need to fill properties, with correct database information. + + You also need to specify the tomcat location, where portal need to deployed make sure + tomcat version should be above 5.5.27 +

+ + org.apache.derby + + derby + + 10.3.2.1 + + + + derby + + jdbc:derby:/tmp/derby/testdb;create=true + + org.apache.derby.jdbc.EmbeddedDriver + + + + ]]> + + + +

+ Once your portal configuration and setup is ready, + you can build and install the portal application in + your local maven repository (as needed for + deployment) using the following standard maven goal. + + + +

+

+ You are now ready to deploy the new portal + application. For this, skip the following section on + building the Jetspeed 2 portal from source and + continue with the + deployment + section. +

+ +
+
+

+ Build the Jetspeed 2 portal directly from the source is + somewhat easier to do but should only be done if you + don't want to create a new, customizable portal. +

+ +

+ The Jetspeed 2 source contains a + jetspeed-mvn-settings-sample.xml + file which provides all of the required portal + configuration settings as described. You need copy this file to jetspeed-mvn-settings.xml + + above + + . +

+

+ You should + + not + + define any of those properties in your + ${m2_HOME}/settings.xml + . +
+

+

+ When you are going to deploy the portal as described + further below, you'll see references to the + org.apache.jetspeed.portal.home + which you can translate with the root folder of your + Jetspeed 2 source. +

+

+ If you want to run the testcases when building the + Jetspeed 2 sources + and + don't want to use the default Derby test database, + you need to override the default test database + properties, similar to the production database + properties as described + + above + + : +

    +
  • + + org.apache.jetspeed.test.database.default.name + +
    • +
  • + + org.apache.jetspeed.test.database.url + +
    • +
  • + + org.apache.jetspeed.test.database.user + +
    • +
  • + + org.apache.jetspeed.test.database.password + +
    • +
  • + + org.apache.jetspeed.test.database.driver + +
    • +
  • + + org.apache.jetspeed.test.database.drivers.path + +
    • +
+

+ + +

+ For a full build and installation of the portal and + the demo portlet applications in your local maven + repository run: + + + +

+

+ But, if you also want to run the testcases during + the build run the following instead: + + + +

+

+ You are now ready to deploy the Jetspeed 2 Portal. +

+ +
+
+ +

+ We currently only cover deploying to Tomcat 5 or + Tomcat 5.5. +

+

+ Information about deployment to other application + servers can be found at the The Jetspeed 2 + + Wiki + + . +

+

+ To deploy a default Jetspeed 2 portal, including the + demo portlet applications, run the following in a + separate + console: + + + + + Note: the + + maven-plugin documentation + + described other goals you can use to customize + the deployment to your taste. + +

+ + +

+ The final step is starting up your Tomcat server and + the portal will automatically install any deployed + portlet applications. +

+

+ Then you can access the portal with your browser at: + http://localhost:8080/jetspeed + or replace "jetspeed" in the above url with the name + of you own portal application ( + + ${org.apache.jetspeed.portal.artifactId} + + ). +

+ + +

+ With the default Jetspeed 2 portal deployment, + several example user accounts are inserted into the + portal database with which you can logon to the + portal: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
usernamepasswordroles
+ admin + + admin + + admin, manager, user +
+ manager + + manager + + manager, user +
+ jetspeed + + jetspeed + + manager +
+ user + + user + + user +
+ tomcat + + tomcat +
+

+ +
+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started-source.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,202 @@ + + + + + Getting Started with Jetspeed 2 + Getting up and running quickly + + + + + + + + +
+

+ It is expected that the user is familiar with both the + Apache Maven + project management tool. +

+
    +
  • + + Maven 2.0.9 + +
    • +
  • Java 1.5 or higher
    • +
  • + Servlet 2.4 Engine: +
      +
    • Tomcat 5.5.26
      • +
    • Jetty
      • +
    • Websphere 6.0
      • +
    • Geronimo
      • +
    • JBoss
      • +
    • Weblogic
      • +
    + +
    • +
+
+ +
+

+ If you have not already done so, download and install + Maven2 + . +

+
+
+

+ Jetspeed's security model requires a database to + authorize users and to retain the user information. + Jetspeed security should work with any JDBC 2.0 + compliant driver. The following databases are tested: +

    +
  • Derby
    • +
  • HSQLDB - Hypersonic SQL
    • +
  • MySQL
    • +
  • Oracle
    • +
  • Postgres
    • +
  • DB2
    • +
  • Sybase
    • +
  • SQL Server
    • +
+ + Jetspeed is distributed with the Derby database + configured as the default. +

+

+ The database configuration will be setup during the + installation process. If you are not going to use the + default Derby database, you need to select another database + during installation. +

+
+
+

+ In theory, Jetspeed 2 portals can be run under any + servlet container supporting the 2.4 specification or + greater. Successful Jetspeed 2 portal applications have + been deployed using: +

    +
  • Tomcat 5.5.26 or higher
    • +
  • Jetty
    • +
  • Websphere
    • +
  • Geronimo
    • +
  • JBoss
    • +
+

+ +

+ Jetspeed 2 can use the Tomcat Manager application + for managing portlet applications with the Portlet + Application Lifecycle Manager Portlet (PALM). To be + able to do so it needs a configured Tomcat user with + the predefined 'manager' role in the + ${org.apache.jetspeed.server.home}/conf/tomcat-users.xml. +

+

+ A minimal example tomcat-users.xml can look like: + + + + +]]> + + + The attribute values for username and password + must correspond to the specified values for + + ${org.apache.jetspeed.services.autodeployment.user} + + and + + ${org.apache.jetspeed.services.autodeployment.user} + + as described above. + +

+ + +

+ To have redeployment and undeployment working + properly when using Tomcat 5.5.9 on Windows you have + to set the global Context attribute "antiJARLocking" + to true. +

+

+ In + ${org.apache.jetspeed.server.home}\conf\context.xml + use: + + + ... + ]]> + +

+ + +

+ Jetty can be used for a production deployment but it is + most commonly used to quickly test customizations + without interfering with the production servlet + container. It does not require any special + configuration. +

+ +
+
+

+ Depending on what you want to do, you have the choice of + installing Jetspeed from a binary release or from the + sources. If you want to modify the core functionality of + Jetspeed or contribute to the development of Jetspeed, + you need to work with the sources. If you are only + interested in building your own custom enterprise + portal, you can start with a binary release of Jetspeed. + Most people should start with the binary distribution. +

+
+
+

+ Your installation instructions will depend on whether + you are + + building from source + + or + + building from a binary distribution + + or + + installing with Jetspeed-2 installer + + . +

+
+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/getting-started.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,37 @@ + + + + + Guide to Federated Security + Federated Security Configuration Overview + + + + + +
+

+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 +

+
+ + \ No newline at end of file Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guide-federated-security.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,256 @@ + + + + + Jetspeed 2 Aggregation + Guide to Jetspeed Aggregation + + + + + +
+

+ 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. +

+
+
+

List of Aggregators:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Component NameDescriptionMultithreaded?JSR-168 Caching?
PageAggregatorGiven a PSML page, aggregates the content of all portlets on that page.noyes
AsyncPageAggregatorA multi-threaded, asynchronous PSML page aggregator.yesyes
PortletAggregatorRenders the content of one single portlet.no*yes
AsyncPageAggregator + CommonJA multi-threaded, asynchronous PSML page aggregator running CommonJ Work Monitor threads, tested only with IBM Websphere 6.1 only.yesyes
+ * multi-threading is accomplished with the Jetspeed Desktop combined with the PortletAggregator +
+
+

+

+ + + + 0 + +]]> + +

+

+ +
+ +
+

+ The default aggregator is single-threaded. To switch to multi-threaded, + edit the pipelines.xml spring configuration file: +

+ + + + + + + + + + + + +]]> + +

+

+ +
+
+

+ 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. +

+ + + PickANumberPortlet + 3000 + +]]> + +

+

+ +
+
+

Running mulithreaded aggregation with Jetspeed requires the following configuration steps. + Note that steps 1 and 2 are required for all Websphere installations and are not specific to multithreaded aggregation. +

+ +

Configure the WEB-INF/web.xml to use the PortalFilter for logging in by uncommented the PortalFilter and its mapping:

+ + + PortalFilter + org.apache.jetspeed.login.filter.PortalFilter + +... + + PortalFilter + /* + +]]> + + + +

Edit the default-page.psml, changing the login portlet to the filter-based login portlet as shown below. + Make sure to also change the fragment id. Change:

+ + + ... +]]> + +

to ..

+ + + ... +]]> + + + +

+Some webcontainers like WebSphere 5.x derive critical information of the HttpServletRequest dynamically from the current application context. +This means that in an invoked portlet application, the original Portal request, as stored in the RequestContext, for example doesn't returns the Portal contextPath, servletPath and HttpSession of the Portal application. You'll get the same object references as in the current application HttpServletRequest. +Because of this, simple things as portal level login through a custom portlet isn't possible in these web containers. +

+

+To solve this, an additional PortalRequest wrapper will be used which registers the initial (portal) object references from a supplied request and always returns those, +instead of delagating to the wrapped request. +Which wrapper is used is handled by a new PortalRequestFactory which can be specified in the springframework configuration. +For other web containers like Tomcat which doesn't have this "problem", nothing has to be specified (none is by default), in which case the request will be wrapped in an HttpServletRequestWrapper to maintain the same level of wrapping (needed for easy access to the original request in ServletPortletInvoker. +

+

Edit WEB-INF/assembly/wps.xml, and uncomment the one bean found there

+ + + + + +]]> + + + +

Swap out the (org.apache.jetspeed.aggregator.PageAggregator) with the multithreaded aggregation engine in WEB-INF/assembly/pipelines.xml: +

+ + + + + + +]]> + + + +

You can replace the default portlet request/response unwrapper with a third-party module in WEB-INF/assembly/pluto-factories.xml.

+

Because the servlet request object of a servlet container could not be thread-safe under Jetspeed parallel rendering mode, the third-party unwrapper module can provide a thread-safe implementation by decorating the original request object.

+

Here's an example setting for third-party unwrapper module:

+ + + +]]> + + + +

If you want to use Commonj Work Manager provided by the container, uncomment the followings in WEB-INF/assembly/aggregation.xml:

+ + + false + + java:comp/env/wm/jetspeed + + + + + + + +]]> + +

+ Also replace all references to org.apache.jetspeed.aggregator.WorkerMonitor with org.apache.jetspeed.aggregator.CommonjWorkerMonitor in WEB-INF/assembly/aggregation.xml. +

+ +
+ + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-aggregation.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,1095 @@ + + + + + AJAX XML API + Documentation for Jetspeed-2 AJAX XML API + + + + + +
+

+The Jetspeed XML AJAX API is an XML-based API provided to AJAX clients for making +asynchronous requests to Jetspeed-2 services.

+

+Typical use cases: +

+
    +
  • Page Customization and Portlet Placement - To move, copy, add, or remove portlets on a page
    • +
  • Layout Selection - change the layout (number of rows and columns, size of columns) on a page
    • +
  • Theme and Decorator Selection - change the page theme and portlet decorators on a page.
    • +
  • Portlet Selectors - provide a select-list of portlets to the end user
    • +
  • Security Configuration - configure the security constraints or policy on a resource (page, portlet, folder, link, fragment), or portal wide
    • +
  • Menu Configuration - create and edit menus for the Jetspeed Site
    • +
  • General Administration - all use cases for general administration have not yet been explored.
    • +
+ +

+All AJAX XML API requests run through +a standard Jetspeed Pipeline 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. +

+ +
+
+

+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: + +

+ +

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: + +The page location algorithm using standard Jetspeed Profiling rules to locate the page. +A page is actually not required in the URL, since the Jetspeed Profiler will locate the page +for you. Example: + +goes to the default page for the current user. +

+

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 PSML. (PSML is an XML format). +See the table below for specific examples of request parameters. +

+

Here are the APIs currently available: +

+ + + + + + + + + + + + + + + + + +
API:getpage
Component:AjaxGetPage
Description:Get Page retrieves a page from the Page Manager store in PSML format. +
Parameters:
+ + + + + + + + +
pageimplied in the URL
actiongetportlets (optional, this is the default action)
+ + + API example: + + + + + + XML Response: + + +success +getpage + + +]]> + + + + + + + + + + + + + + + + + + + + + +
API:moveabs
Component:AjaxMovePortletAbsolute
Description:Move a portlet on a page to an absolute position specified in the row and col request parameters.
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
pageimplied in the URL
actionmoveabs
idthe portlet PSML fragment id of the portlet to be moved
rowthe absolute new row location to place the portlet fragment (zero based)
colthe absolute new column location to place the portlet fragment (zero based)
+ + + API example: + + + + + + XML Response: + + + success + moveabs + ps-1003 + + 1 + 1 + + + 1 + 0 + + +]]> + + + + + + + + + + + + + + + + + + + + + +
APIs:moveleft, moveright, moveup, movedown
Components:AjaxMovePortletLeft, AjaxMovePortletRight, AjaxMovePortletUp, AjaxMoveDown
Description:Move a portlet on a page relatively one position, based on the action.
Parameters:
+ + + + + + + + + + + + +
pageimplied in the URL
actionmoveleft, moveright, moveup, movedown
idthe portlet PSML fragment id of the portlet to be moved
+ + + API example: + + + + + + XML Response: + + + success + movedown + ps-1003 + + 1 + 0 + + + 1 + 1 + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:move
Component:AjaxMovePortlet
Description:Move a portlet on a page to a cartesian position (x,y,z,width,height) from request parameters.
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
pageimplied in the URL
actionmove
idthe portlet PSML fragment id of the portlet to be moved
xthe portlet cartesian X position
ythe portlet cartesian Y position
zthe portlte cartesian Z position
widththe width of the portlet
heightthe height cartesian Y position
+ + + API example: + + + + + + XML Response: + + + success + move + ps-1003 + + 50 + 155 + + + 100 + 250 + + +]]> + + + + + + + + + + + + + + + + + + + + +
API:add
Component:AjaxAddPortlet
Description: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.
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
pageimplied in the URL
actionadd
idThe portlet full name to be placed on the page, using Jetspeed Portlet Naming (PortletApplicationName::PortletName)
rowoptional: the absolute new row location to place the new portlet fragment (zero based)
coloptional: the absolute new column location to place the new portlet fragment (zero based)
+ + + API example: + + + + + + XML Response: + + + success + add + jsf-demo::CalendarPortlet + + 0 + 0 + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:remove
Component:AjaxRemovePortlet
Description:Removes a new portlet from the current page.
Parameters:
+ + + + + + + + + + + + +
pageimplied in the URL
actionremove
idthe portlet PSML fragment id of the portlet to be removed
+ + + API example: + + + + + + XML Response: + + + success + remove + jsf-demo::CalendarPortlet + + 0 + 0 + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getportlets
Component:AjaxGetPortlets
Description: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.
Parameters:
+ + + + + + + + + + + + + +
pageimplied in the URL
actiongetportlets
filternot yet implemented. A query filter to be defined.
+ + + API example: + + + + + + XML Response: + + +success +getportlets +- + + + + + + + + + +.... + + + + + + +]]> + + + + + + + + + + + + + + + + + + + + + + + +
API:permissions
Component:AjaxSecurityPermissions
Description:Security Permissions Maintenance to add, update, and remove permissions from the Jetspeed security policy
Parameters:
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
actionpermissions
methodthe method to execute: must be of value: add | update | remove
typethe type of permission being manipulated: portlet | folder | page
resourcethe name of the portal resource being manipulated
rolescomma-separated list of roles, only valid for methods: add, update
actionscomma-separated list of actions, only valid for methods: add, update
oldactionscomma-separated list of previous actions, only valid for methods: update
+ + + API example: + + + + + + XML Response: + + + success + permissions + demo::* + portlet + view,edit + role1,role2,role3 + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getmenus
Component:AjaxGetMenus
Description:Retrieves all menus for the current page (implied in URL)
Parameters:
+ + + + + + + + +
actiongetmenus
page(implied in URL)
+ + + API example: + + + + + + XML Response: + + + success + getmenus + + navigations + back + pages + breadcrumbs + site-navigations + additional-links + page-navigations + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getmenu
Component:AjaxGetMenu
Description:Retrieves the menu definition for a given menu
Parameters:
+ + + + + + + + +
actiongetmenu
menuname of the menu to retrieve (menu definition may change per page)
+ + + API example: + + + + + + XML Response: + + +success +getmenu + + breadcrumbs + You are here: + You are here: + breadcrumbs + /default-page.psml + false + true + + + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getmenus
Component:AjaxChangeWindow
Description:Changes a portlet window's Window State or Portlet Mode
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
actionwindow
idwindow id of the portlet to be modified
stateA portlet api valid window state or extended window state (normal | maximized | minimized)
modeA portlet api valid portlet mode or extended portlet mode (view | edit | help | print)
pageImplied in URL
+ + + API example: + + + + + + XML Response: + + + success + window + um-2 + maximized + edit + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getuseinfo
Component:AjaxGetUserInformation
Description:Returns information about the currently logged in user. Can be used for example in AJAX based portlets to retrieve the userinfo in a more robust way. Will return success only if a user is currenly logged in, otherwise will return false.
Parameters:
+ + + + +
actiongetuserinfo
+ + + API example: + + + + + + XML Response: + + + success + userinformation + admin + org.apache.jetspeed.security.impl.UserPrincipalImpl + + Test Dude + Dudley + + +]]> + + + + + + + + + + + + + + + + + + + + + + +
API:getuseinfo
Component:AjaxGetUserList
Description:Provides basic information (username, ip-address, number of sessions and status) about currently logged in users in xml-format. Optionally it can also provide more detailed userinformation, number of guest sessions and include offline users as well.
Parameters:
+ + + + + + + + + + + + + + + + + + + + +
actiongetuserinfo
userinfoWhether we should include also userinfo (true | false [default])
offlineWhether we should include offline users (true | false [default])
guestWhether we should return also the guest sessions (true | false [default])
allIf set to true, will return every bits and piece there is (true | false [default])
+ + + +

+ By default the private information (emails, etc..) is protected with + RolesSecurityBehavior security, but can be changed in AJAX configuration + by altering the protectionScope constructor value to either "all" to protect + even the basic information or to "none" when everything will be shown for everyone (not wise on production). + The default value "private" will show just the basic information of online/offline users and number of guest sessions, + as the "private-offline" will not show even the offline users. Possible protectionScope values are "all", + "private-offline", "private" and "none". +

+ + + + API example: + + + + + + XML Response: + + + success + getuserlist + + + admin + 1 + online + 127.0.0.1 + + Test Dude + Dudley + + + 0 + + +]]> + + + + + +
+ +
+

+The AjaxRequestService is a Spring component that handles AJAX requests. +It is hooked into the AJAX Pipeline for special processing +of AJAX request. Here is the Spring Assembly. Each API is configured in the Ajax Service. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +]]> + +
+ + + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-ajax-api.xml ------------------------------------------------------------------------------ svn:keywords = Id Added: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml?rev=722405&view=auto ============================================================================== --- portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml (added) +++ portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml Tue Dec 2 00:53:22 2008 @@ -0,0 +1,249 @@ + + + + + Application Servers Configuration + Application Servers Configuration for Jetspeed 2 + + + + + + + + +
+

+ + Note: The maven-plugin currently only supports the + Tomcat Server 5.0.x or 5.5.x + +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescriptionDefault value
+ org.apache.jetspeed.server.home + + The root folder of your Tomcat server + installation. +
+ Example: + ${CATALINA_HOME}/ + . + 		+ no default +
+ org.apache.jetspeed.server.shared + + The location of the shared jars in your Tomcat + installation. +
+ Example: + + ${org.apache.jetspeed.server.home}/shared/lib/ + + 		+ no default +
+ org.apache.jetspeed.deploy.war.dir + + The location of web applications in your Tomcat + installation. +
+ Example: + + ${org.apache.jetspeed.server.home}/webapps/ + + 		+ no default +
+ + org.apache.jetspeed.services.autodeployment.user + + + A Tomcat user with the manager role. +
+ Used to access the Tomcat Manager application + from within the portal, explained below. + 		+ no default +
+ + org.apache.jetspeed.services.autodeployment.password + + + The password of the Tomcat user above. +
+ Used to access the Tomcat Manager application + from within the portal, explained below. + 		+ no default +
+ + org.apache.jetspeed.catalina.version.major + + + The major version of the Tomcat server you are + using: 5 or 5.5 +
+ Example: + 5.5 + 		+ no default +
+
+
+

+ Jetspeed-2 and its maven-plugin uses, as well as + provides, by default a Derby database. +

+

+ If you want to use a different database you will need to + override the following properties: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescriptionDefault value
+ + org.apache.jetspeed.production.database.default.name + + + The type of database you are using. Used for sql + script generation with Torque. +
+ Currently supported databases (with + corresponding Torque target database name): +
    +
  • derby (derby)
    • +
  • hsql (hypersonic)
    • +
  • oracle (oracle)
    • +
  • mysql (mysql)
    • +
  • postgres (postresql)
    • +
  • mssql (mssql)
    • +
  • sapdb (sapdb)
    • +
  • db2 (db2)
    • +
+ 		derby
+ + org.apache.jetspeed.production.database.url + + The jdbc connection urljdbc:derby:${org.apache.jetspeed.derbydatabase.path}/productiondb;create=true
+ + org.apache.jetspeed.production.database.user + + The database user name to connect with.empty
+ + org.apache.jetspeed.production.database.password + + + The database user its password to connect with. + + empty +
+ + org.apache.jetspeed.production.database.driver + + The jdbc driver class nameorg.apache.derby.EmbeddedDriver
+ + org.apache.jetspeed.production.jdbc.drivers.path + + + A Java classpath style path to the jdbc driver + classes or jar(s) needed for connecting to the + database. +
+ Example: + + /lib/ojdbc14.jar;/lib/nls_charset12.jar + + 		+ empty +
+
+ + + Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/branches/JS2-871-pluto-2.0-upgrade/src/site/xdoc/guides/guide-app-servers.xml ------------------------------------------------------------------------------ svn:keywords = Id --------------------------------------------------------------------- To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org For additional commands, e-mail: jetspeed-dev-help@portals.apache.org