paulsp 2004/07/10 04:21:07
Added: xdocs database.xml getting-started.xml index.xml
js2-goals.xml navigation.xml tasks.xml
Log:
o New file coppied from site/xdocs
Revision Changes Path
1.1 jakarta-jetspeed-2/xdocs/database.xml
Index: database.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Jetspeed 2 Home Page</title>
<subtitle>Welcome to Jetspeed 2</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Default Database">
<p>
The default database distributed with Jetspeed-2 is the Hypersonic SQL Java Database
(HSQL).
HSQL runs in process with Jetspeed-2. It is not a production-ready database, however
it allows you
to get up and running quickly. To move on to a more robust database, follow the
instructions in the
next section.
</p>
</section>
<section name="MySQL">
<p>
To run with My SQL, add the following properties to your $HOME/build.properties:
</p>
<source test=""><![CDATA[
# -------------------------------------------------------------------------
# configure MySQL Test DB
# -------------------------------------------------------------------------
org.apache.jetspeed.test.database.default.name=mysql
org.apache.jetspeed.test.database.url = jdbc:mysql://j2-server/j2test
org.apache.jetspeed.test.database.driver = com.mysql.jdbc.Driver
org.apache.jetspeed.test.database.user = jetspeed2
org.apache.jetspeed.test.database.password = whatever
# -------------------------------------------------------------------------
# configure MySQL Production DB
# -------------------------------------------------------------------------
org.apache.jetspeed.production.database.default.name=mysql
org.apache.jetspeed.production.database.url = jdbc:mysql://j2-server/j2
org.apache.jetspeed.production.database.driver = com.mysql.jdbc.Driver
org.apache.jetspeed.production.database.user = jetspeed2
org.apache.jetspeed.production.database.password = whatever
# -------------------------------------------------------------------------
]]></source>
<p>
In the example above, you will need to have a MySQL server running on a host named
'j2-server'.
Also, you will need 2 databases, one called 'j2test' for running the unit tests,
and a second called 'j2' for the production database.
A user named 'jetspeed2' should be granted access to both the 'j2' and 'j2test'
databases.
</p>
<subsection name ='Known Issues'>
<p>
None
</p>
</subsection>
</section>
<section name="Oracle">
<p>
To run with Oracle, add the following properties to your $HOME/build.properties:
</p>
<source test=""><![CDATA[
# -------------------------------------------------------------------------
# configure Oracle Test DB
# -------------------------------------------------------------------------
# org.apache.jetspeed.test.database.default.name=oracle
# org.apache.jetspeed.test.database.ojb.platform=oracle9i
# org.apache.jetspeed.test.database.url = jdbc:oracle:thin:@j2-sever:1521:j2db
# org.apache.jetspeed.test.database.driver = oracle.jdbc.driver.OracleDriver
# org.apache.jetspeed.test.database.user = j2test
# org.apache.jetspeed.test.database.password = whatever
# -------------------------------------------------------------------------
# configure Oracle Production DB
# -------------------------------------------------------------------------
# org.apache.jetspeed.production.database.default.name=oracle
# org.apache.jetspeed.production.database.ojb.platform=oracle9i
# org.apache.jetspeed.production.database.url = jdbc:oracle:thin:@j2-server:1521:j2db
# org.apache.jetspeed.production.database.driver = oracle.jdbc.driver.OracleDriver
# org.apache.jetspeed.production.database.user = j2
# org.apache.jetspeed.production.database.password = whatever
# -------------------------------------------------------------------------
]]></source>
<p>
In the example above, you will need to have a Oracle server running on a host named
'j2-server'
and have an Oracle database SID named 'j2db' installed on that server.
Also, you will need 2 database users (schemas), one called 'j2test' for running the
unit tests,
and a second called 'j2' for the production database.
</p>
<subsection name ='Known Issues'>
<p>
Only for the first time you create the database for Oracle, there is an issue with
the drop statements.
To get around this problem, set your properties as above in your
$HOME/build.properties, and then
run these commands:
</p>
<source test=""><![CDATA[
maven db.scripts.gen
maven dropdrops
maven db.create.test
maven db.create.production
]]></source>
</subsection>
</section>
<section name="Drivers">
<p>
JDBC drivers are configured to work with the Maven build by adding your specified
JDBC driver jars to the
Maven class path. Specify the jars with the
<b>org.apache.jetspeed.test.jdbc.drivers.path</b> and
<b>org.apache.jetspeed.production.jdbc.drivers.path</b> properties in your
$HOME/build.properties.
</p>
<p>
NOTE: The Hypersonic JDBC driver is distributed with Jetspeed and require no
configuration.
</p>
<source test=""><![CDATA[
# My SQL Driver Path Example, test and production
org.apache.jetspeed.test.jdbc.drivers.path=/Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
org.apache.jetspeed.production.jdbc.drivers.path=/Portal/lib/MySQL/mysql-connector-java-3.0.8-stable-bin.jar
# Oracle 9i Driver Path Example, test and production
org.apache.jetspeed.test.jdbc.drivers.path=/Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
org.apache.jetspeed.production.jdbc.drivers.path=/Portal/lib/oracle/ojdbc14.jar;/Portal/lib/oracle/nls_charset12.jar
# Oracle 8i Driver Path Example, test and production
org.apache.jetspeed.test.jdbc.drivers.path=/Portal/lib/oracle/classes12.jar;
org.apache.jetspeed.production.jdbc.drivers.path=/Portal/lib/oracle/classes12.jar;
]]></source>
<subsection name ='Distributing Drivers'>
<p>
When Jetspeed is deployed to an application server using the maven deploy target,
only the Hypersonic JDBC driver is copied into the web application.
To distribute a specific driver (i.e. Oracle, MySQL), you will need to copy the
driver into the application server's common class path for shared code.
</p>
<table>
<tr>
<th>Application Server</th>
<th>Procedure</th>
</tr>
<tr>
<td>
Tomcat 4
</td>
<td>
copy driver(s) to ${TOMCAT_HOME}/shared/lib
</td>
</tr>
<tr>
<td>
Tomcat 5
</td>
<td>
copy driver(s) to ${TOMCAT_HOME}/shared/lib
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Getting Started with Jetspeed 2</title>
<subtitle>Getting up and running quickly</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
<person name="Ate Douma" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Requirements">
<p>
It is expected that the user is familiar with both the <a
href="http://maven.apache.org";>Apache Maven</a>
project tool and the <a href="http://ant.apache.org";>Apache Ant</a> build tool.
</p>
<ul>
<li><a href="http://ant.apache.org/bindownload.cgi";>Ant 1.5</a> or higher</li>
<li><a href="http://maven.apache.org/start/download.html";>Maven 1.0-rc3</a> or
higher</li>
<li>Java 1.4 or higher</li>
<li>Servlet 2.3:<br/>
Tomcat 4.1.x<br/>
<b>or</b> <br/>
Tomcat 5.x</li>
</ul>
</section>
<section name='1. Get Maven Ready'>
<p>If you have not already done so, download and install Maven.</p>
</section>
<section name='2. Build Properties'>
<p>Please set these values in your ${USER_HOME}/<code>build.properties</code>
file:</p>
<table>
<tr>
<th>property</th>
<th>example</th>
<th>what is it?</th>
</tr>
<tr>
<td>org.apache.jetspeed.server.home</td>
<td>${CATALINA_HOME}/</td>
<td>The root of your Tomcat server installation.</td>
</tr>
<tr>
<td>org.apache.jetspeed.catalina.version.major</td>
<td>4</td>
<td>Are you using Tomcat 4.1.x or 5.x?</td>
</tr>
<tr>
<td>org.apache.jetspeed.server.shared</td>
<td>${org.apache.jetspeed.server.home}/shared/lib/</td>
<td>The location of the shared jars in your Tomcat installation.</td>
</tr>
<tr>
<td>org.apache.jetspeed.deploy.war.dir</td>
<td>${org.apache.jetspeed.server.home}/webapps/</td>
<td>The location to deploy web application in Tomcat.</td>
</tr>
<tr>
<td>org.apache.jetspeed.services.autodeployment.user</td>
<td>your-tomcat-manager-user</td>
<td>a Tomcat user with the manager role.
See the Tomcat Configuration section below.
</td>
</tr>
<tr>
<td>org.apache.jetspeed.services.autodeployment.password</td>
<td>your-tomcat-manager-user-password</td>
<td>The password of the Tomcat manager user.</td>
</tr>
</table>
<p>
<i>If you are using Tomcat 5.x, the allBuild goal described below will install a
patched version of the JAASRealm class in ${catalina.home}/server/classes to
enable Jetspeed JAAS based security.
For more information about this patch see:
<a href='http://issues.apache.org/jira/browse/JS2-55'>
Issue 55: JAAS Authentication on Tomcat 5</a></i>.
</p>
<p>
To develop or deploy Jetspeed with another database (not the default HSQL), see the
property configuration in the
<a href='database.html'>Database Configuration documentation</a>.
</p>
</section>
<section name="3. Tomcat Configuration">
<p>
Jetspeed 2 now uses the Tomcat manager application for hotdeployment of portlet
application war files.
To be able to do so it needs a configured Tomcat user with the predefined 'manager'
role in
the ${CATALINA_HOME}/conf/tomcat-users.xml.
</p>
<p>
A minimal example tomcat-users.xml could look like:
<pre>
<?xml version='1.0' encoding='utf-8'?>
<tomcat-users>
<role rolename="manager"/>
<user username="j2deployer" password="j2deployer" roles="manager"/>
</tomcat-users>
</pre>
Make sure to use a more appropriate username and password. <br/>
With the above example the required autodeployment properties should be set as:
<pre>
org.apache.jetspeed.services.autodeployment.user=j2deployer
org.apache.jetspeed.services.autodeployment.password=j2deployer
</pre>
</p>
</section>
<section name='4. Building Jetspeed 2'>
<p>
If you are using the default Hypersonic database, this procedure requires two
terminal sessions.
If you are using another database, skip the immediate section below on Terminal
Session #1.
</p>
<source test=""><![CDATA[
# Terminal Session #1: Start the Hypersonic database
cd ${jetspeed-2-home}
maven start.test.server
]]></source>
<p>
Terminal session #2, build the portal and all components and unit test Jetspeed-2:
</p>
<source test=""><![CDATA[
# Terminal Session #2: Build and Unit Test
cd ${jetspeed-2-home}
maven allClean allBuild
]]></source>
</section>
<section name="5. Deploying Jetspeed into Tomcat">
<p>
We only cover deploying to Tomcat 4 and Tomcat 5.
Step #1 below is optional if you are NOT using the default Hypersonic database.
</p>
<ul>
<li>1. If you are using the Hypersonic SQL database, make sure you have terminated
the test HSQLserver.
Then in the same terminal, start the production Hypersonic database by typing
<br/><br/><b>maven start.production.server</b><br/><br/>
</li>
<li>2. (in seperate window/terminal session) <br/><br/><b>cd
${jetspeed-2-home}</b><br/><br/>
</li>
<li>3. <b>maven quickStart</b><br/><br/> This will recreate the DB to deploy into.
WARNING This will drop all the tables and data in the production
database.<br/><br/>
</li>
<li>4. Start up Tomcat. With a browser, go to:
<br/><br/><b>http://localhost:8080/jetspeed</b><br/>
</li>
</ul>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Jetspeed 2 Home Page</title>
<subtitle>Welcome to Jetspeed 2</subtitle>
<authors>
<person name="David Sean Taylor" email="[EMAIL PROTECTED]"/>
</authors>
</properties>
<body>
<section name="Overview">
<p>
Jetspeed-2 is the next-generation enterprise portal at Apache.
Jetspeed-2 offers several architectural enhancements and improvements over
Jetspeed 1.0.
First, Jetspeed-2 is conformant to the <a
href="http://www.jcp.org/en/jsr/detail?id=168";>Java Portlet Standard</a> and will
provide a standard mechanism for the deployment of portlets.
Second, Jetspeed-2 has matured to a more scalable architecture featuring
multi-threaded functionality.
Third, Jetspeed-2 is decoupled from several legacy open source projects.
Fourth, Jetspeed-2 is based on a component architecture.
</p>
</section>
<section name="What is Jetspeed?">
<p>
Jetspeed is an Open Source implementation of an Enterprise Information Portal, using
Java and XML.
A portal makes network resources (applications, databases and so forth) available to
end-users. The
user can access the portal via a web browser, WAP-phone, pager or any other device.
Jetspeed acts
as the central hub where information from multiple sources are made available in an
easy to use manner.
</p>
<p>
The data presented via Jetspeed is independent of content type, This means that
content from for example
XML,RSS or SMTP can be integrated with Jetspeed. The actual presentation of the data
is
handled via ates XSL and delivered to the user for example via the combination of
Java Server Pages (JSPs)
and HTML. Jetspeed provides support for templating and content publication
frameworks such as
<a href="http://xml.apache.org/cocoon/";>Cocoon</a>, <a
href="http://www.webmacro.org/";>WebMacro</a> and
<a href="http://jakarta.apache.org/velocity/";>Velocity</a>. Note that outside of
regualar browser Jetspeed also supports WAP devices.
</p>
<p>
Jetspeed helps you build portal applications quickly. The goal is to make Jetspeed a
tool for both portal developers as well
as user interface designers. Currently the focus is on providing developers with a
set of tools that facilitates building
the base for the portal. With Jetspeed you can quickly build an XML
portal and also syndicate your own content.
</p>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/js2-goals.xml
Index: js2-goals.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Maven Goals</title>
</properties>
<body>
<p>
In addition the standard maven goals, the following goals have been defined.
</p>
<section name="Root Project">
<table>
<tr>
<th>Goal</th>
<th>Description</th>
</tr>
<tr>
<td>allBuild</td>
<td>
Builds war and jar files in the correct order for each
subproject, including the portlet applications. After
each war or jar is build, it is coppied to the local
maven repository.
</td>
</tr>
<tr>
<td>allClean</td>
<td>Cleans all subprojects and the root project.</td>
</tr>
<tr>
<td>allSite</td>
<td>See the allSite goals in the Site subproject</td>
</tr>
</table>
</section>
<section name="Site Subproject">
<table>
<tr>
<th>Goal</th>
<th>Description</th>
</tr>
<tr>
<td>allSite</td>
<td>
Builds the site for each subproject and updates the
subproject list on the navigation bar. This calls
the "subSite" and "site" goals.
</td>
</tr>
<tr>
<td>subSite</td>
<td>
Builds the site for each subproject, excluding the "site"
subproject, and updates the subproject list on the navigation bar.
</td>
</tr>
</table>
</section>
</body>
</document>
1.1 jakarta-jetspeed-2/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
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.
-->
<!--
WARNING: This file is generated. The source is xdocs-templates/navigation.xml
Note: Changes to this file are not reflected on the generated site until the
allSite goal is atained, i.e. maven allSite
-->
<project>
<body>
<menu name="Essentials">
<item name="Getting Started" href="getting-started.html.html"/>
<item name="Database" href="database.html"/>
<item name="Goals" href="js2-goals.html"/>
<item name="Tasks" href="tasks.html"/>
<item name="Sub Projects" href="projects-overview.html"/>
</menu>
<menu>
<item name="Mailing List" href="mail-lists.html"/>
<item name="Bug Database" href="issue-tracking.html"/>
<item name="Wiki" href="http://wiki.apache.org/portals/Jetspeed2"/>
</body>
</project>
1.1 jakarta-jetspeed-2/xdocs/tasks.xml
Index: tasks.xml
===================================================================
<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<document>
<properties>
<title>Tasks</title>
</properties>
<body>
<section name="Container Tasks">
<subsection name="Phase 1">
<ul>
Upgrade to Maven 0.9, Im having problems with it, it won't run here (DST)
</ul>
<ul>
Add a WIKI page for Jetspeed-2
</ul>
</subsection>
<subsection name="Phase 2">
<ul>
</ul>
</subsection>
<subsection name="General Cleanup">
<ul>
<li>Replace the DocBook goals defined in maven.xml with a standard plugin.</li>
</ul>
</subsection>
</section>
<section name="Aggragation Engine Tasks">
<subsection name="Phase 1">
<ul>
</ul>
</subsection>
<subsection name="Phase 2">
<ul>
</ul>
</subsection>
</section>
<section name="Container Tasks">
<subsection name="Phase 1">
<ul>
</ul>
</subsection>
<subsection name="Phase 2">
<ul>
</ul>
</subsection>
</section>
<section name="Portlet Application Tasks">
<subsection name="Phase 1">
<ul>
</ul>
</subsection>
<subsection name="Phase 2">
<ul>
</ul>
</subsection>
</section>
<section name="General Cleanup">
<ul>
<li>Replace the DocBook goals defined in maven.xml with a standard plugin.</li>
</ul>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
