You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@portals.apache.org by wo...@apache.org on 2010/01/04 12:43:49 UTC

svn commit: r895605 - in /portals/site/jetspeed/jetspeed-2.2: jetspeed-guide-build/src/site/xdoc/maven-2-build.xml jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml

Author: woonsan
Date: Mon Jan  4 11:43:49 2010
New Revision: 895605

URL: http://svn.apache.org/viewvc?rev=895605&view=rev
Log:
Adding sample configurations for maven build with PostgreSQL database and test environment.
Also, correcting the terms of rest api docs.

Modified:
    portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
    portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml

Modified: portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml?rev=895605&r1=895604&r2=895605&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml (original)
+++ portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-build/src/site/xdoc/maven-2-build.xml Mon Jan  4 11:43:49 2010
@@ -77,6 +77,22 @@
     <org.apache.jetspeed.production.database.driver>org.apache.derby.jdbc.EmbeddedDriver</org.apache.jetspeed.production.database.driver>
     <org.apache.jetspeed.production.database.user></org.apache.jetspeed.production.database.user>
     <org.apache.jetspeed.production.database.password></org.apache.jetspeed.production.database.password>
+    
+    ...
+    
+    <!-- You can also configure test database properties below if you want to run unit tests. -->
+    
+    <!-- Test jdbc driver artifact properties -->
+    <org.apache.jetspeed.test.jdbc.driver.groupId>org.apache.derby</org.apache.jetspeed.test.jdbc.driver.groupId>
+    <org.apache.jetspeed.test.jdbc.driver.artifactId>derby</org.apache.jetspeed.test.jdbc.driver.artifactId>
+    <org.apache.jetspeed.test.jdbc.driver.version>10.3.2.1</org.apache.jetspeed.test.jdbc.driver.version>
+    
+    <!-- Test database name, JDBC url, JDBC driver name and connection information -->
+    <org.apache.jetspeed.test.database.default.name>derby</org.apache.jetspeed.test.database.default.name>
+    <org.apache.jetspeed.test.database.url>jdbc:derby:/tmp/derby/testdb;create=true</org.apache.jetspeed.test.database.url>
+    <org.apache.jetspeed.test.database.driver>org.apache.derby.jdbc.EmbeddedDriver</org.apache.jetspeed.test.database.driver>
+    <org.apache.jetspeed.test.database.user></org.apache.jetspeed.test.database.user>
+    <org.apache.jetspeed.test.database.password></org.apache.jetspeed.test.database.password>
     ...
 </properties>]]></source>
                 </p>
@@ -98,7 +114,46 @@
                     For details about supported databases, refer to the <a href="http://db.apache.org/ddlutils/">Apache DB Project - DdlUtils Homepage</a>.
                 </p>
                 <p>
