You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wsrp4j-dev@portals.apache.org by dl...@apache.org on 2007/04/13 14:08:49 UTC

svn commit: r528448 - /portals/wsrp4j/trunk/README.txt

Author: dlouzan
Date: Fri Apr 13 05:08:48 2007
New Revision: 528448

URL: http://svn.apache.org/viewvc?view=rev&rev=528448
Log:
Added some info on enabling db persistence (temp)

Modified:
    portals/wsrp4j/trunk/README.txt

Modified: portals/wsrp4j/trunk/README.txt
URL: http://svn.apache.org/viewvc/portals/wsrp4j/trunk/README.txt?view=diff&rev=528448&r1=528447&r2=528448
==============================================================================
--- portals/wsrp4j/trunk/README.txt (original)
+++ portals/wsrp4j/trunk/README.txt Fri Apr 13 05:08:48 2007
@@ -27,7 +27,8 @@
 3. Basic installation and configuration
 4. Environment variables
 5. Building and installation
-6. Known problems
+6. How to enable DB-persistence
+7. Known problems
 
 1. Introduction
    ------------
@@ -51,7 +52,7 @@
 
    * An implementation of J2SE 1.4 or upper.
 
-     - Sun's J2SE 1.4 and 5.0 have been tested.
+     - Sun's J2SE 1.4, 5.0 and 6.0 have been tested.
 
    * Subversion revision control system client.
 
@@ -59,7 +60,7 @@
      Pluto sources, while Maven 2.x is used by WSRP4J sources. Both are used 
      for managing the projects (compile, generate JavaDoc, jars, wars, ...).
 
-     - Apache Maven 1.0.2 and 2.0.4 have been tested.
+     - Apache Maven 1.0.2 and 2.0.5 have been tested.
 
    * Apache Pluto 1.0.1 (source).
 
@@ -112,18 +113,18 @@
        $ export MAVEN_HOME=~/local/maven-1.0.2
        $ ./maven --version
 
-   * Installation of Apache Maven 2.0.4 on Unix-like operating systems:
+   * Installation of Apache Maven 2.0.5 on Unix-like operating systems:
 
-     - Download the .tar.gz binary package of Maven 2.0.4 from:
+     - Download the .tar.gz binary package of Maven 2.0.5 from:
            http://maven.apache.org/download.html
 
      - Unpack the distribution on some directory (like ~/local):
        $ cd ~/local
-       $ tar xvzf ~/downloads/maven-2.0.4-bin.tar.gz
+       $ tar xvzf ~/downloads/maven-2.0.5-bin.tar.gz
 
      - Check that your distribution is working properly by executing Maven:
-       $ cd ~/local/maven-2.0.4/bin
-       $ export MAVEN_HOME=~/local/maven-2.0.4
+       $ cd ~/local/maven-2.0.5/bin
+       $ export MAVEN_HOME=~/local/maven-2.0.5
        $ ./mvn --version
 
    3.3 Basic installation and configuration of Apache Tomcat
@@ -166,8 +167,8 @@
      - Tomcat will need to be restarted for the changes to take effect.
 
      - **IMPORTANT**
-       Due to an error on iBiblio, it's necessary to install serializer jar into
-       your local maven repository (see Section 6). Execute:
+       Due to an error on iBiblio, it's necessary to install serializer jar
+       into your local maven repository (see Section 6). Execute:
        $ mvn install:install-file -DgroupId=xalan -DartifactId=serializer \
            -Dversion=2.7.0 -Dpackaging=jar -Dfile=serializer.jar
 
@@ -180,22 +181,24 @@
 
      - Dowload the file jta-1_0_1B-classes.zip (JTA 1.0.1B) from:
            http://java.sun.com/products/jta/
-     
+
      - Install the file jta-1_0_1B-classes.zip to your Maven repository:
-       $ mvn install:install-file -DgroupId=javax.transaction -DartifactId=jta \
-           -Dversion=1.0.1B -Dpackaging=jar -Dfile=jta-1_0_1B-classes.zip
+       $ mvn install:install-file -DgroupId=javax.transaction \
+           -DartifactId=jta -Dversion=1.0.1B -Dpackaging=jar \
+           -Dfile=jta-1_0_1B-classes.zip
 
    3.6 (Optional) Basic installation and configuration of HSQLDB 1.8.0.7
        -----------------------------------------------------------------
 
-   * If you want to use the persistence-db module, you need a relational database
-     and a driver to connect to the database. The examples assume you have
-     installed HSQLDB.
+   * If you want to use the persistence-db module, you need a relational
+     database and a driver to connect to the database. The examples assume you
+     have installed HSQLDB.
 
      - Download hsqldb_1_8_0_7.zip from:
            http://www.hsqldb.org/
 
-     - Unpack the file and copy hsqldb-1.8.0.7.jar to $CATALINA_HOME/commmon/lib:
+     - Unpack the file and copy hsqldb-1.8.0.7.jar to
+       $CATALINA_HOME/commmon/lib:
        $ cp hsqldb-1.8.0.7.jar $CATALINA_HOME/common/lib
        This is needed by the Tomcat DataSource configured to connect to the db.
 
