# 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.
# 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.

# $Id$

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/
    Common code to any consumer implementation.
    Depends on commons module.

commons-producer/
    Common code to any producer implementation. 
    Depends on commons.

persistence-db/
    DB persistence implementation. Implements the persistent packages included
    in commons, storing all required persistent information needed by consumers
    and producers in a relational database.
    Depends on commons, commons-producer and commons-consumer.

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-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 and commons-consumer.

consumer-swingconsumer/
    Java Swing application wsrp consumer implementation. Not currently actively
    developed.
    Depends on commons and commons-consumer.

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 and commons-producer.

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.