Author: smumford
Date: 2011-03-22 21:53:48 -0400 (Tue, 22 Mar 2011)
New Revision: 6113
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml
Log:
Porting new WSRP content for 5.1.1 to 5.2
Modified: epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml
===================================================================
--- epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2011-03-23 01:38:47 UTC
(rev 6112)
+++ epp/docs/branches/5.2/Reference_Guide/en-US/modules/WSRP.xml 2011-03-23 01:53:48 UTC
(rev 6113)
@@ -183,12 +183,6 @@
</listitem>
</varlistentry>
</variablelist>
- <para>
- If WSRP is not going to be used in your &PRODUCT; instance your installation will
not be adversely affected should you leave the WSRP files in place.
- </para>
- <para>
- However, if you wish to completely remove WSRP from your &PRODUCT;
installation, follow the procedure at <ulink type="http"
url="http://community.jboss.org/wiki/WSRPserviceremovalprocedure&quo...;.
- </para> <!-- DOC NOTE: Port this procedure into the doc for EPP 5.1.1
JBEPP-739 -->
<section
id="sect-Reference_Guide-Deploying_WSRP-Non_default_Ports_or_Hostnames">
<title>Non-default Ports or Hostnames</title>
@@ -1308,7 +1302,303 @@
By default, the WSRP producer is configured in strict mode. If you experience issues
with a given consumer, you may attempt to relax the validation mode. Un-checking the
"Use strict WSRP compliance" checkbox on the Producer configuration screen to do
this.
</para>
</section>
-
</section>
+ <section
id="sect-Reference_Guide-Web_Services_for_Remote_Portlets_WSRP-Removing_WSRP">
+ <title>Removing WSRP</title>
+ <para>
+ If you are not going to use WSRP in your &PRODUCT; instance, your
installation will not be adversely affected should you leave the WSRP files in place.
+ </para>
+ <para>
+ However, if you wish to completely remove WSRP from your &PRODUCT;
installation, follow this procedure:
+ </para>
+ <procedure>
+ <title></title>
+ <step>
+ <para>
+ Navigate to the
<filename><replaceable>JBOSS_HOME</replaceable>/jboss-as/server/<replaceable><PROFILE></replaceable>/conf/gatein/</filename>
directory of your &PRODUCT; instance.
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Open the <filename>configuration.xml</filename>
file and remove the following lines:
+ </para>
+<programlisting><![CDATA[<value>
+ <string>wsrp-producer</string>
+</value>
+]]></programlisting>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>
+ Navigate up two directory levels and into the
<filename>deploy/gatein.ear/</filename> directory (For example:
<command>cd ../../deploy/gatein.ear/</command>).
+ </para>
+ </step>
+ <step>
+ <para>
+ Remove the following files:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <filename>wsrp-admin-gui.war</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>wsrp-producer.war</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>
+ Navigate into the <filename>lib/</filename>
subdirectory and remove the following files:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+
<filename>gatein.portal.component.wsrp-PORTAL_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-common-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-consumer-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-integration-api-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-producer-lib-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-wsrp1-ws-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>wsrp-wsrp2-ws-WSRP_VERSION.jar</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ <step>
+ <para>
+ Return to the <filename>gatein.ear/</filename>
directory and move into the <filename>META-INF/</filename> subdirectory.
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Open the
<filename>application.xml</filename> file and remove the following modules:
+ </para>
+<programlisting><![CDATA[<module>
+ <web>
+ <web-uri>wsrp-admin-gui.war</web-uri>
+ <context-root>wsrp-admin-gui</context-root>
+ </web>
+</module>
+]]></programlisting>
+
+<programlisting><![CDATA[<module>
+ <web>
+ <web-uri>wsrp-producer.war</web-uri>
+ <context-root>wsrp-producer</context-root>
+ </web>
+</module>
+]]></programlisting>
+ </step>
+ <step>
+ <para>
+ Save and exit the file.
+ </para>
+ </step>
+ <step>
+ <para>
+ Remove all the <emphasis
role="bold">WSRP</emphasis> SHA1 entries in the
<filename>MANIFEST.MF</filename> file. They are not required.
+ </para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>
+ Return to the <filename>gatein.ear/</filename>
directory and navigate into the
<filename>02portal.war/WEB-INF/conf/</filename> subdirectory.
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Remove the <filename>wsrp/</filename>
directory.
+ </para>
+ </step>
+ <step>
+ <para>
+ Open the <filename>configuration.xml</filename>
file and remove the following line:
+ </para>
+<programlisting><![CDATA[<import
profiles="jboss">war:/conf/wsrp/wsrp-configuration.xml</import>
+]]></programlisting>
+ </step>
+ <step>
+ <para>
+ Save and exit the file.
+ </para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>
+ From your current location, navigate into the
<filename>portal/</filename> subdirectory.
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Open the
<filename>portal-configuration.xml</filename> file and remove the line:
+ </para>
+<programlisting><![CDATA[<value>org.exoplatform.portal.pom.spi.wsrp.WSRPState</value>
+]]></programlisting>
+ </step>
+ <step>
+ <para>
+ Save and exit the file.
+ </para>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <para>
+ Return to the <filename>conf/</filename> directory
and move into the <filename>jcr/</filename> subdirectory.
+ </para>
+ <substeps>
+ <step>
+ <para>
+ Open the
<filename>jcr-configuration.xml</filename> file and remove the line:
+ </para>
+<programlisting><![CDATA[<property name="wsrp"
value="http://www.gatein.org/jcr/wsrp/1.0/"/>
+]]></programlisting>
+ </step>
+ <step>
+ <para>
+ Remove the following configuration file references:
+ </para>
+<programlisting><![CDATA[<value>war:/conf/wsrp/consumers-configuration-nodetypes.xml</value>
+<value>war:/conf/wsrp/producer-configuration-nodetypes.xml</value>
+<value>war:/conf/wsrp/producer-registrations-nodetypes.xml</value>
+<value>war:/conf/wsrp/producer-pc-nodetypes.xml</value>
+<value>war:/conf/wsrp/migration-nodetypes.xml</value>
+]]></programlisting>
+ </step>
+ <step>
+ <para>
+ Save and exit the file.
+ </para>
+ </step>
+ <step>
+ <para>
+ Open the
<filename>repository-configuration.xml</filename> and remove the <emphasis
role="bold">WSRP</emphasis> workspace:
+ </para>
+<programlisting><![CDATA[<!-- WSRP -->
+ <workspace name="wsrp-system">
+ <container>
+ <properties>
+ <property name="source-name"
value="${gatein.jcr.datasource.name}${container.name.suffix}"/>
+ <property name="dialect"
value="${gatein.jcr.datasource.dialect}"/>
+ <property name="multi-db" value="false"/>
+ <property name="update-storage" value="true"/>
+ <property name="max-buffer-size"
value="204800"/>
+ <property name="swap-directory"
value="${gatein.jcr.data.dir}/swap/wsrp${container.name.suffix}"/>
+ </properties>
+ <value-storages>
+ <value-storage id="gadgets"
+ >
+ <properties>
+ <property name="path"
value="${gatein.jcr.storage.data.dir}/wsrp${container.name.suffix}"/>
+ </properties>
+ <filters>
+ <filter property-type="Binary"/>
+ </filters>
+ </value-storage>
+ </value-storages>
+ </container>
+ <initializer>
+ <properties>
+ <property name="root-nodetype"
value="nt:unstructured"/>
+ <property name="root-permissions"
value="*:/platform/administrators read;*:/platform/administrators
add_node;*:/platform/administrators set_property;*:/platform/administrators
remove"/>
+ </properties>
+ </initializer>
+ <cache enabled="true">
+ <properties>
+ <property name="jbosscache-configuration"
value="${gatein.jcr.cache.config}" />
+ <property name="jgroups-configuration"
value="${gatein.jcr.jgroups.config}" />
+ <property name="jgroups-multiplexer-stack"
value="true" />
+ <property name="jbosscache-cluster-name"
value="jcr-${container.name.suffix}-wsrp-system" />
+ </properties>
+ </cache>
+ <query-handler>
+ <properties>
+ <property name="index-dir"
value="${gatein.jcr.index.data.dir}/wsrp-system${container.name.suffix}"/>
+ <property name="changesfilter-class"
value="${gatein.jcr.index.changefilterclass}" />
+ <property name="jbosscache-configuration"
value="${gatein.jcr.index.cache.config}" />
+ <property name="jgroups-configuration"
value="${gatein.jcr.jgroups.config}" />
+ <property name="jgroups-multiplexer-stack"
value="true" />
+ <property name="jbosscache-cluster-name"
value="jcrindexer-${container.name.suffix}-wsrp-system" />
+ <property name="max-volatile-time" value="60"
/>
+ </properties>
+ </query-handler>
+ <lock-manager>
+ <properties>
+ <property name="time-out" value="15m" />
+ <property name="jbosscache-configuration"
value="${gatein.jcr.lock.cache.config}" />
+ <property name="jgroups-configuration"
value="${gatein.jcr.jgroups.config}" />
+ <property name="jgroups-multiplexer-stack"
value="true" />
+ <property name="jbosscache-cluster-name"
value="jcrlock-${container.name.suffix}-wsrp-system" />
+ <property name="jbosscache-cl-cache.jdbc.table.name"
value="jcrlock_wsrp_system" />
+ <property name="jbosscache-cl-cache.jdbc.table.create"
value="true" />
+ <property name="jbosscache-cl-cache.jdbc.table.drop"
value="false" />
+ <property name="jbosscache-cl-cache.jdbc.table.primarykey"
value="pk" />
+ <property name="jbosscache-cl-cache.jdbc.fqn.column"
value="fqn" />
+ <property name="jbosscache-cl-cache.jdbc.node.column"
value="node" />
+ <property name="jbosscache-cl-cache.jdbc.parent.column"
value="parent" />
+ <property name="jbosscache-cl-cache.jdbc.datasource"
value="${gatein.jcr.datasource.name}${container.name.suffix}" />
+ </properties>
+ </lock-manager>
+ </workspace>
+]]></programlisting>
+ </step>
+ </substeps>
+ </step>
+ <step>
+ <title>Optional:</title>
+ <para>
+ Remove any references to <emphasis>WSRP</emphasis>
from the following files:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+
<filename>gatein.ear/01eXoResources.war/META-INF/MANIFEST.MF</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>gatein.ear/META-INF/MANIFEST.MF</filename>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+
<filename>gatein.ear/02portal.war/META-INF/MANIFEST.MF</filename>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </step>
+ </procedure>
+ </section>
</chapter>