Deploy J2EE resources with portlet application WAR files

Deploy J2EE resources with portlet application WAR files

+

Search Tips | Advanced Search

Overview

We can manually predeploy portlet application WAR files using the WebSphere Application Server Administration console and later register them into WebSphere Portal, together with other J2EE resources and artefacts.
Portlet applications are usually packaged into single WAR files. These WAR files can be directly deployed into the portal by using portal administration means, for example,

Manage Web Modules portlet
XML configuration interface

The portal administration functions manage the correct deployment and configuration into both WebSphere Application Server and WebSphere Portal.
You might want to deploy portlet applications together with EJBs, or bundle several WAR files into the same EAR file, or work with similar scenarios. For this type of *.ear file deployment WebSphere Portal provides the predeployed mode with the XML configuration interface.
You deploy the EAR file into the application server using...

Administration console
wsadmin command line tool

Once you have deployed the EAR file into the application server we can use the portal XML configuration interface to perform the portal specific configuration steps that are required to configure the available portlet application(s)...

Bundle the portlet application(s) that you want to register together with other J2EE resources as an Enterprise Application Archive (EAR file).

Use the console or wsadmin to deploy this EAR file into WebSphere Application Server.
Take a note of the target directory to which you deploy the EAR file. The default target directory is AppServer. When deploying portlets specify PortalServer as the target directory.

Create a portal XML script file that deploys and configures the portlet application(s) deployed with the EAR file.
For a sample XML file for deploying and configuring a predeployed portlet refer to...
RegisterPreDeployedEAR.xml

Execute the XML script using the portal XML configuration interface.

After you have performed these steps, the portlet is ready for use.
We can register predeployed applications into the portal only by using the XML configuration interface. Once you have registered a predeployed application, the Manage Web Modules portlet shows this application.
We can later use the portal administration portlets to remove the portlet definitions from the portal database. However, this does not remove the EAR file from WebSphere Application Server.
We can update a predeployed portlet application only by using the XML configuration interface.
We cannot update a deployed portlet application WAR file with a predeployed EAR file and vice versa. To change between the two types of files, delete the existing portlet application and deploy the new one. However, deleting the existing portlet application will also delete all configuration data of that application. A predeployed application can only be updated via update of the EAR file in WebSphere Application Server and subsequent update of the contained WAR file in portal by using the XML configuration interface. Cross updates of a predeployed EAR file with a real WAR and vice versa are not possible.
The WebSphere Application Server administrator must take care of correctly configuring the dispatch mechanisms for these applications. XML configuration interface
The sample XML file RegisterPreDeployedEAR.xml shows you an example for deploying and configuring a predeployed portlet.

Differences between WAR and EAR deployment

Portal area WAR file Predeployed EAR file
Portlet application Portlet application is provided as WAR file. The portal configuration is read directly from the file stream. The WAR file is deployed into the application server by the portal. Portlet application is already extracted and deployed into the application server as part of the EAR file. The portal server reads the available portal configuration information (portlet.xml, etc.) from the location where the contained WAR file was extracted to.
Context Root The context root is assigned by the portal during WAR deployment. The context root is assigned by the EAR developer and stored in the file application.xml. Ensure that the context root that you specify when you register the portlet matches the one specified in the EAR application.xml. See...
RegisterPreDeployedEAR.xml.

Display name Display name is assigned by Portal during WAR deployment. Display name is assigned by the EAR developer and stored in the file application.xml.
WAS policy for portlet applications Policy is stored in the WAR file and promoted to the EAR file by the portal during WAR deployment. Policy is stored in the EAR file.
Portlet administration You administer WAR files using the XML configuration interface and the administration portlets. We can register EAR files only by using an XML script with predeployed mode. We can remove EAR files by using either the administration portlet or an XML script.

Related information

Administer the portal
XML configuration interface
Write portlets
Customize the portal
Portlet development

Parent topic:
Manage portlets and portlet applications

Portal area	WAR file	Predeployed EAR file
Portlet application	Portlet application is provided as WAR file. The portal configuration is read directly from the file stream. The WAR file is deployed into the application server by the portal.	Portlet application is already extracted and deployed into the application server as part of the EAR file. The portal server reads the available portal configuration information (portlet.xml, etc.) from the location where the contained WAR file was extracted to.
Context Root	The context root is assigned by the portal during WAR deployment.	The context root is assigned by the EAR developer and stored in the file application.xml. Ensure that the context root that you specify when you register the portlet matches the one specified in the EAR application.xml. See... RegisterPreDeployedEAR.xml.
Display name	Display name is assigned by Portal during WAR deployment.	Display name is assigned by the EAR developer and stored in the file application.xml.
WAS policy for portlet applications	Policy is stored in the WAR file and promoted to the EAR file by the portal during WAR deployment.	Policy is stored in the EAR file.
Portlet administration	You administer WAR files using the XML configuration interface and the administration portlets.	We can register EAR files only by using an XML script with predeployed mode. We can remove EAR files by using either the administration portlet or an XML script.