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 ta...@apache.org on 2009/04/24 00:28:39 UTC
svn commit: r768082 [7/8] - in
/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs: ./
adminguide/ adminguide/images/ deployguide/ deployguide/images/ devguide/
usersguide/
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml?rev=768082&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml Thu Apr 23 22:28:35 2009
@@ -0,0 +1,1130 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
+ Getting Started with Jetspeed 2 using a Source Release (deprecated)
+ </title>
+ <subtitle>Getting ready to modify Jetspeed</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Ate Douma" email="ate@apache.org" />
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Ron Wheeler"
+ email="rwheeler@artifact-software.com" />
+ </authors>
+ </properties>
+ <body>
+ <section name="1. Building Jetspeed with Maven-1">
+ <p><i>Note the Maven-1 build will be <b>deprecated</b> in Jetspeed version 2.2</i></p>
+ <subsection name="Source Basic Assumptions">
+ <ul>
+ <li>
+ 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.
+ </li>
+ <li>
+ You must use "/" as a file seperator on both
+ *nix and windows, e.g. c:/windows, and /home.
+ </li>
+ </ul>
+ </subsection>
+ <subsection name="Naming Conventions">
+ <p>
+ Below is a listing of common conventions used within
+ this document.
+ </p>
+ <p>
+ Variables are represented as ${
+ <i>some_variable</i>
+ }. 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.
+ </p>
+ <p>
+ 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.
+ </p>
+ <ul>
+ <li>
+ <b>${USER_HOME}</b>
+ : 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.
+ <br />
+ ${USER.HOME} is synonymous with ${USER_HOME}
+ within this document.
+ </li>
+ <li>
+ <b>${CATALINA_HOME}</b>
+ : This is the location of your tomcat
+ installation, e.g.
+ <i>c:/tomcat</i>
+ .
+ </li>
+ </ul>
+ </subsection>
+ <subsection name="Source Subversion (SVN)">
+ <p>
+ <a href="http://subversion.tigris.org">
+ Subversion (SVN)
+ </a>
+ 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
+ <a href="http://tortoisesvn.tigris.org">
+ TortoiseSVN
+ </a>
+ which plugs into your Windows Explorer view. For
+ those using the Eclipse IDE, the
+ <a href="http://subclipse.tigris.org">Subclipse</a>
+ plugin is available for SVN access.
+ </p>
+ </subsection>
+ <subsection name="Maven Setup">
+ <p>
+ 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.
+ </p>
+ <p>
+ You will see mention of a
+ <i>maven repository</i>
+ in this document. When you install Maven the .maven/
+ directory is created in your ${USER_HOME) directory.
+ <br />
+ Under .maven/ you will see a
+ <i>repository</i>
+ 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
+ <i>/target</i>
+ directory.
+ </p>
+ </subsection>
+ </section>
+
+ <section name='2. Jetspeed build and maven-plugin Properties'>
+ <p>You need to set a few properties.</p>
+ <p>
+ Creating your own custom portal is very easy with the
+ maven plugin provided by Jetspeed 2. And, it is used
+ when you build jetspeed from source as well. In fact,
+ the jetspeed-2 build procedure is just one example of a
+ custom portal configuration and setup.
+ </p>
+ <p>
+ The Jetspeed 2 maven-plugin defines default values for
+ most of the properties you can set, but not all. When
+ you download or checkout the jetspeed-2 source tree,
+ you'll see it contains a project.properties file in the
+ root folder overriding and setting some of these
+ properties.
+ </p>
+ <p>
+ As said before: not all properties are provided with a
+ default value: you
+ <i>must</i>
+ specify a few yourself. And you'll most likely want to
+ override some others.
+ </p>
+ <p>
+ Set or override the build or maven-plugin properties in
+ your
+ <code>${USER_HOME}/build.properties</code>
+ file.
+ </p>
+ <subsection
+ name="Required Portal Configuration Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.home</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will
+ (re)create or update your custom portal
+ maven project configuration (with goal
+ <code>j2:portal.conf.project</code>
+ ). This will be where you will be performing
+ all of your future custom portal
+ development.
+ <br />
+ Example:
+ <code>/home/myportal/</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.groupId
+ </code>
+ </td>
+ <td>
+ The (maven) short name of your portal
+ project group.
+ <br />
+ This value is used for the maven repository
+ folder in which the project artifacts (like
+ the portal war file) is stored.
+ <br />
+ Example:
+ <code>myprojects</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.artifactId
+ </code>
+ </td>
+ <td>
+ The (maven) short name of your portal
+ project.
+ <br />
+ This value is used for the portal war file
+ and the (portal) web application context
+ name.
+ <br />
+ Example:
+ <code>myportal</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.name</code>
+ </td>
+ <td>
+ The (maven) full name of your portal
+ project.
+ <br />
+ This value is used by maven for generating
+ JavaDoc titles.
+ <br />
+ Example:
+ <code>My Test Portal</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.currentVersion
+ </code>
+ </td>
+ <td>
+ The current version of your portal project.
+ <br />
+ This value is used by maven as name postfix
+ for the generated artifacts.
+ <br />
+ Example:
+ <code>1.0</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection
+ name="Optional Portal Configuration Properties">
+ <p>
+ The following properties all specify a subfolder of
+ the
+ <code>${org.apache.jetspeed.portal.home}</code>
+ location as defined above.
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.conf.dir
+ </code>
+ </td>
+ <td>
+ The folder where the maven-plugin will
+ generate and copy application server
+ specific configuration files as a tomcat
+ application context descriptor.
+ <br />
+ This folder and its contents is created or
+ updated by plugin goal
+ <code>j2:portal.conf.tomcat</code>
+ .
+ </td>
+ <td>
+ <i>target/portal-conf</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.sql.dir
+ </code>
+ </td>
+ <td>
+ The folder where the maven-plugin will
+ generate and copy portal and database server
+ specific sql DDL and DML scripts.
+ <br />
+ This folder and its contents is always
+ (re)created by plugin goal
+ <code>j2:portal.conf.sql</code>
+ .
+ </td>
+ <td>
+ <i>target/portal-sql</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.db.dir
+ </code>
+ </td>
+ <td>
+ The folder where the maven-plugin will
+ create build-in HSQLDB database(s).
+ <br />
+ This folder and its contents is created or
+ updated by plugin goal
+ <code>j2:start.production.server</code>
+ or
+ <code>j2:start.test.server</code>.
+ <br/>
+ <i>This property is not needed/used for anything else.</i>
+ </td>
+ <td>
+ <i>target/portal-db</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.webapp.dir
+ </code>
+ </td>
+ <td>
+ The folder where the maven-plugin will copy
+ the standard jetspeed web application
+ resources.
+ <br />
+ This folder and its contents is created or
+ updated by plugin goal
+ <code>j2:portal.copy.webapp</code>
+ .
+ </td>
+ <td>
+ <i>
+ target/${org.apache.jetspeed.portal.artifactId}
+ </i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.portal.target.dir
+ </code>
+ </td>
+ <td>
+ The folder where the maven-plugin will
+ generate and copy runtime portal
+ configuration files.
+ <br />
+ These configuration files contain values
+ derived from build/plugin properties for the
+ portal and OJB.
+ <br />
+ This folder and its contents is created or
+ updated by plugin goal
+ <code>j2:portal.conf.jetspeed</code>
+ and goal
+ <code>j2:portal.conf.ojb</code>
+ .
+ </td>
+ <td>
+ <i>
+ target/${org.apache.jetspeed.portal.artifactId}
+ </i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Required Application Server Properties">
+ <p>
+ <i>
+ Note: The maven-plugin currently only supports
+ the Tomcat Server 5.0.x or 5.5.x
+ </i>
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.server.home</code>
+ </td>
+ <td>
+ The root folder of your Tomcat server
+ installation.
+ <br />
+ Example:
+ <code>${CATALINA_HOME}/</code>
+ .
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.server.shared
+ </code>
+ </td>
+ <td>
+ The location of the shared jars in your
+ Tomcat installation.
+ <br />
+ Example:
+ <code>
+ ${org.apache.jetspeed.server.home}/shared/lib/
+ </code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.deploy.war.dir
+ </code>
+ </td>
+ <td>
+ The location of web applications in your
+ Tomcat installation.
+ <br />
+ Example:
+ <code>
+ ${org.apache.jetspeed.server.home}/webapps/
+ </code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.services.autodeployment.user
+ </code>
+ </td>
+ <td>
+ A Tomcat user with the manager role.
+ <br />
+ Used to access the Tomcat Manager
+ application from within the portal,
+ explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.services.autodeployment.password
+ </code>
+ </td>
+ <td>
+ The password of the Tomcat user above.
+ <br />
+ Used to access the Tomcat Manager
+ application from within the portal,
+ explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.catalina.version.major
+ </code>
+ </td>
+ <td>
+ The major version of the Tomcat server you
+ are using: 5 or 5.5
+ <br />
+ Example:
+ <code>5.5</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Optional Database Server Properties">
+ <p>
+ Jetspeed-2 and its maven-plugin uses, as well as
+ provides, by default a Derby database.
+ </p>
+ <p>
+ If you want to use a different database you will
+ need to override the following properties:
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.database.default.name
+ </code>
+ </td>
+ <td>
+ The type of database you are using. Used for
+ sql script generation with Torque.
+ <br />
+ Currently supported databases (with
+ corresponding Torque target database name):
+ <ul>
+ <li>derby</li>
+ <li>hsql (hypersonic)</li>
+ <li>oracle (oracle)</li>
+ <li>mysql (mysql)</li>
+ <li>postgres (postgresql)</li>
+ <li>mssql (mssql)</li>
+ <li>sapdb (sapdb)</li>
+ <li>db2 (db2)</li>
+ </ul>
+ </td>
+ <td>derby</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.derbydatabase.path
+ </code>
+ </td>
+ <td>Path to where the embedded derby database will be created/expected</td>
+ <td>/tmp</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.database.url
+ </code>
+ </td>
+ <td>The jdbc connection url</td>
+ <td>jdbc:derby:${org.apache.jetspeed.derbydatabase.path}/productiondb;create=true</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.database.user
+ </code>
+ </td>
+ <td>The database user name to connect with.</td>
+ <td>sa</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.database.password
+ </code>
+ </td>
+ <td>
+ The database user its password to connect
+ with.
+ </td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.database.driver
+ </code>
+ </td>
+ <td>The jdbc driver class name</td>
+ <td>org.apache.derby.jdbc.EmbeddedDriver</td>
+ </tr>
+ <tr>
+ <td>
+ <code>
+ org.apache.jetspeed.production.jdbc.drivers.path
+ </code>
+ </td>
+ <td>
+ A Java classpath style path to the jdbc
+ driver classes or jar(s) needed for
+ connecting to the database.
+ <br />
+ Example:
+ <code>
+ /lib/ojdbc14.jar;/lib/nls_charset12.jar
+ </code>
+ </td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection
+ name="Example: A minimal custom portal configuration">
+ <p>
+ Make sure you have define at least the required
+ properties as described above in your
+ <code>${USER_HOME}/build.properties</code>
+ . A minimal custom portal configuration using the
+ default embedded Derby database can be something like:
+ <source>
+ <![CDATA[
+# required portal configuration properties
+org.apache.jetspeed.portal.home = /home/myportal/
+org.apache.jetspeed.portal.groupId = myprojects
+org.apache.jetspeed.portal.artifactId = myportal
+org.apache.jetspeed.portal.name = My Test Portal
+org.apache.jetspeed.portal.currentVersion = 1.0
+
+# required application server properties
+org.apache.jetspeed.server.home = ${CATALINA_HOME}/
+org.apache.jetspeed.server.shared = ${org.apache.jetspeed.server.home}/shared/lib/
+org.apache.jetspeed.deploy.war.dir = ${org.apache.jetspeed.server.home}/webapps/
+org.apache.jetspeed.services.autodeployment.user = j2deployer
+org.apache.jetspeed.services.autodeployment.password = xxxxx
+org.apache.jetspeed.catalina.version.major = 5.5]]>
+ </source>
+ <i>
+ Note: If you're going to build the default
+ Jetspeed 2 portal directly from the source only
+ the
+ <code>org.apache.jetspeed.portal.home</code>
+ property is required from the set of required
+ portal configuration properties.
+ </i>
+ </p>
+ </subsection>
+ </section>
+ <section name="4. Creating a new Portal Application">
+ <p>
+ Now we're going to configure, setup and build a new
+ custom portal application using the Jetspeed-2
+ maven-plugin.
+ </p>
+ <subsection
+ name="4.1 Set the maven remote repository lookup configuration">
+ <p>
+ To be able to setup a Jetspeed 2 based portal the
+ maven remote repository lookup needs to be
+ configured properly in your
+ <code>${USER_HOME}/build.properties</code>
+ :
+ <source>
+ <![CDATA[
+maven.repo.remote = http://www.bluesunrise.com/maven/, http://www.ibiblio.org/maven/, \
+ http://dist.codehaus.org/, http://cvs.apache.org/repository]]>
+ </source>
+ <i>
+ Note: the order in which these repositories must
+ be specified is significant!
+ </i>
+ </p>
+ </subsection>
+ <subsection
+ name="4.2 Install the Jetspeed 2 maven-plugin">
+ <p>
+ The first time, and when you want to upgrade to a
+ newer version of Jetspeed 2, you need to install the
+ maven-plugin as follows:
+ <source>
+ <![CDATA[
+maven -DartifactId=maven-jetspeed2-plugin -DgroupId=org.apache.portals.jetspeed-2 -Dversion=2.1.3 plugin:download]]>
+ </source>
+ <i>
+ Note: you can set the version flag to the
+ specific version you want to install,
+ 2.1.3 is just an example here.
+ </i>
+ </p>
+ </subsection>
+ <subsection name="4.3 Generate a new portal project">
+ <p>
+ Once you have the maven-plugin installed and set
+ properties as needed, generate a default portal
+ configuration using the plugin as follows:
+ <source>
+ <![CDATA[
+maven j2:portal.genapp]]>
+ </source>
+ <i>
+ This maven goal actually executes several
+ subgoals which are further described in the
+ <a href="j2-maven-plugin.html">
+ maven-plugin documentation
+ </a>
+ itself.
+ </i>
+ </p>
+ </subsection>
+ <subsection
+ name="4.4 Further customization of the portal">
+ <p>
+ This section doesn't specify anything to do. After
+ the portal project is generated you can adapt and
+ customize it to your taste by overriding and merging
+ your own configurations and extensions.
+ </p>
+ <p>
+ You can regenerate or update (part of) your portal
+ project with the
+ <code>j2:portal.genapp</code>
+ goal as described in the previous section or use its
+ subgoals directly.
+ </p>
+ </subsection>
+ <subsection name="4.5 Build the portal">
+ <p>
+ 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
+ from your custom portal project directory (in
+ ${org.apache.jetspeed.portal.home}):
+ <source>
+ <![CDATA[
+maven war:install]]>
+ </source>
+ </p>
+ <p>
+ 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
+ <a href="#6__Deploy_and_Run">deployment</a>
+ section.
+ </p>
+ </subsection>
+ </section>
+ <section name='5. Build Jetspeed 2 from source'>
+ <p>
+ 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.
+ </p>
+ <subsection
+ name="5.1 Setup the Jetspeed 2 source and build properties">
+ <p>
+ The Jetspeed 2 source contains a
+ <code>project.properties</code>
+ file which provides all of the required portal
+ configuration settings as described
+ <a
+ href="#Required_Portal_Configuration_Properties">
+ above
+ </a>
+ .
+ </p>
+ <p>
+ You should
+ <i>
+ <b>not</b>
+ </i>
+ define any of those properties in your
+ <code>${USER_HOME}/build.properties</code>
+ .
+ <br />
+ Instead, you
+ <i>must</i>
+ set a
+ <code>org.apache.jetspeed.project.home</code>
+ property, specifying the location where you expanded
+ the downloaded source or checked out the source from
+ subversion, like:
+ <source>
+ <![CDATA[
+# required Jetspeed 2 portal configuration property for building from the source
+org.apache.jetspeed.project.home = /home/apache/jetspeed-2/]]>
+ </source>
+ <i>
+ Note: you still need to specify the required
+ application server properties as described
+ <a
+ href="#Required_Application_Server_Properties">
+ above
+ </a>
+ .
+ </i>
+ </p>
+ <p>
+ The Jetspeed 2 project.properties uses this property
+ to define the required
+ <code>org.apache.portal.home</code>
+ :
+ <source>
+ <![CDATA[
+org.apache.jetspeed.portal.home = ${org.apache.jetspeed.project.home}]]>
+ </source>
+ So, they are the same when you build the Jetspeed 2
+ portal from the source.
+ </p>
+ <p>
+ When you are going to deploy the portal as described
+ further below, you'll see references to the
+ <code>org.apache.jetspeed.portal.home</code>
+ which you can translate with the root folder of your
+ Jetspeed 2 source.
+ </p>
+ <p>
+ If you want to run the testcases when building the
+ Jetspeed 2 sources
+ <i>and</i>
+ 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
+ <a href="#Optional_Database_Server_Properties">
+ above
+ </a>
+ :
+ <ul>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.default.name
+ </code>
+ </li>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.url
+ </code>
+ </li>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.user
+ </code>
+ </li>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.password
+ </code>
+ </li>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.driver
+ </code>
+ </li>
+ <li>
+ <code>
+ org.apache.jetspeed.test.database.drivers.path
+ </code>
+ </li>
+ </ul>
+ <i>
+ Note: due to outstanding issue
+ <a
+ href="http://issues.apache.org/jira/browse/JS2-320">
+ JS2-320
+ </a>
+ you currently
+ <b>must</b>
+ use hard coded values for the test database
+ properties.
+ </i>
+ </p>
+ </subsection>
+ <subsection name="Initialize the maven-plugin">
+ <p>
+ Instead of downloading and installing the Jetspeed 2
+ maven-plugin, you are going to build and install it
+ directly from the source. You will need to repeat
+ this every time you update to a newer version of
+ Jetspeed 2 or change its project configuration, the
+ plugin itself or the resources used by the plugin.
+ </p>
+ <p>
+ Build and install the maven-plugin as follows from
+ the root directory of the Jetspeed-2 source:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.project.home}
+maven initMavenPlugin]]>
+ </source>
+ </p>
+ </subsection>
+ <subsection
+ name="Optional: start the HSQLDB test database first">
+ <p>
+ If you are going to run the testcases and want to use
+ a HSQLDB database, you will
+ need to start a test database before building
+ Jetspeed 2 in a
+ <i>separate</i>
+ console:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.project.home}
+maven j2:start.test.server]]>
+ </source>
+ </p>
+ <p>
+ After the build is finished you can stop the
+ database and close this console with a
+ <code>Ctrl-C</code>
+ .
+ </p>
+ </subsection>
+ <subsection
+ name="Build the Jetspeed 2 portal and demo portlet applications">
+ <p>
+ For a full build and installation of the portal and
+ the demo portlet applications in your local maven
+ repository run:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.project.home}
+maven allClean allBuild]]>
+ </source>
+ </p>
+ <p>
+ But, if you also want to run the testcases during
+ the build run the following instead:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.project.home}
+maven -Dmaven.test.skip=false allClean allBuild]]>
+ </source>
+ </p>
+ <p>
+ You are now ready to deploy the Jetspeed 2 Portal.
+ </p>
+ </subsection>
+ </section>
+ <section name="6. Deploy and Run">
+ <subsection
+ name="Optional: start the HSQLDB production database first">
+ <p>
+ If you are using a HSQLDB database you
+ need to start it before deploying the portal.
+ </p>
+ <p>
+ To start a HSQLDB production database run the
+ following in a
+ <i>separate</i>
+ console:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:start.production.server]]>
+ </source>
+ </p>
+ <p>
+ You need to have this database running during the
+ deployment and while running the application server.
+ Afterwards you can stop the database and close this
+ console with a
+ <code>Ctrl-C</code>
+ .
+ </p>
+ <p>
+ Note: this is required when using the
+ <code>j2:quickStart</code>
+ goal as described below. The Jetspeed 2 maven-plugin
+ provides other (sub)goals which you can use without
+ (re)creating a production database and/or inserting
+ default portal configuration data. See the
+ <a href="j2-maven-plugin.html">
+ Plugin documentation
+ </a>
+ for further information about the available goals.
+ </p>
+ </subsection>
+ <subsection name="Deploy">
+ <p>
+ We currently only cover deploying to Tomcat 5 or
+ Tomcat 5.5.
+ </p>
+ <p>
+ Information about deployment to other application
+ servers can be found at the The Jetspeed 2
+ <a
+ href="http://wiki.apache.org/portals/Jetspeed2">
+ Wiki
+ </a>
+ .
+ </p>
+ <p>
+ To deploy a default Jetspeed 2 portal, including the
+ demo portlet applications, run the following in a
+ <i>separate</i>
+ console:
+ <source>
+ <![CDATA[
+cd ${org.apache.jetspeed.portal.home}
+maven j2:quickStart]]>
+ </source>
+ <i>
+ Note: the
+ <a href="j2-maven-plugin.html">
+ maven-plugin documentation
+ </a>
+ described other goals you can use to customize
+ the deployment to your taste.
+ </i>
+ </p>
+ </subsection>
+ <subsection name="Run">
+ <p>
+ The final step is starting up your Tomcat server and
+ the portal will automatically install any deployed
+ portlet applications.
+ </p>
+ <p>
+ Then you can access the portal with your browser at:
+ <source><a href="http://localhost:8080/jetspeed">http://localhost:8080/jetspeed</a></source>
+ or replace "jetspeed" in the above url with the name
+ of you own portal application (
+ <code>
+ ${org.apache.jetspeed.portal.artifactId}
+ </code>
+ ).
+ </p>
+ </subsection>
+ <subsection name="Default installed user accounts">
+ <p>
+ 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:
+ <table>
+ <tr>
+ <th>username</th>
+ <th>password</th>
+ <th>roles</th>
+ </tr>
+ <tr>
+ <td>
+ <code>admin</code>
+ </td>
+ <td>
+ <code>admin</code>
+ </td>
+ <td>
+ <code>admin, manager, user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>manager</code>
+ </td>
+ <td>
+ <code>manager</code>
+ </td>
+ <td>
+ <code>manager, user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>jetspeed</code>
+ </td>
+ <td>
+ <code>jetspeed</code>
+ </td>
+ <td>
+ <code>manager</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>user</code>
+ </td>
+ <td>
+ <code>user</code>
+ </td>
+ <td>
+ <code>user</code>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>tomcat</code>
+ </td>
+ <td>
+ <code>tomcat</code>
+ </td>
+ <td></td>
+ </tr>
+ </table>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-getting-started-source.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml?rev=768082&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml Thu Apr 23 22:28:35 2009
@@ -0,0 +1,411 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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 configuration properties</title>
+ <subtitle>Getting ready to build your own portal</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ <person name="Ate Douma" email="ate@apache.org" />
+ <person name="David Le Strat" email="dlestrat@apache.org" />
+ <person name="Ron Wheeler" email="rwheeler@artifact-software.com"/>
+ </authors>
+ </properties>
+ <body>
+ <section name="Maven-1 Build Configuration Parameters">
+
+ <subsection name="Required Portal Configuration Properties">
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.home</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will (re)create or update your custom portal maven project configuration
+ (with goal <code>j2:portal.conf.project</code>). This will be where you will be performing all of your future
+ custom portal development.
+ <br />
+ Example: <code>/home/myportal/</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.groupId</code>
+ </td>
+ <td>
+ The (maven) short name of your portal project group.
+ <br />
+ This value is used for the maven repository folder in which the project artifacts (like the portal war
+ file) is stored.
+ <br />
+ Example: <code>myprojects</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.artifactId</code>
+ </td>
+ <td>
+ The (maven) short name of your portal project.
+ <br />
+ This value is used for the portal war file and the (portal) web application context name.
+ <br />
+ Example: <code>myportal</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.name</code>
+ </td>
+ <td>
+ The (maven) full name of your portal project.
+ <br />
+ This value is used by maven for generating JavaDoc titles.
+ <br />
+ Example: <code>My Test Portal</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.currentVersion</code>
+ </td>
+ <td>
+ The current version of your portal project.
+ <br />
+ This value is used by maven as name postfix for the generated artifacts.
+ <br />
+ Example: <code>1.0</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Optional Portal Configuration Properties">
+ <p>
+ The following properties all specify a subfolder of the <code>${org.apache.jetspeed.portal.home}</code>
+ location as defined above.
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.conf.dir</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will generate and copy application server specific configuration files
+ as a tomcat application context descriptor.
+ <br />
+ This folder and its contents is created or updated by plugin goal <code>j2:portal.conf.tomcat</code>.
+ </td>
+ <td>
+ <i>target/portal-conf</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.sql.dir</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will generate and copy portal and database server specific sql DDL and
+ DML scripts.
+ <br />
+ This folder and its contents is always (re)created by plugin goal <code>j2:portal.conf.sql</code>.
+ </td>
+ <td>
+ <i>target/portal-sql</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.db.dir</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will create build-in HSQLDB database(s).
+ <br />
+ This folder and its contents is created or updated by plugin goal <code>j2:start.production.server</code>
+ or <code>j2:start.test.server</code>.
+ </td>
+ <td>
+ <i>target/portal-db</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.derbydatabase.path</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will create its built-in Derby database(s).
+ <br />
+ This folder and its contents is created or updated by plugin goal <code>j2:quickStart</code>.
+ </td>
+ <td>
+ <i>/tmp</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.webapp.dir</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will copy the standard jetspeed web application resources.
+ <br />
+ This folder and its contents is created or updated by plugin goal <code>j2:portal.copy.webapp</code>.
+ </td>
+ <td>
+ <i>target/${org.apache.jetspeed.portal.artifactId}</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.portal.target.dir</code>
+ </td>
+ <td>
+ The folder where the maven-plugin will generate and copy runtime portal configuration files.
+ <br />
+ These configuration files contain values derived from build/plugin properties for the portal and OJB.
+ <br />
+ This folder and its contents is created or updated by plugin goal <code>j2:portal.conf.jetspeed</code>
+ and goal <code>j2:portal.conf.ojb</code>.
+ </td>
+ <td>
+ <i>target/${org.apache.jetspeed.portal.artifactId}</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Required Application Server Properties">
+ <p>
+ <i>
+ Note: The maven-plugin currently only supports the Tomcat Server 5.0.x or 5.5.x
+ </i>
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.server.home</code>
+ </td>
+ <td>
+ The root folder of your Tomcat server installation.
+ <br />
+ Example: <code>${CATALINA_HOME}/</code>.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.server.shared</code>
+ </td>
+ <td>
+ The location of the shared jars in your Tomcat installation.
+ <br />
+ Example: <code>${org.apache.jetspeed.server.home}/shared/lib/</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.deploy.war.dir</code>
+ </td>
+ <td>
+ The location of web applications in your Tomcat installation.
+ <br />
+ Example: <code>${org.apache.jetspeed.server.home}/webapps/</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.services.autodeployment.user</code>
+ </td>
+ <td>
+ A Tomcat user with the manager role.
+ <br />
+ Used to access the Tomcat Manager application from within the portal, explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.services.autodeployment.password</code>
+ </td>
+ <td>
+ The password of the Tomcat user above.
+ <br />
+ Used to access the Tomcat Manager application from within the portal, explained below.
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.catalina.version.major</code>
+ </td>
+ <td>
+ The major version of the Tomcat server you are using: 5 or 5.5
+ <br />
+ Example: <code>5.5</code>
+ </td>
+ <td>
+ <i>no default</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Optional Database Server Properties">
+ <p>
+ Jetspeed-2 and its maven-plugin uses, as well as provides, by default a Derby database.
+ </p>
+ <p>
+ If you want to use a different database you will need to override the following properties:
+ </p>
+ <table>
+ <tr>
+ <th>Property</th>
+ <th>Description</th>
+ <th nowrap="nowrap">Default value</th>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.database.default.name</code>
+ </td>
+ <td>
+ The type of database you are using. Used for sql script generation with Torque.
+ <br />
+ Currently supported databases (with corresponding Torque target database name):
+ <ul>
+ <li>derby (derby)</li>
+ <li>hsql (hypersonic)</li>
+ <li>oracle (oracle)</li>
+ <li>mysql (mysql)</li>
+ <li>postgres (postresql)</li>
+ <li>mssql (mssql)</li>
+ <li>sapdb (sapdb)</li>
+ <li>db2 (db2)</li>
+ </ul>
+ </td>
+ <td>derby</td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.database.url</code>
+ </td>
+ <td>The jdbc connection url</td>
+ <td>jdbc:derby:${org.apache.jetspeed.derbydatabase.path}/productiondb;create=true</td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.database.user</code>
+ </td>
+ <td>The database user name to connect with.</td>
+ <td><i>empty</i></td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.database.password</code>
+ </td>
+ <td>The database user its password to connect with.</td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.database.driver</code>
+ </td>
+ <td>The jdbc driver class name</td>
+ <td>org.apache.derby.jdbc.EmbeddedDriver</td>
+ </tr>
+ <tr>
+ <td>
+ <code>org.apache.jetspeed.production.jdbc.drivers.path</code>
+ </td>
+ <td>
+ A Java classpath style path to the jdbc driver classes or jar(s) needed for connecting to the database.
+ <br />
+ Example: <code>/lib/ojdbc14.jar;/lib/nls_charset12.jar</code>
+ </td>
+ <td>
+ <i>empty</i>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="Example: A minimal custom portal configuration">
+ <p>
+ Make sure you have defined at least the required properties as described above in your
+ <code>${USER_HOME}/build.properties</code>. A minimal custom portal configuration using the default Derby
+ database can be something like:
+ <source>
+ <![CDATA[
+# required portal configuration properties
+org.apache.jetspeed.portal.home = /home/myportal/
+org.apache.jetspeed.portal.groupId = myprojects
+org.apache.jetspeed.portal.artifactId = myportal
+org.apache.jetspeed.portal.name = My Test Portal
+org.apache.jetspeed.portal.currentVersion = 1.0
+
+# required application server properties
+org.apache.jetspeed.server.home = ${CATALINA_HOME}/
+org.apache.jetspeed.server.shared = ${org.apache.jetspeed.server.home}/shared/lib/
+org.apache.jetspeed.deploy.war.dir = ${org.apache.jetspeed.server.home}/webapps/
+org.apache.jetspeed.services.autodeployment.user = j2deployer
+org.apache.jetspeed.services.autodeployment.password = xxxxx
+org.apache.jetspeed.catalina.version.major = 5.5]]>
+ </source>
+ </p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/m1-guide-properties.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml?rev=768082&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml Thu Apr 23 22:28:35 2009
@@ -0,0 +1,248 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
+ Building Jetspeed 2.1.x from Source with Maven-2
+ </title>
+ <subtitle>How-to for Building from Source with Maven-2 and Jetspeed 2.1.x</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="Building Jetspeed 2.1.x from Source with Maven-2">
+ <subsection name="Overview">
+ <p>
+ The Maven2 build support is currently under development and is co-resident with the existing Maven1 build scripts and sources.
+ The general strategy is to make heavy use of Ant from within the Maven2 build or as Ant Tasks/Ant Maven2 Plugins if required.
+ For this reason, the Maven2 build can be found in the pom.xml and build.xml files throughout the Jetspeed2 source tree.
+ As with the Maven1 build, it is a multi-module build, primarily following the J2 component and application subprojects.
+ There are also two Maven2 build specific top level subprojects: ant-tasks and maven-archetypes.
+ </p>
+ <p>
+ The development team is actively keeping both environments up to date,
+ but the Maven2 build modifications may lag behind newly committed changes.
+ At the moment, Maven2 does not build all LDAP related artifacts and it does not build the uberjar/classworlds executable jar files
+ for the deploy tool. Otherwise it is generally complete, (at least AFAIK).
+ </p>
+ <p>
+ Maven 2.0.4 and the accompanying Ant artifact tasks are now being used for this effort,
+ with an upgraded surefire plugin version, (2.1.3). If you wish to use the Maven2 build,
+ please ensure that maven 2.0.4 is installed and in your path.
+ Due to modifications in the pom.xml files, earlier versions of maven will not work correctly.
+ </p>
+ </subsection>
+ <subsection name="Future Directions: 2.2">
+ <p>This Maven2 build will be deprecated in 2.2, and replaced with a new Maven2 build.
+ The Maven1 build will be completely dropped in 2.2
+ </p>
+ </subsection>
+ <subsection name="The first step in using Maven2">
+ <p>The first step in using the Maven2 build is to either:
+ <ul>
+ <li>copy the settings.xml.sample to ~/.m2/settings.xml</li>
+ <li>--or--</li>
+ <li>encorporate the settings in this file into your existing Maven2 configuration.</li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="Properties Customization">
+ <p>
+ Once in place, please customize the properties as one would have done for Maven1 using build.properties.
+ The properties are preconfigured for embedded Derby, so more changes are required if another database solution is to be used.
+ To complete this step, ensure that the proper jetspeed database active profile is uncommented for your database in
+ the <activeProfiles> element <b>jetspeed-db-drivers-path</b> should be selected for all non-embedded databases.
+ This setting is needed to execute Jetspeed component tests.
+ </p>
+ </subsection>
+ <subsection name="Repository Relocation">
+ <p>
+While the default location of the settings.xml file should not be changed, (e.g. ~/.m2/settings.xml),
+one can relocate the repository using the <localRepository> element in the settings.xml file.
+See the settings.xml.sample file for an example.
+Note that the repository path must be an absolute path and not contain any property expressions.
+ </p>
+ </subsection>
+ <subsection name="Overview of current Jetspeed2 Maven2 commands">
+ <p>
+ Here is a quick summary of the current Jetspeed2 Maven2 build commands,
+ (most of these commands can be executed at the root of the J2 source tree or at lower levels to perform partial builds/deployments):
+ </p>
+<table>
+<tbody><tr>
+<td>
+<p> <strong><tt>commands</tt></strong> </p>
+</td>
+<td>
+
+<p> <strong><tt>explanation</tt></strong> </p>
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn</tt></strong> </p>
+</td>
+<td>
+<p> performs base build and installs J2 artifacts in the Maven2 repository, (install is the default Maven2 goal for this build)</p>
+
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn -P test</tt></strong> </p>
+</td>
+<td>
+<p> performs base build and includes execution of test cases, (includes test database setup) </p>
+</td>
+</tr>
+
+<tr>
+<td>
+<p> <strong><tt>mvn -P tomcat</tt></strong> </p>
+</td>
+<td>
+<p> performs base build and deploys to Tomcat app server, (includes prodution database setup). Other app servers will be supported in the future, (see below for details)</p>
+</td>
+</tr>
+<tr>
+<td>
+
+<p> <strong><tt>mvn clean</tt></strong> </p>
+</td>
+<td>
+<p> cleans all build target directories </p>
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>other commands</tt></strong> </p>
+
+</td>
+<td>
+<p> explanation </p>
+</td>
+</tr>
+</tbody></table>
+<p><i>Please note that the Maven2 repositories used by default with this build are generally saturated and the Jetspeed2 Maven2
+repository does not yet contain a full mirror of the artifacts required to build Jetspeed2. If you experience download or connection failures,
+ simply restart the build by issuing your last command again to retry.
+ </i></p>
+ </subsection>
+ <subsection name='Additional Notes'>
+ <ul>
+ <li><b>mvn -P test</b> and <b>mvn -Dmaven.test.skip=false</b> are equivalent.</li>
+ <li><b>mvn -P test -Dtest=MyTest</b> will execute a single test or matching tests if Ant wildcards are used. </li>
+ <li>Due to forking bugs in the Surefire Maven2 test runner plugin, test output, (e.g. System.out.println()), is not echoed to the build shell. If you wish to see console output for component tests, temporarily comment out the <forkMode>
+ elements in the components/pom.xml and the components pom.xml and run single tests. Note: the forking is required to run multiple tests.
+ </li>
+ <li><p> The <strong><tt>-o</tt></strong> offline option can be specified with the commands documented here to force Maven2 to use only the local repository. This can be invaluable in the event the main Maven2 repositories are down and the build insists upon validating a missing or troublesome POM. </p>
+ </li>
+ </ul>
+ <p>
+ </p>
+ </subsection>
+ </section>
+ <section name='Maven Profiles'>
+<p>the following profiles are optional and can be supplied when building/deploying to Tomcat </p>
+<div>
+<table>
+
+<tbody><tr>
+<td>
+<p> <strong><tt>mvn -P tomcat,min</tt></strong> </p>
+</td>
+<td>
+<p> specified that only the administrative portlets be deployed along with a minimal set of PSML pages.</p>
+</td>
+</tr>
+<tr>
+<td>
+
+<p> <strong><tt>mvn -P tomcat,full</tt></strong> </p>
+</td>
+<td>
+<p> at the moment, this is the same as the default build: deploys a full J2 set of portlets and PSML pages.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn -P tomcat,nodb</tt></strong> </p>
+
+</td>
+<td>
+<p> specifies that configuration of the production database should be skipped.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn -P tomcat,hot</tt></strong> </p>
+</td>
+<td>
+
+<p> indicates that a portlet app, component, or content should be directly written to the deployed Jetspeed2 webapp.</p>
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn -P tomcat,dbpsml</tt></strong> </p>
+</td>
+<td>
+<p> specifies portal build and database deployment/import to include configuration of database PSML.</p>
+
+</td>
+</tr>
+<tr>
+<td>
+<p> <strong><tt>mvn -P prod</tt></strong> </p>
+</td>
+<td>
+<p> executes deployment to application server specified in settings.xml, (see below).</p>
+</td>
+</tr>
+
+</tbody></table>
+</div>
+<p>Currently, only Tomcat 5 and Tomcat 5.5 application servers are supported by this build. More platforms are to be supported in the near future. To do so, additional deployment profiles and new app-servers Ant deployment build files will need to be added. See the following files for details: </p>
+<ul>
+<li><p> <tt>pom.xml</tt>, </p>
+</li>
+<li><p> <tt>app-servers/tomcat-build.xml</tt>, </p>
+</li>
+<li><p> <tt>maven-archetypes/portal/src/archetype/archetype-resources/pom.xml</tt>, and </p>
+
+</li>
+<li><p> <tt>maven-archetypes/portal/src/archetype/archetype-resources/app-servers/tomcat-build.xml</tt>. </p>
+</li>
+</ul>
+ <subsection name='Use case for some additional profiles:'>
+<p>Some of the additional profiles make sense to preconfigure in your settings.xml, (see the settings.xml.sample file for syntax) </p>
+<ul>
+<li><p> <tt>org.apache.jetspeed.env.deploy.target</tt>, application server to deploy to. Setting this property allows one to use the generic <strong><tt>prod</tt></strong> profile. </p>
+
+</li>
+<li><p> <tt>org.apache.jetspeed.env.deploy.type</tt>, set to <tt>full</tt> or <tt>min</tt>. Takes the place of the <strong><tt>full</tt></strong> and <strong><tt>min</tt></strong> profiles. </p>
+</li>
+
+<li><p> <tt>org.apache.jetspeed.env.deploy.db.psml</tt>, set to <tt>true</tt> or <tt>false</tt>. Equivalent to using <strong><tt>dbpsml</tt></strong> if enabled. </p>
+</li>
+</ul>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-build.xml
------------------------------------------------------------------------------
svn:keywords = Id
Added: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml?rev=768082&view=auto
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml (added)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml Thu Apr 23 22:28:35 2009
@@ -0,0 +1,257 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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>
+ Building a Custom Jetspeed 2.1.x Project with Maven-2
+ </title>
+ <subtitle>How-to for Building a Custom Portal with Maven-2 and Jetspeed 2.1.x</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylor@apache.org" />
+ </authors>
+ </properties>
+ <body>
+ <section name="How-to for Building a Custom Portal with Maven-2 and Jetspeed 2.1.x">
+ <subsection name="Custom Portal Generation">
+ <p>
+The Maven1 j2:portal.genapp goal has been supported in the Maven2 build as an archetype.
+ However, until a Jetspeed2 Maven2 repository is completely populated, a normal Maven2 build must be completed to make Jetspeed2 archetypes
+ available in your local repository. One can tweak the following command as needed to create a Jetspeed2 instance using this archetype:
+ </p>
+ <p><b>
+ mvn archetype:create -DarchetypeGroupId=org.apache.portals.jetspeed-2 -DarchetypeArtifactId=portal-archetype -DarchetypeVersion=2.1.3 -DgroupId=myportalgroup -DartifactId=myportal -Dversion=1.0
+ </b>
+ </p>
+ </subsection>
+ <subsection name="Custom Portal Directory Structure Conventions">
+ <p>
+Note that this and other archetypes can issue many harmless warnings while expanding.
+Please ignore the warnings unless the expansion of the archetype template fails. When complete, the portal archetype expansion will contain the following structure
+ within a directory named as the specified artifactId relative to the current working directory:
+ </p>
+<ul>
+<li><p><tt><artifactId>/applications</tt> - conventional subdirectory for portal application war modules. </p>
+</li>
+<li><p> <tt><artifactId>/app-servers</tt> - contains portal deployment builds and resources. </p>
+</li>
+<li><p> <tt><artifactId>/components</tt> - conventional subdirectory for portal component jar modules. </p>
+</li>
+<li><p> <tt><artifactId>/etc/assembly</tt> - custom portal application component Spring assemblies. </p>
+
+</li>
+<li><p> <tt><artifactId>/etc/conf</tt> - portal application context configuration files. </p>
+</li>
+<li><p> <tt><artifactId>/etc/decorations</tt> - custom decorations in images, layout, and portlet subdirectories. </p>
+</li>
+<li><p> <tt><artifactId>/etc/pages</tt> - custom portal PSML pages to augment/override minimal defaults, (e.g. /Administrative/**, /default-page.psml, /myaccount.psml, /page.security, and /system/**). </p>
+
+</li>
+<li><p> <tt><artifactId>/etc/schema</tt> - Jetspeed2 database schema definitions. </p>
+</li>
+<li><p> <tt><artifactId>/etc/sql</tt> - Jetspeed2 base database configuration scripts. </p>
+</li>
+<li><p> <tt><artifactId>/etc/templates</tt> - custom overrides for Jetspeed2 layout portlet templates. </p>
+
+</li>
+<li><p> <tt><artifactId>/etc/webapp</tt> - custom content reaources to be packaged with portal application. </p>
+</li>
+<li><p> <tt><artifactId>/portal</tt> - portal application war build scripts and webapp resource overrides. </p>
+</li>
+<li><p> <tt><artifactId>/src</tt> - these directories are an artifact of archetype expansion and should be deleted. </p>
+
+</li>
+</ul>
+ </subsection>
+ <subsection name='Configuration'>
+<p>The archetype also contains a settings.xml.sample that is a subset of the Jetspeed2 source build parameters.
+If one has not previously configured the ~/.m2/settings.xml file as described above, this sample can be used to do so without J2 test configurations. </p>
+<p>When the Maven2 enviroment is properly configured, the J2 Maven2 commands outlined above can now be used to build and deploy a customized portal.
+ Most of the command options are supported with the exception of these profiles: </p>
+<ul>
+<li><p> <strong><tt>min</tt></strong> and <strong><tt>full</tt></strong> are not supported because the archetype supports only the minimal deployment. </p>
+</li>
+<li><p> <strong><tt>test</tt></strong> features to populate the J2 test database have also been provisionally stripped from the archetype. </p>
+</li>
+<li><p> <strong><tt>dbpsml</tt></strong> is not yet supported in the custom portal build to import to the production database PSML. </p>
+</li>
+</ul>
+<p>Currently, only Maven2 builds are supported. Longer range goals include support for Ant custom portal builds and prepackaged Maven2 repository downloads. </p>
+<p>Two additional Maven2 archetypes are also available to generate custom portal applications and components on top of the generated portal template. Before these archetypes are used, the host portal archetype should have been previously built to install all parent POMs, (it is not necessary to deploy the portal before using these archetypes). These archetypes should be created from the applications and components subdirectories to work correctly. </p>
+ </subsection>
+ <subsection name='Archetype Commands'>
+<p>A portal portlets application to be deployed by Jetspeed2: </p>
+<p><strong><tt>mvn archetype:create -DarchetypeGroupId=org.apache.portals.jetspeed-2 -DarchetypeArtifactId=application-archetype -DarchetypeVersion=2.1.3 -DgroupId=myportalgroup -DartifactId=myportal-application -Dversion=1.0</tt></strong> </p>
+<p>A simple component to be used by other component and application modules: </p>
+<p><strong><tt>mvn archetype:create -DarchetypeGroupId=org.apache.portals.jetspeed-2 -DarchetypeArtifactId=component-archetype -DarchetypeVersion=2.1.3 -DgroupId=myportalgroup -DartifactId=myportal-component -Dversion=1.0</tt></strong> </p>
+
+<p>A shared component to be deployed as a shared JAR in the application server: </p>
+<p><strong><tt>mvn archetype:create -DarchetypeGroupId=org.apache.portals.jetspeed-2 -DarchetypeArtifactId=shared-component-archetype -DarchetypeVersion=2.1.3 -DgroupId=myportalgroup -DartifactId=myportal-shared-component -Dversion=1.0</tt></strong> </p>
+<p>A component to be deployed within the portal, (Jetspeed2), web application: </p>
+<p><strong><tt>mvn archetype:create -DarchetypeGroupId=org.apache.portals.jetspeed-2 -DarchetypeArtifactId=portal-component-archetype -DarchetypeVersion=2.1.3 -DgroupId=myportalgroup -DartifactId=myportal-portal-component -Dversion=1.0</tt></strong> </p>
+
+<p><em>Note that the groupId and version settings should match the values used when generating the host portal template.</em> </p>
+</subsection>
+<subsection name='Maven POM Configuration'>
+<p>There are a few manual steps that must be followed to use these created applications and components. </p>
+<ul>
+<li><p>The new application/component must be added as <module> elements in the parent POM. An application would be added like this by subdirectory name, (artifactId):
+</p>
+<pre><modules>
+ ...
+ <module>myportal-application</module>
+
+ ...
+</modules>
+</pre>
+<p>The same syntax is used for components.</p>
+</li>
+<li class="gap"><p>A dependency declaration should be added in the root POM. Components packaged as jars should be added like this:
+</p>
+<pre><dependencyManagement>
+ <dependencies>
+ ...
+ <dependency>
+
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>myportal-component</artifactId>
+ <version>${pom.version}</version>
+ </dependency>
+
+ ...
+ </dependencies>
+</dependencyManagement>
+</pre>
+<p>Applications are declared similarly, except for the addition of a required <type> element:
+</p>
+<pre><dependencyManagement>
+ <dependencies>
+
+ ...
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>myportal-application</artifactId>
+ <type>war</type>
+
+ <version>${pom.version}</version>
+ </dependency>
+ ...
+ </dependencies>
+</dependencyManagement>
+</pre>
+</li>
+<li class="gap"><p>These dependencies can now be used to include the applications and components into the build process. Components are added as included dependencies to other applications and components in individual POMs associated with the modules that reference the component:
+
+</p>
+<pre><dependencies>
+ ...
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>myportal-component</artifactId>
+
+ </dependency>
+ ...
+</dependencies>
+</pre>
+<p>Shared components that are intended to be deployed as a shared JAR should be declared as a provided dependency in the applications POM or individual application and component POMs, (note the additional provided <scope> element):
+</p>
+<pre><dependencies>
+ ...
+ <dependency>
+
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>myportal-shared-component</artifactId>
+ <scope>provided</scope>
+ </dependency>
+
+ ...
+</dependencies>
+</pre>
+<p>Shared and portal components must also be made available for deployment and should be integrated in the app-servers module POM as a normal dependency:
+</p>
+<pre><dependencies>
+ ...
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+
+ <artifactId>myportal-shared-component</artifactId>
+ </dependency>
+ ...
+</dependencies>
+</pre>
+<p>Applications are normally referenced only for deployment. To ensure they are available during deployment builds, they must be integrated in the app-servers module POM like this:
+</p>
+<pre><dependencies>
+
+ ...
+ <dependency>
+ <groupId>${pom.groupId}</groupId>
+ <artifactId>myportal-application</artifactId>
+ <type>war</type>
+
+ </dependency>
+ ...
+</dependencies>
+</pre>
+</li>
+<li class="gap"><p>Finally, the new applications and components must be added to the app-servers deployment Ant buildfiles. Applications should be added to the 'hot' application/WAR deployment hooks in the application server specific build files, (e.g. tomcat-build.xml):
+</p>
+<pre><target name="hot-deploy-apps">
+ ...
+ <antcall target="hot-deploy-war">
+
+ <param name="org.apache.jetspeed.deploy.groupid" value="${portal.groupid}"/>
+ <param name="org.apache.jetspeed.deploy.artifactid" value="myportal-application"/>
+ <param name="org.apache.jetspeed.deploy.version" value="${portal.version}"/>
+ </antcall>
+ ...
+</target>
+</pre>
+
+<p>Shared components that are to be installed in the application server should be added to the shared deployment hook in the same buildfile:
+</p>
+<pre><target name="hot-deploy-shared-components">
+ ...
+ <antcall target="hot-deploy-shared-jar">
+ <param name="org.apache.jetspeed.deploy.groupid" value="${portal.groupid}"/>
+ <param name="org.apache.jetspeed.deploy.artifactid" value="myportal-shared-component"/>
+ <param name="org.apache.jetspeed.deploy.version" value="${portal.version}"/>
+
+ </antcall>
+ ...
+</target>
+</pre>
+<p>And finally, portal components that are to be inserted into the portal application itself should be added to the 'hot' component/JAR hooks like this:
+</p>
+<pre><target name="hot-deploy-components">
+ ...
+ <antcall target="hot-deploy-jar">
+ <param name="org.apache.jetspeed.deploy.groupid" value="${portal.groupid}"/>
+
+ <param name="org.apache.jetspeed.deploy.artifactid" value="myportal-portal-component"/>
+ <param name="org.apache.jetspeed.deploy.version" value="${portal.version}"/>
+ </antcall>
+ ...
+</target>
+</pre>
+</li>
+</ul>
+<p>Please refer to the Maven2 site documentation for more detail or background information: <a href='http://maven.apache.org/guides/index.html'>Maven-2 Docs</a></p>
+ </subsection>
+ </section>
+ </body>
+</document>
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/maven-2-custom.xml
------------------------------------------------------------------------------
svn:keywords = Id
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/navigation.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/navigation.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/navigation.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/navigation.xml Thu Apr 23 22:28:35 2009
@@ -18,13 +18,11 @@
<project>
<body>
<links>
- <links>
<item name="Main Docs" href="index.html" />
- <item name="Admin Guide" href="adminguide/index.html" />
+ <item name="Users Guide" href="usersguide/index.html" />
+ <item name="Admin Guide" href="adminguide/index.html" />
<item name="Deployment Guide" href="deployguide/index.html" />
- <item name="Users Guide" href="usersguide/index.html" />
- <item name="PDF Documentation" href="/jetspeed2.pdf" img="images/pdf.gif" />
- </links>
+ <!--<item name="PDF Documentation" href="/jetspeed2.pdf" img="images/pdf.gif" />-->
</links>
<menu name="Getting Involved">
@@ -32,20 +30,20 @@
</menu>
<menu name="Building with Maven-2">
- <item name="Custom Build" href="devguide/m2-build/maven-2-custom.html" />
- <item name="Building from Source" href="devguide/m2-build/maven-2-build.html" />
- <item name="Maven-2 Plugin" href="devguide/m2-build/j2-maven-plugin.html" />
+ <item name="Custom Build" href="devguide/maven-2-custom.html" />
+ <item name="Building from Source" href="devguide/maven-2-build.html" />
+ <item name="Maven-2 Plugin" href="devguide/j2-maven-plugin.html" />
</menu>
<menu name="Building with Maven-1 (deprecated)">
- <item name="Custom Build" href="devguide/m1-build/getting-started-binary.html" />
- <item name="Building from Source" href="devguide/m1-build/getting-started-source.html" />
- <item name="Configuration Properties" href="devguide/m1-build/guide-properties.html" />
+ <item name="Custom Build" href="devguide/m1-getting-started-binary.html" />
+ <item name="Building from Source" href="devguide/m1-getting-started-source.html" />
+ <item name="Configuration Properties" href="devguide/m1-guide-properties.html" />
</menu>
<menu name="Security Architecture">
- <item name="Security Concepts" href="devguide/dev-security.xml" />
- <item name="Overview" href="devguide/guide-security.xml" />
- <item name="Architecture Overview" href="devguidea/arch.html" />
+ <item name="Security Concepts" href="devguide/dev-security.html" />
+ <item name="Overview" href="devguide/guide-security.html" />
+ <item name="Architecture Overview" href="devguide/arch.html" />
<item name="Authentication" href="devguide/atn.html">
<item name="Login Module" href="devguide/login-module.html" />
<item name="Authentication SPI" href="devguide/atn-spi.html" />
@@ -65,27 +63,27 @@
<menu name="Jetspeed Components">
<item name="Components" href="devguide/dev-cm.html" />
- <item name="Capabilities" href="devguide/dev-capaabilities.html" />
+ <item name="Capabilities" href="devguide/dev-capabilities.html" />
<item name="Deployment" href="devguide/dev-deploy.html" />
<item name="Search" href="devguide/dev-search.html" />
<item name="Statistics" href="devguide/dev-statistics.html" />
<item name="Localization" href="devguide/guide-l10n.html" />
- <item name="Pipeline" href="devguide/pipeline.html" />
+ <item name="Pipeline" href="devguide/guide-pipeline.html" />
<item name="Preferences" href="devguide/dev-prefs.html"/>
<item name="Profiler" href="devguide/guide-profiler.html" />
- <item name="Profiler IP" href="devguide/guide-profiler-ip.html" />
+ <item name="Profiler IP" href="devguide/guide-profiling-ip.html" />
<item name="PSML" href="devguide/guide-psml.html" />
<item name="PSML DTD" href="devguide/guide-psml-dtd.html" />
</menu>
<menu name="Database">
- <item name="Database Guide" href="devguide/dev-database.html" />
+ <item name="Database Guide" href="devguide/guide-database.html" />
<item name="Data Access" href="devguide/dao.html" />
<item name="RDBMS" href="devguide/dev-rdbms.html" />
</menu>
<menu name="APIs">
- <item name="Jetspeed Java API" href="jetspeed-api/apidocs/index.html" />
+ <item name="Jetspeed Java API" href="multiproject/jetspeed-api/apidocs/index.html" />
<item name="Jetspeed AJAX API" href="devguide/guide-ajax-api.html" />
</menu>
@@ -94,7 +92,7 @@
<item name="Portlet Bridges" href="devguide/guide-portlet-bridges.html" />
<item name="Simple Portlet" href="devguide/guide-simple-portlet.html" />
<item name="JSF" href="devguide/guide-simple-jsf-portlet.html" />
- <item name="Velocity" href="devguide/guide-simple-jsf-velocity.html" />
+ <item name="Velocity" href="devguide/guide-simple-velocity-portlet.html" />
</menu>
<menu name="Portal Design">
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/patches.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/patches.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/patches.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/devguide/patches.xml Thu Apr 23 22:28:35 2009
@@ -28,7 +28,7 @@
<subsection name="Working with Jetspeed-2 Source Code">
<p>
For information on how to get started with Jetspeed-2 source code, check
- <a href="../getting-started-source.html">getting started with Jetspeed-2 source code</a>.
+ <a href="maven-2-build.html">Building Jetspeed 2.1.x from Source with Maven-2</a>.
</p>
</subsection>
<subsection name="How to Submit Patches?">
@@ -36,7 +36,7 @@
When working with Eclipse with the <a href="http://subclipse.tigris.org/">Subclipse plugin</a>,
it is possible to generate a patch for the code changed as illustrated below:
<br/><br/>
- <img src="devguide/images/create-patch.gif" border="0" />
+ <img src="images/create-patch.gif" border="0" />
</p>
</subsection>
</section>
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/download.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/download.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/download.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/download.xml Thu Apr 23 22:28:35 2009
@@ -125,7 +125,7 @@
</subsection>
<subsection name="Migrating Guide">
<p>
- Important information for migrating existing Jetspeed-2.0 and Jetspeed-2.1 installations to Jetspeed-2.1.3 is provided in the <a href="guides/guide-migration.html">migration guide</a>.
+ Important information for migrating existing Jetspeed-2.0 and Jetspeed-2.1 installations to Jetspeed-2.1.3 is provided in the <a href="guide-migration.html">migration guide</a>.
</p>
</subsection>
</section>
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/faq.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/faq.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/faq.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/faq.xml Thu Apr 23 22:28:35 2009
@@ -44,10 +44,10 @@
<p>From here you can create a new user. Choose a unique username with no spaces. Then enter a secure password.
You can require the password to be changed on the first login. You can also select the default role assigned to this user,
as well as a default profiling rule. Last, you can assign this user to a subsite</p>
- <img src="images/add-user.png"/>
+ <img src="adminguide/images/add-user.png"/>
<p>Going into edit mode, you an further configure the User Details portlet. Note that the following fields can be defaulted:
</p>
- <img src="images/add-user-editmode.png"/>
+ <img src="adminguide/images/add-user-editmode.png"/>
<ul><li>Default Role for New User</li>
<li>Required Role for New User (not shown on view mode)</li>
<li>Default Profile for new user</li>
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/getting-started.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/getting-started.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/getting-started.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/getting-started.xml Thu Apr 23 22:28:35 2009
@@ -35,7 +35,7 @@
</li>
<li>
<a href="adminguide/index.html">
- Administration Guide
+ Administrators Guide
</a>
</li>
<li>
@@ -48,11 +48,6 @@
Developers Guide
</a>
</li>
- <li>
- <a href="deploy/index.html">
- Deployers Guide
- </a>
- </li>
</ul>
<p>
For those of you in more of a hurry to get started,
@@ -115,11 +110,11 @@
<p>The Maven-2 Custom Build is based on a Maven-2 plugin. To get started with the Maven-2 plugin, see the tutorial and usage guide here:
<ul>
<li><a href="tutorials/maven-2/index.html">Maven-2 Custom Build Tutorial</a></li>
-<li><a href="devguide/m2-build/maven-2-custom.html">Maven-2 Custom Build Guide</a></li>
+<li><a href="devguide/maven-2-custom.html">Maven-2 Custom Build Guide</a></li>
</ul>
</p>
<p>
-<i>There is also a deprecated Maven-1 plugin. If you really insist on using Maven-1 custom builds, see the docs here: <a href="devguide/m1-build/getting-started-binary.html">Maven-1 Custom Build Guide</a>.</i>
+<i>There is also a deprecated Maven-1 plugin. If you really insist on using Maven-1 custom builds, see the docs here: <a href="devguide/m1-getting-started-binary.html">Maven-1 Custom Build Guide</a>.</i>
</p>
</subsection>
<subsection name="Requirements for Custom Builds">
@@ -135,7 +130,7 @@
<ul>
<li><a href="deployguide/guide-tomcat.html">Tomcat 5.5.x</a></li>
<li>Jetty</li>
- <li><a href="adminguide/websphere/index.html">Websphere 6.0</a></li>
+ <li><a href="deployguide/deploying-jetspeed-to-websphere.html">Websphere 6.0</a></li>
<li>Geronimo</li>
<li>JBoss</li>
<li>Weblogic</li>
@@ -182,12 +177,12 @@
<subsection name="Building from Source with Maven-1">
<ul>
<li>
- <a href="devguide/m1-build/getting-started-source.html">
+ <a href="devguide/m1-getting-started-source.html">
Building with Maven-1 from Source
</a>
</li>
<li>
- <a href="devguide/m1-build/getting-started-binary.html">
+ <a href="devguide/m1-getting-started-binary.html">
Maven-1 Plugin Guide
</a>
</li>
@@ -199,12 +194,12 @@
<p>For general build information, also see:</p>
<ul>
<li>
- <a href="devguide/m2-build/maven-2-build.html">
+ <a href="devguide/maven-2-build.html">
Building with Maven-2 from Source
</a>
</li>
<li>
- <a href="devguide/m2-build/j2-maven-plugin.html">
+ <a href="devguide/j2-maven-plugin.html">
Maven-2 Plugin Guide
</a>
</li>
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/how-to-help.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/how-to-help.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/how-to-help.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/how-to-help.xml Thu Apr 23 22:28:35 2009
@@ -36,7 +36,7 @@
Prior to reporting a bug, make sure to discuss the issue on the <a href="mail-lists.html">user mailing list</a> or even the
<a href="mail-lists.html">developer mailing list</a>.</li>
<li>When you encounter an issue, you may be compelled to fix it. We encourage this as this makes for a vibrant
- community. Once you have a fix, <a href="guides/guide-j2-development.html">submit a patch</a> on the reporting issue.</li>
+ community. Once you have a fix, <a href="devguide/patches.html">submit a patch</a> on the reporting issue.</li>
</ul>
</p>
</subsection>
Modified: portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml
URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml?rev=768082&r1=768081&r2=768082&view=diff
==============================================================================
--- portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml (original)
+++ portals/jetspeed-2/portal/branches/JETSPEED-2.1.3-POSTRELEASE/xdocs/index.xml Thu Apr 23 22:28:35 2009
@@ -84,7 +84,7 @@
<p>
The Jetspeed enterprise portal integrates dynamic information, people, and processes across organization boundaries. This content is aggregated using portlets from diverse sources.
-Portlets are just mini-web applications, or web-components. Jetspeed always provides secured access to the portlets. A short overview of Jetspeed <a href="feature.html">features</a>:
+Portlets are just mini-web applications, or web-components. Jetspeed always provides secured access to the portlets. A short overview of Jetspeed <a href="features.html">features</a>:
<ul>
<li>Secure Access - Security based on standards, ACLs</li>
<li>Single Point of Entry (SSO, Federated) </li>
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org