@@ -248,7 +251,7 @@
    Set up all environment variables (see Section 4). Execute ". ~/.bashrc" if
    necessary.
 
-   For WSRP4J you will need Maven 2.0.4. Assuming you have downloaded the svn
+   For WSRP4J you will need Maven 2.0.X. Assuming you have downloaded the svn
    trunk repos to ~/local/wsrp4j:
 
    - Copy build.properties.sample to build.properties.
@@ -327,11 +330,11 @@
 
    The PortletConfig portlet bundled with proxyportlet will allow you to add
    new remote portlets to proxyportlet. Unfortunately, the default PlutoPortal
-   distribution does not support dynamic reloading of portlet.xml contents, that
-   is, that file will only be processed once when you deploy proxyportlet for
-   the first time, and subsequent modifications on it won't be automatically
-   deployed. You can manually add new modifications by stopping Tomcat and
-   executing:
+   distribution does not support dynamic reloading of portlet.xml contents,
+   that is, that file will only be processed once when you deploy proxyportlet
+   for the first time, and subsequent modifications on it won't be
+   automatically deployed. You can manually add new modifications by stopping
+   Tomcat and executing:
    $ cd $PLUTO_HOME
    $ export MAVEN_HOME=~/local/maven-1.0.2; export PATH=$MAVEN_HOME/bin:$PATH
    $ maven deploy -Ddeploy=$CATALINA_HOME/webapps/wsrp4j-proxyportlet
@@ -340,17 +343,17 @@
 
    Other portals (like Apache Jetspeed) do support dynamic reloading of
    portlet.xml contents.
-   
+
    If you want the Axis-generated sources from WSDL files in commons/src/wsdl,
    then edit commons/pom.xml and uncomment the antrun-plugin in the <plugins>
-   section, then rebuild the project. The Axis-generated sources will be located
-   in directory commons/target/generated-sources/wsdl. This files won't be used
-   for actually building the libraries, the ones used are under
+   section, then rebuild the project. The Axis-generated sources will be
+   located in directory commons/target/generated-sources/wsdl. This files
+   won't be used for actually building the libraries, the ones used are under
    commons/src/java/. See commons/src/wsdl/README.txt for more details.
 
-   WSRP4J also includes a standalone Swing application for consuming remote WSRP
-   portlets (consumer-swingconsumer module). For executing it, you have to copy
-   some files and directories to any other directory (like
+   WSRP4J also includes a standalone Swing application for consuming remote
+   WSRP portlets (consumer-swingconsumer module). For executing it, you have
+   to copy some files and directories to any other directory (like
    ~/local/wsrp4j-swingconsumer) and execute the following:
    $ cp consumer-swingconsumer/target/wsrp4j-swingconsumer-jar-with-dependencies.jar \
        ~/local/wsrp4j-swingconsumer
@@ -358,23 +361,42 @@
        ~/local/wsrp4j-swingconsumer/persistence
    $ cd ~/local/wsrp4j-swingconsumer
    $ java -jar wsrp4j-swingconsumer-jar-with-dependencies.jar
-   Keep in mind that this app is no longer maintained and doesn't support forms,
-   only links. Don't forget to start the corresponding tunnel.sh from tools/
-   directory. The log is stored on file wsrp4j-swingconsumer.log.
+   Keep in mind that this app is no longer maintained and doesn't support
+   forms, only links. Don't forget to start the corresponding tunnel.sh from
+   tools/ directory. The log is stored on file wsrp4j-swingconsumer.log.
+
+6. How to enable DB-persistence
+   ----------------------------
+
+   DB persistence can be enabled on both wsrp4j-producer and
+   wsrp4j-proxyportlet, on any of them or none. The default behaviour is the
+   XML files based persistence.
+
+   6.1 Enabling DB-persistence on wsrp4j-producer
+       ------------------------------------------
+
+   The jar files for persistence are included on the lib/ directory of the war
+   file wsrp4j-producer.war. Configuration files:
+   - META-INF/context.xml
+   - 
+
+   6.2 Enabling DB-persistence on wsrp4j-proxyportlet
+       ----------------------------------------------
 
-6. Known problems
+7. Known problems
    --------------
 
    * Currently the WSRP4J Producer component does not implement 'WSRP Producer
      URL Writing' (see WSRP Specification Section 10.2.2). The support for
      templates on WSRP4J ProxyPortlet is **experimental** as well.
 
-   * The WSRP4J Producer config servlet won't run correctly until an actual call
-     to the Axis servlet is made. This is due to the design of the pluto
+   * The WSRP4J Producer config servlet won't run correctly until an actual
+     call to the Axis servlet is made. This is due to the design of the pluto
      provider interface in commmons-producer and producer.
 
    * Due to Axis bug AXIS-2096, the wsdl generation of the WSRP services served
      by Axis in wsrp4j-producer will fail.
 
-   * Currently, Apache Xalan distribution on iBiblio doesn't include serializer 
-     jar, so it must be manually added to the local Maven repository.
+   * Currently, Apache Xalan distribution on iBiblio doesn't include
+     serializer jar, so it must be manually added to the local Maven
+     repository.