WSRP4J Configuration

Producer Configuration

The WSRP4J embeds Pluto as its portlet container. To add a portlet to be hosted by the WSRP4J Producer, use Pluto's deploy function to deploy the portlet's WAR file. The testportlet that comes with WSRP4J uses the following maven goal to deploy itself to Pluto. This code can be found in wsrp4j/testport/maven.xml.

    <goal name="tomcat:deploy">
        <java classname="org.apache.pluto.driver.deploy.CLI" fork="yes">
                <path refid="maven.dependency.classpath"/>
                <pathelement path="${}"/>
            <arg value="-verbose"/>
            <arg value="-p"/><arg value="${maven.tomcat.home}/webapps/wsrp4j-producer"/>
            <arg value="-d"/><arg value="${maven.tomcat.home}/webapps"/>
            <arg value="${basedir}/target/${}"/>

Consumer Configuration (SwingConsumer)

Once you have your portlets configured on the producer side, to add a portlet to the SwingConsumer you will need to create an xml file in driver/SwingConsumer/persistence/portlets.

Use the existing files as a guide.

Consumer Configuration (ProxyPortlet)

You'll need some portal environment for using the ProxyPortlet component bundled with WSRP4J. The WSRP4J team has tested PlutoPortal, the minimal portal component included with the Pluto distribution.

Firstly, make sure you have your portlets correctly configured in the producer component.

  1. Configure your producer endpoint urls in the proxyportlet/WEB-INF/persistence/producers/ directory. You have to create one file per producer, the naming being org.apache.wsrp4j.consumer.driver.ProducerImpl@<name>.xml, where <name> is a name you choose. If you are consuming you own local portlets, you don't have to do nothing, as there's a file org.apache.wsrp4j.consumer.driver.ProducerImpl@wsrp4j-8081.xml file with local configuration. Use one of the existing files as guidance. Be sure to assign a unique producer id to your producer. An example would be:
    <Producer id="100">
            <consumer-name>WSRP4J Proxy Portlet</consumer-name>
            <consumer-agent>WSRP4J Proxy Portlet</consumer-agent>
    Remember that the actual urls are configured in the file in the wsrp4j/tools/ directory. You could add one file per producer (,, etc) to be able to distinguish each other network traffic.
  2. At this point you have to remember your producer id (e.g. "100") and your remote portlet identifier configured in the producer (e.g. "0.1").
  3. Now it's time to configure PlutoPortal. Please refer to Pluto website on how to build & install it. There are two files involved, both of them in the pluto/WEB-INF/data/ directory: pageregistry.xml and portletentityregistry.xml.
  4. The file portletentityregistry.xml controls the portlet applications deployed by PlutoPortal. You have to create a new application element like this:
    <application id="5">
        <portlet id="1">
    The important lines are the wsrp_portlet_handle and wsrp_producer_id preferences. The former has to be a portlet handle configured on the producer ("0.1" in step 2), the latter it's the assigned producer id ("100" in step 2). The configuration above creates a portlet application in PlutoPortal with id "5.1", that accesses the remote portlet "0.1" in the producer with id "100".
  5. Finally, the file pageregistry.xml controls the portal pages layout. You can find more information on Pluto website, but if you add a line like this:
    <fragment name="row10" type="row">
        <fragment name="col10" type="column">
            <fragment name="p10" type="portlet">
                <property name="portlet" value="5.1"/>
    with unique identifiers "row10", "col10" and "p10", you'll get your portlet displayed when you point your browser to PlutoPortal. The property "portlet" has value "5.1" as that is the portlet application we configured in the previous step.