8:33 a.m.
Author: thomas.heute(a)jboss.com
Date: 2007-11-27 09:33:03 -0500 (Tue, 27 Nov 2007)
New Revision: 9126
Added:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/images/tutorials/jsf_portlet/package_myfaces42.png
Modified:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/clustering.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/sso.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml
Log:
- Removed references to JBoss AS 4.0.x
- Added full example for JSF portlet bundling MyFaces libs for JBoss AS 4.2
Added:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/images/tutorials/jsf_portlet/package_myfaces42.png
===================================================================
(Binary files differ)
Property changes on:
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/images/tutorials/jsf_portlet/package_myfaces42.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/clustering.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/clustering.xml 2007-11-27
14:07:26 UTC (rev 9125)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/clustering.xml 2007-11-27
14:33:03 UTC (rev 9126)
@@ -178,12 +178,6 @@
uncomment the following valve:
<programlisting><![CDATA[<Valve
className="org.jboss.web.tomcat.service.sso.ClusteredSingleSignOn"
/>]]></programlisting>
- <note>
- If you use JBoss 4.0.x, the files and valve are respectively:
-
<literal>$JBOSS_HOME/server/all/deploy/jbossweb-tomcat55.sar/server.xml</literal>
- <programlisting><![CDATA[<Valve
className="org.jboss.web.tomcat.tc5.sso.ClusteredSingleSignOn"
/>]]></programlisting>
- </note>
-
More information can be found <ulink
url="http://www.jboss.org/wiki/Wiki.jsp?page=SingleSignOn">h...;.
</para>
</sect2>
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/sso.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/sso.xml 2007-11-27
14:07:26 UTC (rev 9125)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/sso.xml 2007-11-27
14:33:03 UTC (rev 9126)
@@ -29,17 +29,12 @@
using a valve. The Single Sign On Valve caches credentials on the server side, and
then invisibly authenticate users when they
reach different web applications. Credentials are stored in a host-wide session
which means that SSO will be effective throughout the session.
</para>
- <note>Below we will describe configuration using <emphasis>JBoss
Application Server 4.0.5</emphasis>. For different versions it can be slightly
different.</note>
<sect2>
<title>Enabling Tomcat SSO Valve</title>
<para>
To enable SSO valve in Tomcat you should uncomment the following line
<programlisting><![CDATA[<Valve
className=’org.apache.catalina.authenticator.SingleSignOn’/>]]></programlisting>
in the
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/server.xml</literal>
file.
- <note>
- On JBoss 4.0.x the configuration file is
-
<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
- </note>
More information can be found <ulink
url="http://www.jboss.org/wiki/Wiki.jsp?page=SingleSignOn">h...;.
</para>
</sect2>
@@ -53,7 +48,7 @@
</para>
<orderedlist>
<listitem>
- <para>Take a clean install of <emphasis>JBoss Application
Server 4.0.5.GA</emphasis></para>
+ <para>Take a clean install of <emphasis>JBoss Application
Server</emphasis></para>
</listitem>
<listitem>
<para>Edit
<emphasis>$JBOSS_HOME/server/default/deploy/jmx-console.war/WEB-INF/web.xml</emphasis>
file and make sure it contains following content:</para>
@@ -134,10 +129,6 @@
Uncomment the following line
<programlisting><![CDATA[<Valve
className=’org.apache.catalina.authenticator.SingleSignOn’/>]]></programlisting>
in the
<literal>$JBOSS_HOME/server/default/deploy/jboss-web.deployer/server.xml</literal>
file.
- <note>
- On JBoss 4.0.x the configuration file is
-
<literal>$JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/server.xml</literal>
- </note>
More information can be found <ulink
url="http://www.jboss.org/wiki/Wiki.jsp?page=SingleSignOn">h...;.
</para>
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml
===================================================================
---
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2007-11-27
14:07:26 UTC (rev 9125)
+++
docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/tutorials.xml 2007-11-27
14:33:03 UTC (rev 9126)
@@ -745,7 +745,7 @@
</sect3>
</sect2>
<sect2 id="sunri_42x">
- <title>A simple Sun's JSF Reference Implementation (RI) portlet on
JBoss AS 4.2.x</title>
+ <title>A simple Sun's JSF Reference Implementation (RI) portlet on
JBoss AS 4.2</title>
<sect3>
<title>Introduction</title>
<para>This section will introduce the reader to deploying a simple JSF
portlet in JBoss Portal, using
@@ -888,13 +888,7 @@
</itemizedlist>
</para>
</sect3>
- <!--
<sect3>
- <title>JSP files</title>
- <para>TODO!!</para>
- </sect3>
- -->
- <sect3>
<title>Building and deploying your portlet</title>
<para>If you have downloaded the sample, you can execute the build.xml
with ant or inside your IDE.
Executing <literal>ant</literal> will compile all source files
and produce a
@@ -968,14 +962,17 @@
</para>
</sect3>
</sect2>-->
- <sect2 id="myfaces_40x">
- <title>A simple MyFaces JSF Portlet on JBoss AS 4.0.5+</title>
+ <sect2 id="myfaces_42x">
+ <title>A simple MyFaces JSF Portlet on JBoss AS 4.2</title>
<sect3>
<title>Introduction</title>
<para>This section will introduce the reader to deploying a simple JSF
portlet in JBoss Portal, using
- Apache's MyFaces JSF implementation on JBoss AS 4.0.5+. It requires
you download the HelloWorldJSFMyFacesPortlet
+ Apache's MyFaces JSF implementation on JBoss AS 4.2. It requires you
download the HelloWorldJSFMyFaces42Portlet
from PortletSwap.com, using this link:
- <ulink
url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles...;.
+ <ulink
url="http://anonsvn.jboss.org/repos/portletswap/portlets/2_6/bundles...;.
+ There are actually different ways to do it, one would be to use MyFaces
globally for the whole server and replace the Sun RI
+ libraries by the myFaces ones, but in this section the portlet will not
affect the application server and embed its
+ own libraries.
</para>
</sect3>
<sect3>
@@ -983,25 +980,17 @@
<para>
<mediaobject>
<imageobject>
- <imagedata align="center"
fileref="images/tutorials/jsf_portlet/package_myfaces.png"
valign="middle"/>
+ <imagedata align="center"
fileref="images/tutorials/jsf_portlet/package_myfaces42.png"
valign="middle"/>
</imageobject>
</mediaobject>
Like a typical JSF application, we also package our faces-config.xml that
defines our
managed-beans, converters, validators, navigation rules, etc...
- <note>JBoss Application Server version 4.0.x bundles Apache's
MyFaces JSF implementation in
-
<literal>JBOSS_HOME/server/default/deploy/jbossweb-tomcat55.sar/jsf-libs/</literal>.
As a result,
- you do not need to package MyFaces' libraries with your portlet
application.
- </note>
+ The <filename>WEB-INF/lib</filename> must contain the MyFaces
libraries along with dependent libraries.
</para>
- <para>For the sake of brevity, we only discuss the
<literal>portlet.xml</literal> and
+ <para>For the sake of brevity, we only discuss the
<literal>portlet.xml</literal>, <literal>web.xml</literal> and
<literal>faces-config.xml</literal> descriptors here. For
discussion on the other descriptors, please
view <xref linkend="first_portlet_descriptors"/> or the
chapter on descriptors:
<xref linkend="descriptors_portlet"/>.
- <mediaobject>
- <imageobject>
- <imagedata align="center"
fileref="images/tutorials/jsf_portlet/package_myfaces.png"
valign="middle"/>
- </imageobject>
- </mediaobject>
<itemizedlist>
<listitem>
<para><literal>portlet.xml</literal>
@@ -1055,6 +1044,18 @@
</para>
</listitem>
<listitem>
+ <para><literal>web.xml</literal>
+<programlisting><![CDATA[<context-param>
+ <param-name>org.jboss.jbossfaces.WAR_BUNDLES_JSF_IMPL</param-name>
+ <param-value>true</param-value>
+</context-param>]]></programlisting>
+ We need this extra parameter to let the application server know
that the package embeds its own libraries.
+ It will avoid collision with the Sun RI JSF libraries bundled
with JBoss AS.
+ More details on this procedure can be found at <ulink
+
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossFaces">ht...;.
+ </para>
+ </listitem>
+ <listitem>
<para><literal>faces-config.xml</literal>
<programlisting><![CDATA[<?xml version="1.0"?>
<!DOCTYPE faces-config PUBLIC
@@ -1083,31 +1084,15 @@
</itemizedlist>
</para>
</sect3>
- <!--
<sect3>
- <title>JSP files</title>
- <para>TODO!!</para>
- </sect3>
- -->
- <sect3>
<title>Building and deploying your portlet</title>
<para>If you have downloaded the sample, you can execute the build.xml
with ant or inside your IDE.
Executing <literal>ant</literal> will compile all source files
and produce a
<literal>helloworldjsfportlet.war</literal> file in a way
similar to what we saw in
<xref linkend="first_portlet_build"/>.
</para>
- <!--
<para>
- The <literal>explode</literal> target will produce the
following:
- <mediaobject>
- <imageobject>
- <imagedata align="center"
fileref="images/tutorials/jsf_portlet/exploded.gif"
valign="middle"/>
- </imageobject>
- </mediaobject>
- </para>
- -->
- <para>
- Deploying the portlet is as easy as copying/moving the
<literal>helloworldjspportlet.war</literal> file
+ Deploying the portlet is as easy as copying/moving the
<literal>helloworldjsfmyfacesportlet.war</literal> file
to the server <literal>deploy</literal> directory. We can then
see our portlet on the Portal default
page (<ulink
url="http://localhost:8080/portal/">http://localhost:8080/portal/</ulink>):
<mediaobject>
@@ -1118,7 +1103,7 @@
</para>
</sect3>
</sect2>
- <sect2>
+ <!-- sect2>
<title>Adapting MyFaces JSF Portlet to work on JBoss AS
4.2.x</title>
<para>We saw in <xref linkend="myfaces_40x"/> how to
create a JSF-based portlet using Apache's MyFaces
JSF implementation on JBoss Application Server 4.0.x. Starting with version
4.2.0 of JBoss Application
@@ -1148,7 +1133,7 @@
</imageobject>
</mediaobject>
</para>
- </sect2>
+ </sect2-->
<!-- sect2 id="richfaces">
<title>Portal and RichFaces: A basic demonstration using Ajax4JSF and
RichFaces components</title>
<sect3>
Modified: docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml
===================================================================
--- docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml 2007-11-27
14:07:26 UTC (rev 9125)
+++ docs/branches/JBoss_Portal_Branch_2_6/referenceGuide/en/modules/wsrp.xml 2007-11-27
14:33:03 UTC (rev 9126)
@@ -84,19 +84,6 @@
<emphasis>JBOSS_HOME/server/default/deploy</emphasis>.
</para>
- <sect2>
- <title>Considerations to use WSRP behind firewall</title>
- <para>WSRP is built upon the JBoss WS web service stack. There is a known
issue with the version 1.0.0.GA of JBoss
- WS (bundled with JBoss Application Server 4.0.4.GA) that prevents the complete
deployment of JBoss
- Portal's WSRP service if the user is not online or behind a firewall/proxy.
For this reason, we recommend
- that you deploy Portal on JBoss Application Server 4.0.5.GA. Alternatively, you
can also perform a manual
- upgrade of JBoss WS, in which case we recommend that you use JBoss WS version
1.2.1.GA (and later).
- Please follow the instructions on
- <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=WSRP_UpdateJBossWS&quo... to
upgrade JBoss WS</ulink>
- as found on <ulink
url="http://wiki.jboss.org/wiki/Wiki.jsp?page=JBossPortal">J... Portal's
wiki</ulink>.
- </para>
- </sect2>
-
<sect2 id="wsrp-ports">
<title>Considerations to use WSRP when running Portal on a non-default
port</title>
<para>If you have modified the port number on which Portal runs, you will
also need