Author: thomas.heute(a)jboss.com
Date: 2008-06-27 12:04:10 -0400 (Fri, 27 Jun 2008)
New Revision: 11175
Modified:
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/deployportlet.xml
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/fin.xml
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/forward.xml
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/installation.xml
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/interaction.xml
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/portalterminology.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/authentication.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/clustering.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/cmsPortlet.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/contentintegration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/errorhandling.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identity.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identityportlets.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ldap.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/navtabs.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portalapi.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portletmodes.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/security.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/sso.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/themeandlayouts.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/troubleshooting.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/urls.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/widgetintegration.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/workflow.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/wsrp.xml
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml
Log:
Doc (starting to diverge from 2.6)
Modified:
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/deployportlet.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/deployportlet.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/deployportlet.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified: docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/fin.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/fin.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/fin.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified: docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/forward.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/forward.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/forward.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/installation.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/installation.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/installation.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified: docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/interaction.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/interaction.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/interaction.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/portalterminology.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/portalterminology.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/quickstartuser/en/modules/portalterminology.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,26 +3,17 @@
<chapterinfo>
<author>
<firstname>Kevin</firstname>
-
<surname>Barfield</surname>
-
- <email>kbarfiel(a)redhat.com</email>
</author>
<author>
<firstname>Chris</firstname>
-
<surname>DeLashmutt</surname>
-
- <email>cdelashm(a)redhat.com</email>
</author>
<author>
<firstname>Xi</firstname>
-
<surname>Huang</surname>
-
- <email>xhuang(a)redhat.com</email>
</author>
</chapterinfo>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml 2008-06-27 15:34:50
UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/master.xml 2008-06-27 16:04:10
UTC (rev 11175)
@@ -55,7 +55,6 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
<author>
<firstname>Boleslaw</firstname>
@@ -67,6 +66,10 @@
<surname>Laprun</surname>
<email>chris.laprun(a)jboss.com</email>
</author>
+ <author>
+ <firstname>Murray</firstname>
+ <surname>McAllister</surname>
+ </author>
</bookinfo>
<toc/>
<!-- Trademark - Trying to make all vendor legal teams happy -->
&trademarks;
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ajax.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,7 +4,6 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien.viet(a)jboss.com</email>
</author>
</chapterinfo>
<title>Ajax</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/authentication.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/authentication.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/authentication.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,7 +3,6 @@
<author>
<firstname>Boleslaw</firstname>
<surname>Dawidowicz</surname>
- <email>boleslaw dot dawidowicz at redhat dot com</email>
</author>
</chapterinfo>
<title>Authentication and Authorization</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/clustering.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/clustering.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/clustering.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,12 +4,10 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien.viet(a)jboss.com</email>
</author>
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
</chapterinfo>
<title>Clustering Configuration</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/cmsPortlet.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/cmsPortlet.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/cmsPortlet.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,12 +4,10 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy @ jboss dot org</email>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
</chapterinfo>
<title>CMS Portlet</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/configuration.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,12 +4,10 @@
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy at jboss dot org</email>
</author>
</chapterinfo>
<title>Customizing your Installation</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/contentintegration.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/contentintegration.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/contentintegration.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,8 +4,11 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien @ jboss dot com</email>
</author>
+ <author>
+ <firstname>Thomas</firstname>
+ <surname>Heute</surname>
+ </author>
</chapterinfo>
<title>Content Integration</title>
<para>Since JBoss Portal 2.6 it is possible to provide an easy integration of
content within the portal. Up to the 2.4 version
@@ -52,7 +55,7 @@
</para>
<para>At runtime when the portal needs to render a window it delegates the
production of markup to a content provider.
The portal comes with a preconfigured set of providers which handles the portlet
and the cms content types. The most
- natural way to plug a content provider in the portal is to use a JSR 168 Portlet.
Based on a few carefully chosen conventions
+ natural way to plug a content provider in the portal is to use a JSR 286 Portlet.
Based on a few carefully chosen conventions
it is possible to provide an efficient content integration with the benefit of
using standards and without requiring
the usage of a proprietary API.</para>
</sect1>
@@ -61,7 +64,7 @@
<para>Content providers must be able to allow the user or administrator to
chose content from the external resource
it integrates in the portal in order to properly configure a portal window. A few
interactions between the portal, the content
provider and the portal user are necessary to achieve that goal. Here again it is
possible to provide content
- customization using a JSR 168 Portlet. For that purpose two special portlet modes
called
+ customization using a JSR 286 Portlet. For that purpose two special portlet modes
called
<emphasis>edit_content</emphasis> and
<emphasis>select_content</emphasis> has been introduced. It signals to the
portlet
that it is selecting or editing the content portion of the state of a portlet.
<emphasis>select_content</emphasis> is
used to select a new content to put in a window while
<emphasis>edit_content</emphasis> is used to modify the previously
@@ -80,10 +83,9 @@
<sect2>
<title>Displaying content</title>
<para>At runtime the portal will call the portlet with the view mode when
it displays content. It will send
- information about the content to display using the render parameters to the
portlet. Therefore the portlet has
- just to read the render parameters and use them to properly display the content
in the portlet. The render parameters
- values are the key/value pairs that form the content properties and the resource
URI is available under the <emphasis>uri</emphasis>
- parameter name.</para>
+ information about the content to display using the public render parameter
<emphasis>urn:jboss:portal:content uri</emphasis> to the portlet. Therefore
the portlet has
+ just to read the render parameters and use them to properly display the content
in the portlet. The public render parameters
+ values are the key/value pairs that form the content properties and the resource
URI of the content to display.</para>
</sect2>
<sect2>
<title>Configuring content</title>
@@ -95,13 +97,7 @@
render parameters to the portlet and the initial set of render parameters
will be empty. The portlet can
then use render parameters in order to provide navigation in the content
repository. For example the portlet
can navigate the CMS tree and store the current CMS path in the render
parameters. Whenever the portlet has decided
- to tell the portal that content has been selected by the user it needs to
use an action URL with a special set of
- parameters:
- <itemizedlist>
-
<listitem><emphasis>content.action.select</emphasis> equals to any
value</listitem>
- <listitem><emphasis>content.uri</emphasis> equals
to the content URI</listitem>
- <listitem><emphasis>content.param.</emphasis> used
as prefix to configure content parameters</listitem>
- </itemizedlist>
+ to tell the portal that content has been selected by the user it needs to
trigger a JSR-286 event with the uri and eventual parameters as payload.
</listitem>
<listitem>The second use case happens when the portal needs to edit
existing content. In such situation
everything works as explained before except that the initial set of render
parameters of the portlet
@@ -125,9 +121,6 @@
/** The edit_content mode. */
public static final PortletMode EDIT_CONTENT_MODE = new
PortletMode("edit_content");
- /** The select_content mode. */
- public static final PortletMode SELECT_CONTENT_MODE = new
PortletMode("select_content");
-
...
}
@@ -141,8 +134,7 @@
protected void doDispatch(RenderRequest req, RenderResponse resp)
throws PortletException, PortletSecurityException, IOException
{
- if (EDIT_CONTENT_MODE.equals(req.getPortletMode()) ||
- SELECT_CONTENT_MODE.equals(req.getPortletMode()))
+ if (EDIT_CONTENT_MODE.equals(req.getPortletMode()))
{
doEditContent(req, resp);
}
@@ -226,14 +218,20 @@
protected void doEditContent(RenderRequest req, RenderResponse resp)
throws PortletException, PortletSecurityException, IOException
{
- // Get the uri value optionally provided by the portal
- String uri = req.getParameter("content.uri");
+ String uri = req.getParameter("current_uri");
+ if (uri == null)
+ {
+ // Get the uri value optionally provided by the portal
+ uri = req.getParameter("uri");
+ }
// Get the working directory directory
- File workingDir;
+ File workingDir = null;
+ String currentFileName = null;
if (uri != null)
{
workingDir = getFile(uri).getParentFile();
+ currentFileName = getFile(uri).getName();
}
else
{
@@ -289,9 +287,15 @@
File child = children[i];
if (child.isFile())
{
- selectFileURL.setParameter("content.uri", getContentURI(child));
- writer.print("<li><a href=\"" + selectFileURL +
"\">" + child.getName() +
- "</a></li>");
+ selectFileURL.setParameter("current_uri", getContentURI(child));
+ if (child.getName().equals(currentFileName))
+ {
+ writer.print("<li><b>" + child.getName() +
"</b></li>");
+ }
+ else
+ {
+ writer.print("<li><a href=\"" + selectFileURL +
"\">" + child.getName() + "</a></li>");
+ }
}
}
writer.print("</ul><br/>");
@@ -364,31 +368,47 @@
<emphasis>portlet-instances.xml</emphasis> will create a single
instance of our portlet. The
<emphasis>web.xml</emphasis> descriptor will contain a servlet
context listener that will hook the content
type in the portal content type registry.</para>
+ <para>First, we need to define the portlet's particular event and
render parameters:</para>
<programlisting><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
-<portlet-app
-
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
-
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_1...
-
http://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
- version="1.0">
- ...
+<portlet-app
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+ version="2.0">
+
<portlet>
<description>File System Content Driven Portlet</description>
<portlet-name>FSContentDrivenPortlet</portlet-name>
<display-name>File System Content Driven Portlet</display-name>
-
<portlet-class>org.jboss.portal.core.portlet.test.FSContentDrivenPortlet</portlet-class>
+
<portlet-class>org.jboss.portal.core.samples.basic.FSContentDrivenPortlet</portlet-class>
<supports>
<mime-type>text/html</mime-type>
+ <portlet-mode>VIEW</portlet-mode>
+ <portlet-mode>EDIT_CONTENT</portlet-mode>
</supports>
<portlet-info>
<title>File Portlet</title>
<keywords>sample,test</keywords>
</portlet-info>
+
<supported-public-render-parameter>uri</supported-public-render-parameter>
+ <supported-publishing-event
xmlns:x="urn:jboss:portal:content">x:select</supported-publishing-event>
</portlet>
- ...
+
+ <public-render-parameter>
+ <identifier>uri</identifier>
+ <qname xmlns:c="urn:jboss:portal:content">c:uri</qname>
+ </public-render-parameter>
+
+ <event-definition>
+ <qname xmlns:x="urn:jboss:portal:content">x:select</qname>
+ <value-type>java.lang.String</value-type>
+ </event-definition>
+
</portlet-app>
]]></programlisting>
+ <para>Note that here we need to use a JSR-286 portlet, this portlet
will use the event <emphasis>urn:jboss:portal:content select</emphasis> and
have a payload of type
+ <emphasis>java.lang.String</emphasis>. This event will be used to
tell the portal the URI selected by the user. This same portlet will also be in charge of
+ rendering the content based on that URI, it will then also need to access the
public render parameter qualified with the name: <emphasis>urn:jboss:portal:content
uri</emphasis>.
<para>The portlet.xml descriptor</para>
<programlisting><![CDATA[
<deployments>
@@ -425,6 +445,16 @@
it will always be available.</warning>
</sect3>
</sect2>
+ <!--
+ <sect2>
+ <title>Passing parameters along the URI</title>
+ <para>In simple cases like in the example, it was enough to pass a URI, in
some cases it can be helpful to pass
+ other parameters, to do so, instead of having a payload of type
<emphasis>java.lang.String</emphasis>,
+ simply use the following class:
<emphasis>org.jboss.portal.api.content.SelectedContent</emphasis>.
+ </para>
+ </para>
+ </sect2>
+ -->
</sect1>
<sect1>
<title>Configuring window content in deployment descriptor</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/errorhandling.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/errorhandling.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/errorhandling.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,7 +4,6 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien.viet(a)jboss.com</email>
</author>
</chapterinfo>
<title>Error Handling Configuration</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identity.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identity.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identity.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,7 +3,6 @@
<author>
<firstname>Boleslaw</firstname>
<surname>Dawidowicz</surname>
- <email>boleslaw dot dawidowicz at redhat dot com</email>
</author>
</chapterinfo>
<title>JBoss Portal Identity Management</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identityportlets.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identityportlets.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/identityportlets.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,7 +3,6 @@
<author>
<firstname>Emanuel</firstname>
<surname>Muckenhuber</surname>
- <email>emuckenh(a)redhat.com</email>
</author>
</chapterinfo>
<title>JBoss Portal Identity Portlets</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ldap.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ldap.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/ldap.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,7 +3,6 @@
<author>
<firstname>Boleslaw</firstname>
<surname>Dawidowicz</surname>
- <email>boleslaw dot dawidowicz at redhat dot com</email>
</author>
</chapterinfo>
<title>LDAP</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/migration.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -1,17 +1,11 @@
<chapter id="changelog">
<chapterinfo>
<author>
- <firstname>Roy</firstname>
- <surname>Russo</surname>
- <email>roy at jboss dot org</email>
+ <firstname>Thomas</firstname>
+ <surname>Heute</surname>
</author>
- <author>
- <firstname>Boleslaw</firstname>
- <surname>Dawidowicz</surname>
- <email>boleslaw dot dawidowicz at redhat dot com</email>
- </author>
</chapterinfo>
- <title>Upgrading JBoss Portal 2.4 to 2.6</title>
+ <title>Upgrading JBoss Portal 2.6 to 2.7</title>
<para>
<warning>
<para>
@@ -19,1256 +13,50 @@
</para>
</warning>
</para>
- <sect1 id="manual_migration">
- <title>Manual Upgrade</title>
- <para>
- The database schema has not changed since JBoss Portal 2.4; however, there are
several differences when using a database created by JBoss Portal 2.4, that prevent simply
deploying the latest version of JBoss Portal. For example, some portlets are no longer
present in JBoss Portal 2.6, and certain existing portlets are now packaged differently.
This chapter describes updating a MySQL database created by JBoss Portal 2.4, for use with
JBoss Portal 2.6.
+ <para>
+ JBoss Portal 2.7 compatibility with JBoss Portal 2.6 is very high. The main
differences are the use of JSR-286 features to replace
+ JBoss Portal specific features. The database schema hasn't changed.
+ </para>
+
+ <sect1 id="manual_migration">
+ <title>Usage of JBossActionRequest</title>
+ <para>Usage of JBossActionRequest is not available directly anymore. From now
on it is only accessible if the
+ <emphasis>org.jboss.portlet.filter.JBossPortletFilter</emphasis> is
applied on the portlet.
+ To do so, first you will need to change the
<emphasis>portlet.xml</emphasis> descriptor in order to declare
+ the new portlet as a JSR-286 portlet so that the filter can be applied. For a portlet
named <emphasis>MyFooPortlet</emphasis>
+ it would now look like this:
</para>
- <para>
- Users, roles, and pages created in JBoss Portal 2.4 should be accessible in JBoss
Portal 2.6 deployments.
+<programlisting><![CDATA[
+<portlet-app
+
xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2...
http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
+ version="2.0">
+
+ <filter>
+ <filter-name>JBoss Portlet Filter</filter-name>
+
<filter-class>org.jboss.portlet.filter.JBossPortletFilter</filter-class>
+ <lifecycle>ACTION_PHASE</lifecycle>
+ <lifecycle>RENDER_PHASE</lifecycle>
+ </filter>
+
+ <filter-mapping>
+ <filter-name>JBoss Portlet Filter</filter-name>
+ <portlet-name>MyFooPortlet</portlet-name>
+ </filter-mapping>
+
+
+ <portlet>
+ <description>My foo portlet</description>
+ <portlet-name>MyFooPortlet</portlet-name>
+ ...
+ </portlet>
+</portlet-app>
+
+]]></programlisting>
+ <para>By not adding this filter on a portlet using
JBossActionRequest/JBossActionResponse, an error message such as:
+ <emphasis>The request isn't a JBossRenderRequest, you probably need to
activate the JBoss Portlet Filter: org.jboss.portlet.filter.JBossPortletFilter on
MyFooPortlet</emphasis>
</para>
- <para>
- The upgrade procedure can be straightforward:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- If you are using the JBoss Portal binary, remove the
<filename>$JBOSS_HOME/server/default/deploy/jboss-portal.sar/</filename>
directory. If JBoss Portal was built from source, remove the
<filename>$JBOSS_HOME/server/default/deploy/jboss-portal.sar</filename> file.
- </para>
- </listitem>
- <!--<listitem>
- Remove <emphasis
role="bold">$JBOSS_HOME/server/default/data</emphasis> directory.
- </listitem>-->
- <listitem>
- <para>
- Update the data in the JBoss Portal database, as described in <xref
linkend="upgrade_portal_database"/>.
- </para>
- </listitem>
- <listitem>
- <para>
- Deploy JBoss Portal 2.6.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <sect2>
- <title>Themes</title>
- <para>
- In JBoss Portal 2.6, portal pages contain additional areas, such as the
<guiicon>Login</guiicon>, <guiicon>Admin</guiicon>, and
<guiicon>Dashboard</guiicon> links, on the top right-hand corner of portal
pages:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/theme.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- Since portal pages now contain additional areas, certain themes have changed. If a
default theme that exists in JBoss Portal 2.6 is used, such as renaissance, no
configuration should be necessary. Using old themes from JBoss Portal 2.4 may make JBoss
Portal 2.6 unusable, for example, not being able to log in. To update custom themes, refer
to the bundled JBoss Portal 2.6 themes as an example.
- </para>
- </sect2>
- <sect2 id="upgrade_portal_database">
- <title>Updating the Database</title>
- <para>
- The following tables contain all references to portlets:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis>JBP_INSTANCE</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>JBP_WINDOW</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>JBP_OBJECT_NODE</emphasis>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- All procedures described in the following sections can performed using the JBoss
Portal 2.4 <guiicon>Admin</guiicon> portlet. Treat these directions as
guidelines when migrating a large JBoss Portal deployment. Database data can be updated
manually using the correct tools for your RDBMS. For example, if you are using a MySQL
database, you can use the <ulink
url="http://www.mysql.com/products/tools/query-browser/">MySQL Query
Browser</ulink>.
- </para>
- <para>
- During the upgrade process, legacy references have to be cleaned up, to either
remove them, or to allow JBoss Portal 2.6 to recreate them correctly. Remove all
references (instances and windows) to the portlets listed below, as they are not present
in JBoss Portal 2.6. This can be done using the JBoss Portal 2.4
<guiicon>Admin</guiicon> portlet:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis>HeaderContentPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>URLPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>TestPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>PortletA</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>PortletB</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>SecuredTestPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>CharsetPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>CounterPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>CachedCounterPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>ExceptionPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>PortletSessionPortlet</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>EncodingPortlet</emphasis>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- The following instructions refer to a standard JBoss Portal 2.4 deployment. If core
portlets, portlet instances, or portlet windows were renamed, make the appropriate
modifications. The following is an example of the MySQL Query Browser:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/querybrowser1.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- <note>
- <title>Requested Resource Error</title>
- <para>
- When running JBoss Portal 2.6 with a database created by JBoss Portal 2.4, a
non-existing portlet will try to be displayed, resulting in a
<computeroutput>404</computeroutput>, <computeroutput>The requested
resource() is not available</computeroutput> error.
- </para>
- </note>
- </para>
- </sect2>
- <sect2>
- <title>Portlet Names</title>
- <para>
- Names of certain core bundled-portlets have changed. Destroy the following
instances and use the <guiicon>Admin</guiicon> portlet to recreate them, or
edit the <emphasis role="bold">JBP_INSTANCE</emphasis> table as
follows:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- Change <emphasis>local.samples.JSPPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-jsp-samples.JSPPortlet</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Change <emphasis>local.portal.CMSPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-cms.CMSPortlet</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Change <emphasis>local.portal.CMSAdminPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-cms.CMSAdminPortlet</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Change <emphasis>local.portal.ManagementPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-admin.AdminPortlet</emphasis>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- Some portlets are no longer present in JBoss Portal 2.6, and certain existing
portlets are now packaged differently. Remove the following entries in the <emphasis
role="bold">JBP_INSTANCE</emphasis> table, so that JBoss Portal 2.6 can
recreate them:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- rows containing <emphasis>NewsPortletInstance2</emphasis> in the
<emphasis>ID</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.portal.NavigationPortlet</emphasis>
in the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing
<emphasis>local.samples.HeaderContentPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.WeatherPortlet</emphasis> in
the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.NewsPortlet</emphasis> in
the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.URLPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.TestPortlet</emphasis> in
the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.PortletA</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.PortletB</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing
<emphasis>local.samples.SecuredTestPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.CharsetPortlet</emphasis> in
the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.CounterPortlet</emphasis> in
the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing
<emphasis>local.samples.CachedCounterPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.ExceptionPortlet</emphasis>
in the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing
<emphasis>local.samples.PortletSessionPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>local.samples.EncodingPortlet</emphasis>
in the <emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- Remove the following entries in the <emphasis
role="bold">JBP_WINDOW</emphasis> table, so that JBoss Portal 2.6 can
recreate them:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- rows containing <emphasis>NavigationPortletInstance</emphasis> in
the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>URLPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletAInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletBInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>EncodingPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletSessionPortletInstance</emphasis>
in the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CachedCounterPortletInstance</emphasis> in
the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CounterPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CharsetPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>SecuredTestPortletInstance</emphasis> in
the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>SecuredTestPortletInstance</emphasis> in
the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>ExceptionPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>HeaderContentPortletInstance</emphasis> in
the <emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>TestPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>MissingPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- Remove the following entries in the <emphasis
role="bold">JBP_OBJECT_NODE</emphasis> table, so that JBoss Portal 2.6
can recreate them:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- rows containing <emphasis>NavigationPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>URLPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletAWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletBWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>MissingInstanceWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>EncodingPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>PortletSessionPortletWindow</emphasis> in
the <emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CachedCounterPortletWindow</emphasis> in
the <emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CounterPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>CharsetPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>SecuredTestPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>ExceptionPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>MissingPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>HeaderContentPortletWindow</emphasis> in
the <emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- rows containing <emphasis>TestPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </sect2>
- <sect2>
- <title>CMS</title>
- <para>
- In JBoss Portal 2.6 versions, the way the CMS content is displayed changed
significantly. For further information, refer to <xref
linkend="contentintegration"/> and <xref
linkend="cmsPortlet"/>. Currently there is no need to have more than one
instance of the <emphasis>CMSPortlet</emphasis>. The portlet window displays
CMS content, not by referring to that portlet instance, but by having the proper
<emphasis>content-type</emphasis> defined. The following configuration is in
the <filename>jboss-portal.sar/conf/data/default-object.xml</filename> file:
- </para>
- <para>
-<screen><![CDATA[
-<window>
- <window-name>CMSWindow</window-name>
- <content>
- <content-type>cms</content-type>
- <content-uri>/default/index.html</content-uri>
- </content>
- <region>center</region>
- <height>1</height>
-</window>]]>
-</screen>
- </para>
- <para>
- The following example uses the MySQL Query Browser. Open the <emphasis
role="bold">JBP_OBJECT_NODE</emphasis> table in your database schema.
Look at the <emphasis role="bold">PATH</emphasis> column to identify
any occurrences of <emphasis>CMS</emphasis> in your JBoss Portal deployment.
Identify any row referring to <emphasis>CMSPortletWindow</emphasis>, and
remember the number in the <emphasis role="bold">PK</emphasis>
column. The <emphasis role="bold">PK</emphasis> number is needed in
the following steps:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/querybrowser2.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- Go to the <emphasis role="bold">JBP_WINDOW</emphasis> table
and find a row with the same
- <emphasis role="bold">PK</emphasis> value from the
<emphasis role="bold">JBP_OBJECT_NODE</emphasis> table. In such a
row, replace <emphasis>CMSPortletInstance</emphasis> with a path to your CMS
resource. For example, by default, JBoss Portal displays
<filename>/default/index.html</filename>.
- </para>
- <para>
- Add a row containing the following to the <emphasis
role="bold">JBP_PORTAL_OBJECT_PROPS</emphasis> table:
- </para>
- <para>
- <itemizedlist>
- <listitem>
- <para>
- The <emphasis role="bold">PK</emphasis> number
remembered from the <emphasis>OBJECT_KEY</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>portal.windowContentType</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>cms</emphasis> in the
<emphasis>jbp_VALUE</emphasis> column.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- As well, the CMS can be migrated by backing up the
<computeroutput>jbp_cms_*</computeroutput> tables, and recreating them in a
JBoss Portal 2.6 database. There were no schema changes for the CMS between JBoss Portal
2.4 and JBoss Portal 2.6.
- </para>
- <para>
- <note>
- <title>Portlet Content-type and the path to the CMS
Resource</title>
- <para>
- The <guiicon>Admin</guiicon> portlet can be used to change the
portlet window content-type, and configure the path to the CMS resource.
- </para>
- </note>
- </para>
- </sect2>
-</sect1>
- <!--<sect1 id="manual_migration">
- <title>Manual Upgrade</title>
- <para>
- Although the database schema remains the same in JBoss Portal 2.6, there are
several differences that prevent simply deploying the latest version of JBoss Portal, when
using a database created for JBoss Portal 2.4. This chapter describes updating a JBoss
Portal 2.4 MySQL database for use with JBoss Portal 2.6.
- </para>
- <para>
- The upgrade procedure can be straightforward:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- If you are using the JBoss Portal binary, remove the
<filename>$JBOSS_HOME/server/default/deploy/jboss-portal.sar/</filename>
directory. If JBoss Portal was built from source, remove the
<filename>$JBOSS_HOME/server/default/deploy/jboss-portal.sar</filename> file.
- </para>
- </listitem> -->
- <!--<listitem>
- Remove <emphasis
role="bold">$JBOSS_HOME/server/default/data</emphasis> directory.
- </listitem>-->
- <!-- <listitem>
- <para>
- Update the data in the JBoss Portal database, as described in <xref
linkend="upgrade_portal_database"/>.
- </para>
- </listitem>
- <listitem>
- <para>
- Deploy JBoss Portal 2.6.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <sect2>
- <title>Themes</title>
- <para>
- Themes in JBoss Portal 2.6 have changed since the Portal pages now contain additional
areas, such as the <guiicon>Login</guiicon>,
<guiicon>Admin</guiicon>, and <guiicon>Dashboard</guiicon> links,
on the top right-hand corner:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/theme.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- If you use a default theme that exists in JBoss Portal 2.6, such as renaissance, no
configuration should be necessary. Using old themes from JBoss Portal 2.4 may make JBoss
Portal 2.6 unusable, for example, not being able to log in. To update custom themes,
please refer to those bundled with JBoss Portal as an example.
- </para>
- </sect2>
- <sect2 id="upgrade_portal_database">
- <title>Updating the Database</title>
- <para>
- All procedures described in the following sections can performed using the
AdminPortlet. Treat the directions as guidelines if you need to automate the migration of
a large JBoss Portal deployment.
- </para>
- <para>
- Database schema has not changed between the JBoss Portal 2.4 and 2.6 releases, but
certain content that is kept in the databases has changed. Data can be updated manually by
using the correct tools for your RDBMS. For example, if you are using a MySQL database,
you can use the <ulink
url="http://www.mysql.com/products/tools/query-browser/">MySQL Query
Browser</ulink>.
- </para>
- <para>
- The following instructions refer to a standard JBoss Portal 2.4 deployment. If you
named core portlets, portlet instances, or portlet windows differently, you need to make
the appropriate modifications. The following is an example of using the MySQL Query
Browser:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/querybrowser1.png"/>
- </imageobject>
- </mediaobject>
- </para>
-</sect2>
- <sect2>
- <title>Portlet Names</title>
- <para>
- Names of certain core bundled portlets have changed. Destroy the following
instances and use the AdminPortlet to recreate them, or, edit the <emphasis
role="bold">JBP_INSTANCE</emphasis> table as follows:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- Change <emphasis>local.portal.CMSPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-cms.CMSPortlet</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Change <emphasis>local.portal.CMSAdminPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-cms.CMSAdminPortlet</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
- Change <emphasis>local.portal.ManagementPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column to
<emphasis>local./portal-admin.AdminPortlet</emphasis>.
- </para>
- </listitem>
- </orderedlist>
- </para>
- <para>
- The <emphasis>NavigationPortlet</emphasis> from JBoss Portal 2.4 has
been removed, and its functionality is now replaced by
<emphasis>PageCustomizerInterceptor</emphasis>. Remove all references to the
<emphasis>NavigationPortlet</emphasis> from all portal pages. Remove
<emphasis>NavigationPortletInstance</emphasis> using the AdminPortlet, or edit
the database as follows:
- </para>
- <para>
- <orderedlist>
- <listitem>
- <para>
- In the <emphasis>JBP_INSTANCE</emphasis> table, rows containing
<emphasis>local.portal.NavigationPortlet</emphasis> in the
<emphasis>PORTLET_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- In the <emphasis>JBP_WINDOW</emphasis> table, rows containing
<emphasis>NavigationPortletInstance</emphasis> in the
<emphasis>INSTANCE_REF</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- In the <emphasis>JBP_OBJECT</emphasis> table, rows containing
<emphasis>NavigationPortletWindow</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </sect2>
- <sect2>
- <title>CMS</title>
- <para>
- In JBoss Portal 2.6 versions, the way the CMS content is displayed changed
significantly. For further information, please refer to <xref
linkend="contentintegration"/> and <xref
linkend="cmsPortlet"/>. Currently there is no need to have more than one
instance of the <emphasis>CMSPortlet</emphasis>. The portlet window displays
CMS content, not by referring to that portlet instance, but by having the proper
<emphasis>content-type</emphasis> defined. The following configuration is in
the <filename>jboss-portal.sar/conf/data/default-object.xml</filename> file:
- </para>
- <para>
-<screen><![CDATA[
-<window>
- <window-name>CMSWindow</window-name>
- <content>
- <content-type>cms</content-type>
- <content-uri>/default/index.html</content-uri>
- </content>
- <region>center</region>
- <height>0</height>
-</window>]]>
-</screen>
-</para>
- <para>
- The following example uses the MySQL Query Browser. Open the <emphasis
role="bold">JBP_OBJECT_NODE</emphasis> table in your database schema.
Look at the <emphasis role="bold">PATH</emphasis> column to identify
any occurrences of CMS in your JBoss Portal deployment. Identify any row referring to
<emphasis>CMSPortletWindow</emphasis>, and remember the number in <emphasis
role="bold">PK</emphasis> column. The <emphasis
role="bold">PK</emphasis> number is needed in the following steps:
- </para>
- <para>
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/querybrowser2.png"/>
- </imageobject>
- </mediaobject>
- </para>
- <para>
- Go to the <emphasis role="bold">JBP_WINDOW</emphasis> table
and find a row with the same
- <emphasis role="bold">PK</emphasis> value from the
<emphasis role="bold">JBP_OBJECT_NODE</emphasis> table. In such a
row, replace <emphasis>CMSPortletInstance</emphasis> with a path to your CMS
resource. For example, by default, JBoss Portal displays
<filename>/default/index.html</filename>.
- </para>
- <para> Go to the <emphasis
role="bold">JBP_PORTAL_OBJECT_PROPS</emphasis> table and add a row
containing:
- <itemizedlist>
- <listitem>
- <para>
- The <emphasis role="bold">PK</emphasis> number remembered
from the <emphasis>OBJECT_KEY</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>portal.windowContentType</emphasis> in the
<emphasis>NAME</emphasis> column.
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis>cms</emphasis> in the
<emphasis>jbp_VALUE</emphasis> column.
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- <note>
- <title>Portlet Content Type and Path to the CMS Resource</title>
- <para>
- You can change the portlet window content type and configure the path to the CMS
resource
- using the AdminPortlet.
- </para>
- </note>
- </para>
- </sect2>
-</sect1> -->
- <!--
- <para>This chapter addresses migration issues from version 2.2 to 2.4 of JBoss
Portal.</para>
- <sect1 id="migrating_database">
- <title>Migrating the Database</title>
- <para>JBoss Portal 2.4 comes with dedicated web application for database
migration.
- This application will migrate your existing JBoss Portal 2.2 database data to a
new one, for use with JBoss
- Portal 2.4.
- </para>
- <warning>This migration process should be performed
- <emphasis role="bold">before</emphasis>
- JBoss Portal 2.4 deployment.
- <emphasis role="bold">Follow the exact steps below, in order, or
ugly scary things may happen!</emphasis>
- </warning>
- <sect2 id="migration_preparations">
- <title>Database Requirements/Preparation</title>
- <para>You will need two database instances for this migration process to
function:</para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">Source JBP 2.2
database</emphasis>
- from which we migrate portal data. (You should already have this!)
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Destination JBP 2.4
database</emphasis>
- to which we migrate portal data.
- </para>
- </listitem>
- </itemizedlist>
- <para>Before you begin the process you must create a separate database to
which the data
- will be migrated. Note that the Migration Application performs a Hibernate
SchemaExport which
- drops and recreates tables - It is recommended that you backup your database
before starting!</para>
- <para>For our example, we have two databases... the existing one for JBoss
Portal 2.2, and the new (empty) one
- for JBoss Portal 2.4:
- <itemizedlist>
- <listitem>
- <para>
- JBoss Portal 2.2 DB:
- <emphasis
role="bold">jbossportal22</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- JBoss Portal 2.4 DB:
- <emphasis
role="bold">jbossportal24</emphasis>
- </para>
- </listitem>
- </itemizedlist>
- We will use the above database naming, as examples in the next chapter on
configuring the datasource.
- </para>
- </sect2>
- <sect2 id="datasource_prepare">
- <title>DataSource Requirements/Preparation</title>
- <para>The Migration Application will need access to both databases, while
its running. For this reason, we need
- to make available both JBoss Application Server datasource
files.</para>
- <orderedlist>
- <listitem>
- <para>You should have an existing JBoss Portal 2.2 datasource,
- <emphasis role="bold">portal-ds.xml</emphasis>
- or
- <emphasis role="bold">portal-*-ds.xml</emphasis>
- file that looks like this:
- </para>
- <programlisting>
- <![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <datasources>
- <local-tx-datasource>
- <jndi-name>PortalDS</jndi-name>
-
<connection-url>jdbc:mysql://localhost:3306/jbossportal22?useServerPrepStmts=false</connection-url>
- <driver-class>org.gjt.mm.mysql.Driver</driver-class>
- <user-name>portal</user-name>
- <password>portalpassword</password>
- </local-tx-datasource>
- </datasources>
- ]]>
- </programlisting>
- </listitem>
- <listitem>
- <para>Now, you will need to create a second datasource for the
destination database. In our example we
- will create,
- <emphasis
role="bold">portal-migration-ds.xml</emphasis>
- file that looks like this:
- </para>
- <programlisting>
- <![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <datasources>
- <local-tx-datasource>
- <jndi-name>PortalDS_2_4</jndi-name>
-
<connection-url>jdbc:mysql://localhost:3306/jbossportal24?useServerPrepStmts=false</connection-url>
- <driver-class>org.gjt.mm.mysql.Driver</driver-class>
- <user-name>portal</user-name>
- <password>portalpassword</password>
- </local-tx-datasource>
- </datasources>
- ]]>
- </programlisting>
- </listitem>
- </orderedlist>
- </sect2>
- <sect2 id="getting_tool">
- <title>Obtaining the Migration Application</title>
- <para>The JBoss Portal Migration Application can be obtained either as a
ready to deploy web application or in source form.</para>
- <sect3 id="getting_app_binary">
- <title>Downloading binary</title>
- <para>You can find a prepared binary at:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink
url="http://labs.jboss.com/portal/jbossportal/download">Down...
- section of JBoss Portal project page
- </para>
- </listitem>
- </itemizedlist>
- </sect3>
- <sect3 id="getting_app_source">
- <title>Building from source</title>
- <para>You can obtain portal sources from either:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink
url="http://labs.jboss.com/portal/jbossportal/download/">Dow...
- section of JBoss Portal project page
- </para>
- </listitem>
- <listitem>
- <para>
- CVS by running following command:
- </para>
- <programlisting>
- <![CDATA[
- cvs -d :pserver:anonymous@anoncvs.forge.jboss.com:/cvsroot/jboss
co jboss-portal-2.4
- ]]>
- </programlisting>
- </listitem>
- </itemizedlist>
- <para>Using the second method you will always have all latest updates
from portal 2.4 cvs branch</para>
- <para>After downloading the sources you need to build the Migration
Application. Before you start be sure
- you have
- <emphasis role="bold">JBOSS_HOME</emphasis>
- environment variable set pointing
- to JBoss Application Server directory. Migration Application archive can
be build using following
- commands:
- </para>
- <programlisting>
- <![CDATA[
- cd jboss-portal-2.4
- cd build
- ./build.sh
- cd ..
- cd migration
- ./build.sh
- ]]>
- </programlisting>
- <para>Deployable web application archive can be found at
- <emphasis
role="bold">jboss-portal-2.4/migration/output/lib/portal-migration.war</emphasis>
- </para>
- <para>You can also deploy it automatically by executing:</para>
- <programlisting>
- <![CDATA[
- cd jboss-portal-2.4
- cd migration
- ./build.sh deploy
- ]]>
- </programlisting>
- </sect3>
- </sect2>
- <sect2 id="deploying_migration">
- <title>Deploying the Migration Application</title>
- <para>
- The steps below will guide you through deploying and running the migration
application:
- <orderedlist>
- <listitem>
- <para>Shut down JBoss Application Server</para>
- </listitem>
- <listitem>
- <para>Undeploy/Remove JBoss Portal 2.2
(JBOSS_HOME/server/default/deploy/jboss-portal.sar)</para>
- </listitem>
- <listitem>
- <para>Delete
-
<emphasis>JBOSS_HOME/server/default/data/portal/cms</emphasis>
- (This directory will be created for you, once again, when JBoss
Portal 2.4 initializes.
- </para>
- </listitem>
- <listitem>
- <para>Deploy the
- <emphasis role="bold">two</emphasis>
- necessary datasource descriptors, from
- <xref linkend="datasource_prepare"/> to
JBOSS_HOME/server/default/deploy/*
- </para>
- </listitem>
- <listitem>
- <para>Deploy the Migration Application, you obtained from
- <xref linkend="getting_tool"/> to
JBOSS_HOME/server/default/deploy/portal-migration.war
- </para>
- </listitem>
- <listitem>
- <para>Start JBoss Application Server</para>
- </listitem>
- </orderedlist>
- </para>
- </sect2>
- <sect2 id="running_migration">
- <title>Running the Migration Application</title>
- <orderedlist>
- <listitem>
- <para>After deploying Migration Application you can access it at
- <ulink
url="http://localhost:8080/portal-migration">http://localhost:8080/portal-migration</ulink>
- . It is
- password protected so you need to specify:
- <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">User:</emphasis>
- admin
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis
role="bold">Password:</emphasis>
- simplePassword
- </para>
- </listitem>
- </itemizedlist>
- <note>The Password can be changed in
- <emphasis
role="bold">portal-migration.war/WEB-INF/classes/users.properties</emphasis>
- file. Remember to always change the password to a less trivial one,
or undeploy the war file after
- the
- migration
- process.
- </note>
- </para>
- </listitem>
- <listitem>
- <para>If you logged in successfully you should access this page:
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_3.jpg"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>At
- <emphasis role="bold">Step 2: 2.4 Database Connectivity
Check</emphasis>
- you need to provide datasouce name
- that points to JBoss Portal 2.4 database (the destination one)
-
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_4.jpg"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Step 3: Create
Tables</emphasis>
-
- <mediaobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_5.jpg"/>
- </imageobject>
- </mediaobject>
- </para>
- </listitem>
- <listitem>
- <para>If both connections were valid and database schema was created
successfully you can
- follow with the migration process. It is separated into following
parts:
- <itemizedlist>
- <listitem>
- <para>
- <emphasis role="bold">CMS Data
Migration</emphasis>
- - migrates portal CMS tables content
-
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/migration/migration_app_6.jpg"/>
- </imageobject>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">User/Role Data
Migrate</emphasis>
- - migrates portal user, roles and
- relations beetween them
-
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/migration/migration_app_7.jpg"/>
- </imageobject>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Portal Object Data
Migrate</emphasis>
- - migrates
- whole portal objects structure. This means nodes like portals,
pages and windows.
-
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/migration/migration_app_8.jpg"/>
- </imageobject>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Portal Portlet Instance
Data Migrate</emphasis>
- - migrates
- all portlet instances presented in portal. For each portlet
instance its preferences are also
- persisted. Next, all already migrated users are iterated and
user preferences related to
- portlet
- instance are migrated
-
- <imageobject>
- <imagedata align="center"
valign="middle" fileref="images/migration/migration_app_9.jpg"/>
- </imageobject>
- </para>
- </listitem>
- <listitem>
- <para>
- <emphasis role="bold">Portal Security Data
Migrate</emphasis>
- - migrates security data for portal
- objects and portlet instances.
-
- <imageobject>
- <imagedata align="center"
valign="middle"
-
fileref="images/migration/migration_app_10.jpg"/>
- </imageobject>
- </para>
- </listitem>
- </itemizedlist>
- </para>
- <para>Which should lead to a successful end :)
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_11.jpg"/>
- </imageobject>
- </para>
- </listitem>
- </orderedlist>
- <para>
- <note>If any error occured during the migration process you will be
provided
- with specific information and asked to retry that step
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_9-fail.jpg"/>
- </imageobject>
- <imageobject>
- <imagedata align="center" valign="middle"
fileref="images/migration/migration_app_10-fail.jpg"/>
- </imageobject>
- Always check the Application Server console output or logs after migration
to track possible
- errors.
- </note>
- </para>
- </sect2>
- <sect2 id="migration_final">
- <title>Final steps</title>
- <para>After running the Migration Application you need to perform some
additional steps to
- finish the process:</para>
- <orderedlist>
- <listitem>
- <para>Shutdown JBoss Application Server</para>
- </listitem>
- <listitem>
- <para>
- Undeploy JBoss Portal 2.2 (jboss-portal.sar)
- </para>
- </listitem>
- <listitem>
- <para>Undeploy the JBoss Portal 2.2 datasource
descriptor</para>
- </listitem>
- <listitem>
- <para>Delete
-
<emphasis>JBOSS_HOME/server/default/data/portal/cms</emphasis>
- (This directory will be created for you, once again, when JBoss Portal
2.4 initializes.
- </para>
- </listitem>
- <listitem>
- <para>
- Edit your 2.4 datasource file and modify the jndi name:
- <emphasis role="bold">
- <![CDATA[<jndi-name>PortalDS</jndi-name>]]>
- </emphasis>
- </para>
- </listitem>
- <listitem>
- <para>
- Deploy JBoss Portal 2.4.
- </para>
- </listitem>
- <listitem>
- <para>Start JBoss Application Server</para>
- </listitem>
- </orderedlist>
- </sect2>
- </sect1>
- <sect1 id="descriptors_migration">
- <title>Migrating Portlet Descriptors</title>
- <para>Since 2.2 version of JBoss Portal data from portlet descriptor files
are persisted
- in database. There is special
- <emphasis
role="boled"><![CDATA[<if-exists/>]]></emphasis>
- tag
- that describes what should portal do when he process descriptor and found data
for such portlet
- application already in database. Therefore after database migration portal will
use persisted data.
- </para>
- <para>There are some differences beetween 2.2 and 2.4 descriptors.
- <emphasis role="bold">portlet-instances.xml</emphasis>
- file was reintroduced
- because of WSRP implementation caused portal architecture changes. Altough to
avoid confusion
- legacy descriptors support was implemented in 2.4 so all 2.2 compiliant
portlets
- should work out of box.
- </para>
- <para>Even if your 2.2 portlets deployed successfully in 2.4 you should
update their
- descriptors. Legacy descriptors support will expire in 2.6 and you will need to
use new format
- to achive more complex targets.</para>
- <sect2 id="car_demo_example">
- <title>Car Demo Portlet example</title>
- <para>Let's show descriptor changes using
- <emphasis role="bold">Car Demo</emphasis>
- portlet example which is a presentation of JSF portlet. It can be obtained
at
- <ulink
url="http://www.portletswap.com">PortletSwap</ulink>
- . In 2.2 prepared version it has such descriptor:
- </para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis
role="bold">cardemo-object.xml</emphasis>
- </para>
- <programlisting>
- <![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <deployments>
- <deployment>
- <if-exists>overwrite</if-exists>
- <parent-ref>default</parent-ref>
- <page>
- <page-name>samples</page-name>
- <window>
- <window-name>CarDemoWindow</window-name>
-
<instance-ref>CarDemoPortletInstance</instance-ref>
- <region>center</region>
- <height>0</height>
- </window>
- </page>
- </deployment>
- <deployment>
- <if-exists>overwrite</if-exists>
- <instance>
-
<instance-name>CarDemoPortletInstance</instance-name>
-
<component-ref>cardemo.CarDemoPortlet</component-ref>
- </instance>
- </deployment>
- </deployments>
- ]]>
- </programlisting>
- </listitem>
- </itemizedlist>
- <para>Note that as we said before you can successfully deploy it on JBoss
Portal 2.4. But because
- such descriptor format is 2.2 specific you will end with a warning on JBoss
Application Server console
- output:</para>
- <programlisting>
- <![CDATA[
- INFO [PortletAppDeployment] These instances have been found in -object.xml,
you should put them in the file
-
c:\jboss-4.0.4.GA\server\default\.\deploy\cardemo.war\WEB-INF/portlet-instances.xml
- INFO [PortletAppDeployment] <?xml version="1.0"
encoding="utf-8" standalone="yes"?>
- <deployments>
- <deployment>
- <instance>
- <instance-id>CarDemoPortletInstance</instance-id>
- <portlet-ref>CarDemoPortlet</portlet-ref>
- </instance>
- </deployment>
- </deployments>
- ]]>
- </programlisting>
- <para>So all you need to do is to follow suggestion you got in the warning
message :)</para>
- </sect2>
- <sect2 id="car_demo_update">
- <title>Updating Car Demo Portlet descriptors</title>
- <para>To have descriptors in our example portlet 2.4 valid you need to
follow few simple steps:</para>
- <itemizedlist>
- <listitem>
- <para>In
- <emphasis
role="bold">cardemo-object.xml</emphasis>
- file comment out whole
- <emphasis
role="bold"><![CDATA[<deployment>...</deployment>]]></emphasis>
- tag which contains
- <emphasis
role="bold"><![CDATA[<instance>...</instance>]]></emphasis>
- .
- </para>
- </listitem>
- <listitem>
- <para>Copy the text you just commented out and put it in newly
created
- <emphasis
role="bold">portlet-instances.xml</emphasis>
- file.
- </para>
- </listitem>
- <listitem>
- <para>Edit and change
- <emphasis
role="bold">portlet-instances.xml</emphasis>
- file using following rules:
- </para>
- <para>Surround whole file content with
- <emphasis
role="bold"><![CDATA[</deployments>]]></emphasis>
- tag.
- </para>
- <para>Replace
- <emphasis
role="bold"><![CDATA[</instance-name>]]></emphasis>
- tag with
- <emphasis
role="bold"><![CDATA[</instance-id>]]></emphasis>
- one
- </para>
- <para>Replace
- <emphasis
role="bold"><![CDATA[</component-ref>]]></emphasis>
- tag with
- <emphasis
role="bold"><![CDATA[</portlet-ref>]]></emphasis>
- one
- </para>
- </listitem>
- </itemizedlist>
- <para>So after updates your portlet descriptors should look like
this:</para>
- <itemizedlist>
- <listitem>
- <para>
- <emphasis
role="bold">cardemo-object.xml</emphasis>
- </para>
- <programlisting>
- <![CDATA[
- <?xml version="1.0" encoding="UTF-8"?>
- <deployments>
- <deployment>
- <if-exists>overwrite</if-exists>
- <parent-ref>default</parent-ref>
- <page>
- <page-name>samples</page-name>
- <window>
- <window-name>CarDemoWindow</window-name>
-
<instance-ref>CarDemoPortletInstance</instance-ref>
- <region>center</region>
- <height>0</height>
- </window>
- </page>
- </deployment>
- </deployments>
- ]]>
- </programlisting>
- </listitem>
- <listitem>
- <para>
- <emphasis
role="bold">portlet-instances.xml</emphasis>
- </para>
- <programlisting>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8"
standalone="yes"?>
- <deployments>
- <deployment>
- <instance>
- <instance-id>CarDemoPortletInstance</instance-id>
- <portlet-ref>CarDemoPortlet</portlet-ref>
- </instance>
- </deployment>
- </deployments>
- ]]>
- </programlisting>
- </listitem>
- </itemizedlist>
- </sect2>
- </sect1>
--->
-
+ </sect1>
+
</chapter>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/navtabs.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/navtabs.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/navtabs.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -8,7 +8,6 @@
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
</chapterinfo>
<title>Navigation Tabs</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portalapi.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portalapi.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portalapi.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,12 +3,10 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien(a)jboss.org</email>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
</chapterinfo>
<title>Portal API</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portletmodes.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portletmodes.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/portletmodes.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,7 +4,6 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien.viet(a)jboss.com</email>
</author>
</chapterinfo>
<title>Portlet Modes</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/security.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/security.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/security.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,12 +4,10 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien(a)jboss.org</email>
</author>
</chapterinfo>
<title>Security</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/sso.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/sso.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/sso.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,12 +3,10 @@
<author>
<firstname>Boleslaw</firstname>
<surname>Dawidowicz</surname>
- <email>boleslaw dot dawidowicz at redhat dot com</email>
</author>
<author>
<firstname>Sohil</firstname>
<surname>Shah</surname>
- <email>sshah(a)redhat.com</email>
</author>
</chapterinfo>
<title>Single Sign ON</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/supported.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,11 +4,10 @@
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
<author>
- <surname>Roy Russo</surname>
- <email>roy(a)jboss.org</email>
+ <firstname>Roy</firstname>
+ <surname>Russo</surname>
</author>
</chapterinfo>
<title>System Requirements</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/themeandlayouts.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/themeandlayouts.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/themeandlayouts.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,17 +4,14 @@
<author>
<firstname>Martin</firstname>
<surname>Holzner</surname>
- <email>mholzner(a)novell.com</email>
</author>
<author>
<firstname>Mark</firstname>
<surname>Fernandes</surname>
- <email>mfernandes(a)novell.com</email>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
</chapterinfo>
<title>Layouts and Themes</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/troubleshooting.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/troubleshooting.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/troubleshooting.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -2,8 +2,8 @@
<chapter id="troubleshooting">
<chapterinfo>
<author>
- <surname>Roy Russo</surname>
- <email>roy(a)jboss.org</email>
+ <firstname>Roy</firstname>
+ <surname>Russo</surname>
</author>
</chapterinfo>
<title>Troubleshooting and FAQ</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/tutorials.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,17 +3,14 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
<author>
<firstname>Chris</firstname>
<surname>Laprun</surname>
- <email>chris.laprun(a)jboss.com</email>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>thomas.heute(a)jboss.com</email>
</author>
</chapterinfo>
<title>Portlet Primer</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/urls.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/urls.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/urls.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,17 +3,14 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien(a)jboss.org</email>
</author>
<author>
<firstname>Thomas</firstname>
<surname>Heute</surname>
- <email>theute(a)jboss.org</email>
</author>
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
</chapterinfo>
<title>Portal URLs</title>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/widgetintegration.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/widgetintegration.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/widgetintegration.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,7 +3,6 @@
<author>
<firstname>Emanuel</firstname>
<surname>Muckenhuber</surname>
- <email>emuckenh(a)redhat.com</email>
</author>
</chapterinfo>
<title>Widget Integration</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/workflow.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/workflow.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/workflow.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,7 +4,6 @@
<author>
<firstname>Sohil</firstname>
<surname>Shah</surname>
- <email>sshah @ redhat dot com</email>
</author>
</chapterinfo>
<title>Portal Workflow</title>
Modified: docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/wsrp.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/wsrp.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++ docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/wsrp.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -3,12 +3,10 @@
<author>
<firstname>Julien</firstname>
<surname>Viet</surname>
- <email>julien(a)jboss.org</email>
</author>
<author>
<firstname>Chris</firstname>
<surname>Laprun</surname>
- <email>chris.laprun(a)jboss.com</email>
</author>
</chapterinfo>
Modified:
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-06-27
15:34:50 UTC (rev 11174)
+++
docs/branches/JBoss_Portal_Branch_2_7/referenceGuide/en/modules/xmldescriptors.xml 2008-06-27
16:04:10 UTC (rev 11175)
@@ -4,7 +4,6 @@
<author>
<firstname>Roy</firstname>
<surname>Russo</surname>
- <email>roy(a)jboss.org</email>
</author>
</chapterinfo>
<title>XML Descriptors</title>