11:17 p.m.
Author: smumford
Date: 2012-11-28 00:17:16 -0500 (Wed, 28 Nov 2012)
New Revision: 8970
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
Log:
BZ-794416: Added content on disabling unused portals
Modified:
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
---
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-11-26
08:55:09 UTC (rev 8969)
+++
epp/docs/branches/5.2/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-11-28
05:17:16 UTC (rev 8970)
@@ -37,7 +37,82 @@
</para>
</section>
-
+ <section
id="sect-Reference_Guide-Default_Portal_Configuration-Disabling_a_Portal">
+ <!-- DOCS NOTE:
+ This content is mirrored in the JPP 6.0 Reference Guide.
+ Any changes here should be reflected there as well.
+ -->
+ <title><remark>BZ#794416</remark>Disabling a
Portal</title>
+ <para>
+ Once you have created a custom portal that suits your needs, you may wish to
disable a portal that is no longer required.
+ </para>
+
+ <task>
+ <title>Task: Disable a portal in EPP 5</title>
+ <tasksummary>
+ <para>
+ The procedure below will show you how to disable an unused portal
in a JBoss Portal Platform instance.
+ </para>
+ </tasksummary>
+ <taskprerequisites>
+ <title>Prerequisites: </title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <remark>Are there any pre-reqs for this
task?</remark>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </taskprerequisites>
+ <procedure>
+ <title></title>
+ <step>
+ <para>
+ Add the following configuration to the
<filename>configuration.xml</filename> of the custom extension in order to
disable a portal:
+ </para>
+<programlisting language="XML" role="XML"><![CDATA[<?xml
version="1.0" encoding="UTF-8"?>
+<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd
http://www.exoplaform.org/xml/ns/kernel_1_1.xsd"
+ xmlns="http://www.exoplaform.org/xml/ns/kernel_1_1.xsd">
+ <external-component-plugins>
+ <!-- The full qualified name of the PortalContainerConfig -->
+
<target-component>org.exoplatform.container.definition.PortalContainerConfig
+ </target-component>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Add PortalContainer Definitions</name>
+ <!-- (existing configuration for new portal container) -->
+ </component-plugin>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Disable a PortalContainer</name>
+ <!-- The name of the method to call on the PortalContainerConfig in order
to register the changes on the PortalContainerDefinitions -->
+ <set-method>registerDisablePlugin</set-method>
+ <!-- The full qualified name of the PortalContainerDefinitionDisablePlugin
-->
+
<type>org.exoplatform.container.definition.PortalContainerDefinitionDisablePlugin</type>
+ <init-params>
+ <!-- The list of the name of the portal containers to disable -->
+ <values-param>
+ <name>names</name>
+ <value>$PORTAL_NAME</value>
+ </values-param>
+ </init-params>
+ </component-plugin>
+ </external-component-plugins>
+</configuration>
+]]></programlisting>
+ </step>
+ </procedure>
+ <taskrelated>
+ <note>
+ <title></title>
+ <para>
+ Disabling the default <emphasis>portal</emphasis>
container is possible as well, but some functions, such as WSRP, or Services Management,
depend on the default portal container to be deployed, and will no longer work if this is
disabled.
+ </para>
+ </note>
+ </taskrelated>
+ </task>
+ </section>
</chapter>
Modified:
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml
===================================================================
---
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-11-26
08:55:09 UTC (rev 8969)
+++
epp/docs/branches/6.0/Reference_Guide/en-US/modules/PortalDevelopment/DefaultPortalConfiguration.xml 2012-11-28
05:17:16 UTC (rev 8970)
@@ -33,4 +33,81 @@
<emphasis>Components</emphasis>,
<emphasis>component-plugins</emphasis>, and
<emphasis>init-params</emphasis> are explained in a later chapter of this
document.
</para>
</section>
+ <section
id="sect-Reference_Guide-Default_Portal_Configuration-Disabling_a_Portal">
+ <!--
+ This content is mirrored in the JPP 5.2 Reference Guide.
+ Any changes here should be reflected there as well.
+ -->
+ <title><remark>BZ#794416</remark>Disabling a
Portal</title>
+ <para>
+ Once you have created a custom portal that suits your needs, you may wish to
disable a portal that is no longer required.
+ </para>
+
+ <task>
+ <title>Task: Disable a portal in EPP 5</title>
+ <tasksummary>
+ <para>
+ The procedure below will show you how to disable an unused portal
in a JBoss Portal Platform instance.
+ </para>
+ </tasksummary>
+ <taskprerequisites>
+ <title>Prerequisites: </title>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <remark>Are there any pre-reqs for this
task?</remark>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </taskprerequisites>
+ <procedure>
+ <title></title>
+ <step>
+ <para>
+ Add the following configuration to the
<filename>configuration.xml</filename> of the custom extension in order to
disable a portal:
+ </para>
+<programlisting language="XML" role="XML"><![CDATA[<?xml
version="1.0" encoding="UTF-8"?>
+<configuration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://www.exoplaform.org/xml/ns/kernel_1_0.xsd
http://www.exoplaform.org/xml/ns/kernel_1_1.xsd"
+ xmlns="http://www.exoplaform.org/xml/ns/kernel_1_1.xsd">
+ <external-component-plugins>
+ <!-- The full qualified name of the PortalContainerConfig -->
+
<target-component>org.exoplatform.container.definition.PortalContainerConfig
+ </target-component>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Add PortalContainer Definitions</name>
+ <!-- (existing configuration for new portal container) -->
+ </component-plugin>
+ <component-plugin>
+ <!-- The name of the plugin -->
+ <name>Disable a PortalContainer</name>
+ <!-- The name of the method to call on the PortalContainerConfig in order
to register the changes on the PortalContainerDefinitions -->
+ <set-method>registerDisablePlugin</set-method>
+ <!-- The full qualified name of the PortalContainerDefinitionDisablePlugin
-->
+
<type>org.exoplatform.container.definition.PortalContainerDefinitionDisablePlugin</type>
+ <init-params>
+ <!-- The list of the name of the portal containers to disable -->
+ <values-param>
+ <name>names</name>
+ <value>$PORTAL_NAME</value>
+ </values-param>
+ </init-params>
+ </component-plugin>
+ </external-component-plugins>
+</configuration>
+]]></programlisting>
+ </step>
+ </procedure>
+ <taskrelated>
+ <note>
+ <title></title>
+ <para>
+ Disabling the default <emphasis>portal</emphasis>
container is possible as well, but some functions, such as WSRP, or Services Management,
depend on the default portal container to be deployed, and will no longer work if this is
disabled.
+ </para>
+ </note>
+ </taskrelated>
+ </task>
+ </section>
+
</chapter>