-                    The following <strong><code>jetspeed-mvn-settings.xml</code></strong> provides a sample configuration using a MySQL database:
+                    The following <strong><code>jetspeed-mvn-settings.xml</code></strong> provides a sample configuration using a PostgreSQL database:
+                    <source><![CDATA[
+<properties>
+    ...
+    <!-- Your Tomcat Installation Path -->
+    <org.apache.jetspeed.server.home>/home/demo/tomcat-6</org.apache.jetspeed.server.home>
+    <org.apache.jetspeed.catalina.version.major>6</org.apache.jetspeed.catalina.version.major>
+
+    <!-- Production jdbc driver artifact properties -->
+    <org.apache.jetspeed.production.jdbc.driver.groupId>postgresql</org.apache.jetspeed.production.jdbc.driver.groupId>
+    <org.apache.jetspeed.production.jdbc.driver.artifactId>postgresql</org.apache.jetspeed.production.jdbc.driver.artifactId>
+    <org.apache.jetspeed.production.jdbc.driver.version>8.3-603.jdbc3</org.apache.jetspeed.production.jdbc.driver.version>
+    
+    <!-- Production database name, JDBC url, JDBC driver name and connection information -->
+    <org.apache.jetspeed.production.database.default.name>postgresql</org.apache.jetspeed.production.database.default.name>
+    <org.apache.jetspeed.production.database.url>jdbc:postgresql://localhost/j2</org.apache.jetspeed.production.database.url>
+    <org.apache.jetspeed.production.database.driver>org.postgresql.Driver</org.apache.jetspeed.production.database.driver>
+    <org.apache.jetspeed.production.database.user>j2</org.apache.jetspeed.production.database.user>
+    <org.apache.jetspeed.production.database.password>j2</org.apache.jetspeed.production.database.password>
+    
+    ...
+    
+    <!-- You can also configure test database properties below if you want to run unit tests. -->
+    
+    <!-- Test jdbc driver artifact properties -->
+    <org.apache.jetspeed.test.jdbc.driver.groupId>postgresql</org.apache.jetspeed.production.jdbc.driver.groupId>
+    <org.apache.jetspeed.test.jdbc.driver.artifactId>postgresql</org.apache.jetspeed.production.jdbc.driver.artifactId>
+    <org.apache.jetspeed.test.jdbc.driver.version>8.3-603.jdbc3</org.apache.jetspeed.production.jdbc.driver.version>
+    
+    <!-- Test database name, JDBC url, JDBC driver name and connection information -->
+    <org.apache.jetspeed.test.database.default.name>postgresql</org.apache.jetspeed.test.database.default.name>
+    <org.apache.jetspeed.test.database.url>jdbc:postgresql://localhost/j2test</org.apache.jetspeed.test.database.url>
+    <org.apache.jetspeed.test.database.driver>org.postgresql.Driver</org.apache.jetspeed.test.database.driver>
+    <org.apache.jetspeed.test.database.user>j2test</org.apache.jetspeed.test.database.user>
+    <org.apache.jetspeed.test.database.password>j2test</org.apache.jetspeed.test.database.password>
+    ...
+</properties>]]></source>
+                </p>
+                <p>
+                    Alos, the following provides a sample configuration using a MySQL database:
                     <source><![CDATA[
 <properties>
     ...
@@ -117,9 +172,31 @@
     <org.apache.jetspeed.production.database.driver>com.mysql.jdbc.Driver</org.apache.jetspeed.production.database.driver>
     <org.apache.jetspeed.production.database.user>j2</org.apache.jetspeed.production.database.user>
     <org.apache.jetspeed.production.database.password>j2</org.apache.jetspeed.production.database.password>
+    
+    ...
+    
+    <!-- You can also configure test database properties below if you want to run unit tests. -->
+    
+    <!-- Test jdbc driver artifact properties -->
+    <org.apache.jetspeed.test.jdbc.driver.groupId>mysql</org.apache.jetspeed.test.jdbc.driver.groupId>
+    <org.apache.jetspeed.test.jdbc.driver.artifactId>mysql-connector-java</org.apache.jetspeed.test.jdbc.driver.artifactId>
+    <org.apache.jetspeed.test.jdbc.driver.version>5.1.6</org.apache.jetspeed.test.jdbc.driver.version>
+    
+    <!-- Test database name, JDBC url, JDBC driver name and connection information -->
+    <org.apache.jetspeed.test.database.default.name>mysql5</org.apache.jetspeed.test.database.default.name>
+    <org.apache.jetspeed.test.database.url>jdbc:mysql://localhost:3306/j2test</org.apache.jetspeed.test.database.url>
+    <org.apache.jetspeed.test.database.driver>com.mysql.jdbc.Driver</org.apache.jetspeed.test.database.driver>
+    <org.apache.jetspeed.test.database.user>j2test</org.apache.jetspeed.test.database.user>
+    <org.apache.jetspeed.test.database.password>j2test</org.apache.jetspeed.test.database.password>
     ...
 </properties>]]></source>
                 </p>
+                <p>
+                  <em>
+                    Note: To run unit tests properly with MySQL database, you should enable InnoDB storage engine and use InnoDB tables.
+                          InnoDB is a transactional-safe (ACID compliant) storage engine for MySQL database. See the documentation of MySQL for details.
+                  </em>
+                </p>
             </subsection>
             <subsection name="Configuring Tomcat">
               <p>

Modified: portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml
URL: http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml?rev=895605&r1=895604&r2=895605&view=diff
==============================================================================
--- portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml (original)
+++ portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml Mon Jan  4 11:43:49 2010
@@ -66,11 +66,11 @@
 which is proper for the web client. Please see the documents of Apache CXF for details.
 </p>
 </subsection>       
-<subsection name='XML Schema Support'>
+<subsection name='WADL (Web Application Description Language) Support'>
 <p>
-You can also retrieve XML Schema document for each service simply by adding '?_wadl' query string.
-Apache CXF JAX-RS server, on which Jetspeed REST API depends, generates the XML Schema document for the service automatically.
-For example, you can request the following URL to retrieve the XML Schema document for 'Get Portlet Application' service of 'Portlet Registry Service'.
+You can also retrieve <a href="http://www.w3.org/Submission/wadl/">WADL</a> description for each service simply by adding '?_wadl' query string.
+Apache CXF JAX-RS server, on which Jetspeed REST API depends, generates the WADL description for the service automatically.
+For example, you can request the following URL for 'Get Portlet Application' service of 'Portlet Registry Service'.
 <source><![CDATA[
 http://localhost:8080/jetspeed/services/portletregistry/application/demo/?_wadl
 ]]></source>