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 2006/12/13 20:03:53 UTC
svn commit: r486796 - in /portals/wsrp4j/trunk: ./ README.txt WHATWHERE.txt
commons/src/wsdl/README.txt
Author: dlouzan
Date: Wed Dec 13 11:03:51 2006
New Revision: 486796
URL: http://svn.apache.org/viewvc?view=rev&rev=486796
Log:
Updated project documentation
Modified:
portals/wsrp4j/trunk/ (props changed)
portals/wsrp4j/trunk/README.txt
portals/wsrp4j/trunk/WHATWHERE.txt
portals/wsrp4j/trunk/commons/src/wsdl/README.txt
Propchange: portals/wsrp4j/trunk/
------------------------------------------------------------------------------
--- svn:ignore (original)
+++ svn:ignore Wed Dec 13 11:03:51 2006
@@ -4,3 +4,4 @@
bin
wsad
catalog.xml
+build.properties
Modified: portals/wsrp4j/trunk/README.txt
URL: http://svn.apache.org/viewvc/portals/wsrp4j/trunk/README.txt?view=diff&rev=486796&r1=486795&r2=486796
==============================================================================
--- portals/wsrp4j/trunk/README.txt (original)
+++ portals/wsrp4j/trunk/README.txt Wed Dec 13 11:03:51 2006
@@ -37,13 +37,20 @@
$ mvn clean
Remove all generated artifacts
-The axis-generated sources from wsdl files in commons/src/wsdl will be located
-in directory commons/target/generated-sources/wsdl. This files are not used for
-building the libraries, the ones used are below commons/src/java/.
+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 below commons/src/java/. See
+commons/src/wsdl/README.txt for more details.
The proxyportlet and producer wars are located on their respective
target directories (consumer-proxyportlet/target/wsrp4j-proxyportlet.war and
producer/target/wsrp4j-producer.war).
-For deploying the proxyportlet, just install Pluto with PlutoPortal and use the
-admin portlet bundled with Pluto to deploy wsrp4j-proxyportlet.war
\ No newline at end of file
+For deploying the proxyportlet, just install Pluto 1.0.1 with PlutoPortal and
+use the admin portlet bundled with PlutoPortal to deploy wsrp4j-proxyportlet.war
+The default producer configuration files supplied with proxyportlet assume you
+have started the corresponding tunnel script from tools/ directory. This tunnel
+tool will allow you to view the wsrp messages exchanged between the consumer
+and the producer.
Modified: portals/wsrp4j/trunk/WHATWHERE.txt
URL: http://svn.apache.org/viewvc/portals/wsrp4j/trunk/WHATWHERE.txt?view=diff&rev=486796&r1=486795&r2=486796
==============================================================================
--- portals/wsrp4j/trunk/WHATWHERE.txt (original)
+++ portals/wsrp4j/trunk/WHATWHERE.txt Wed Dec 13 11:03:51 2006
@@ -1,4 +1,4 @@
-# Copyright 2003-2005 The Apache Software Foundation.
+# Copyright 2003-2006 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.
@@ -12,40 +12,55 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-This documents the directory structure of the wsrp4j sandbox.
-
-sandbox/wsrp4j/
- commons/
- Common code.
+This documents the directory structure of the wsrp4j distribution. Wsrp4j uses
+Maven 2.x to build the source using a multi-module approach. See README.txt
+file for installation instructions.
+
+commons/
+ Common code used both by consumers and producers. Includes the wsrp
+ specification wsdl files released by OASIS under commons/src/wsdl dir. It
+ also includes the stubs and skeletons for the underlying web services in
+ the commons/src/java/oasis dir.
- commons-consumer/
+commons-consumer/
Common code to any consumer implementation.
- Depends on commons.
- commons-producer/
+ Depends on commons module.
+
+commons-producer/
Common code to any producer implementation.
Depends on commons.
- persistence-xml/
- XML mapping persistence implementation.
+persistence-xml/
+ Xml mapping persistence implementation. Implements the persistent packages
+ included on commons, storing all required persistent information needed by
+ consumers and producers as xml files.
Depends on commons, commons-producer and commons-consumer.
- consumer/
- JSR-168 portlet consumer implementation.
+consumer-proxyportlet/
+ Jsr-168 portlet wsrp consumer implementation. Implements a jsr-168-compliant
+ portlet aplication pluggable on any portal server which supports the jsr-168
+ standard for consuming remote wsrp portlets.
Depends on commons, commons-consumer and persistence-xml.
- consumer-swingconsumer/
- Java Swing application consumer implementation.
+consumer-swingconsumer/
+ Java Swing application wsrp consumer implementation. Not currently actively
+ developed.
Depends on commons, commons-consumer and persistence-xml.
- producer-axis/
- Axis-based producer implementation.
+producer/
+ Axis-based producer implementation. Uses an axis servlet for receiving the
+ requests and forwards them to a provider backend implementation. The
+ producer code is generic and uses the provider interfaces for serving the
+ actual markup returned by the portlets. The default provider implementation
+ is based on pluto-portal, this way the portlets served by producer are
+ standard jsr-168 portlets rendered by pluto-portal.
Depends on commons, commons-producer and persistence-xml.
- testportlet/
- JSR-168 test portlet.
-
- etc/
- Miscellaneous configuration for all modules.
-
- site/
- WSRP4J site documentation.
\ No newline at end of file
+testportlet/
+ Jsr-168 test portlet. A jsr-168 portlet used to test both the consumer and
+ producer implementations.
+
+tools/
+ The scripts in this directory provide a handy way of starting the Axis TCP
+ Monitor for several online wsrp producers available. This tools allows
+ monitoring the wsrp messages exchanged between consumers and producers.
Modified: portals/wsrp4j/trunk/commons/src/wsdl/README.txt
URL: http://svn.apache.org/viewvc/portals/wsrp4j/trunk/commons/src/wsdl/README.txt?view=diff&rev=486796&r1=486795&r2=486796
==============================================================================
--- portals/wsrp4j/trunk/commons/src/wsdl/README.txt (original)
+++ portals/wsrp4j/trunk/commons/src/wsdl/README.txt Wed Dec 13 11:03:51 2006
@@ -14,7 +14,7 @@
Downloaded from http://www.oasis-open.org/committees/documents.php.
-There are different versions of them, these are from dates:
+There are different versions of the wsdl & xsd files, these are from dates:
wsrp_v1_types.xsd: 30 Jun 2003
wsrp_v1_interfaces.wsdl: 27 Jun 2003