Welcome!

IBM Cloud Authors: Yeshim Deniz, Pat Romanski, Liz McMillan, Carmen Gonzalez, Elizabeth White

Related Topics: IBM Cloud

IBM Cloud: Article

Migration Guide

Run a servlet-Struts application as a portlet-Struts application in WebSphere Portal v5.

This article offers guidance to migrating existing servlet Struts-based applications to portlet Struts-based applications - with a minimum of steps - using WebSphere Studio Application Developer v5.0 with the WebSphere Portal v5.0 test environment.

This article does not cover expanding the functionality of the Web application (e.g., using portlet communication), nor is it an introduction to Struts, WebSphere Portal, or portlet programming. The purpose of this article is to enable you - with the fewest changes possible - to run a servlet-Struts application as a portlet-Struts application in WebSphere Portal v5. For further information on portlet development, refer to the Portlet Development Guide.

In short, the abstract Portlet class is the central abstraction of the Portlet API. The Portlet class extends HTTPServlet of the Servlet API. All portlets extend the Portlet class indirectly, and inherit from HttpServlet. Therefore, portlets are a special type of servlet, with properties that allow them to easily plug into and run in the Portal Server. Unlike servlets, portlets cannot forward requests, send redirects or errors to browsers directly, or write arbitrary markup to the output stream. Portlets are more dynamic than servlets - they can, for example, be installed or their settings can be changed without having to restart the Portal Server.

The portlet container relies on the J2EE architecture implemented by the WebSphere Application Server. As a result, portlets are packaged in WAR files similar to J2EE Web applications and are deployed like servlets. Like other servlets, a portlet is defined to the application server using the Web application deployment descriptor (web.xml). This file defines the portlet's class file, the servlet mapping, and read-only initialization parameters.

Exporting the Existing Application

From the previous environment, in WebSphere Studio:
  1. If multiple projects exist for same application, merge all them into a single project.
  2. Export the project to the file system as a WAR file with source files.
Note: For deployment in the WebSphere Portal, we'll actually be exporting the Web container (WAR file) only. WebSphere Portal creates an enterprise application wrapper for the WAR file at deployment.

Import the Application into the Portal Project

In the new portal development environment, in WebSphere Studio:
  1. Create a new portlet application project, specifying the Create empty portlet and J2EE Level 1.3 options.
  2. Import the WAR file you exported earlier to the existing project and press Finish.
  3. Turn off the Overwrite existing resources without warning option.
  4. Answer No to Overwrite portlet.tld.
  5. Answer Yes to Overwrite portlet.xml and web.xml.
Note: After importing the WAR file, the "Incorrect servlet reference for the portlet" error message will appear. Ignore it, it'll be fixed later.

Setup Environment for WebSphere Portal

From WebSphere Studio:
  1. Select your portlet project in the J2EE Navigator view.
  2. Select File > Properties.
  3. Select Java build path.
  4. Make sure you have the definitions shown in Listing 1 inside the c:\<workspace>\<projectname>\.classpath file.

    Note the following:
    a. Make sure to check your classpath entries in the new Studio Products tooling after migration. Ensure that the classpath entries are pointing to the new WebSphere Portal v5.0 paths.
    b. When you create a portlet project for WebSphere Portal v5.0, you can choose WPS_V5_PLUGINDIR as a class variable.

  5. Select File > Import File System.
  6. Press Next.
  7. Select the following directory as a source directory:

    <WebSphere_Studio_root>/wstools/eclipse/
    plugins/com.ibm.wps_v5_<WebSphere_Portal_version>

    For example: com.ibm.wps_v5_5.0.0 - where <WebSphere_Studio_root> is the root directory of WebSphere Studio and <WebSphere_Portal_version> is the specific 4.x version of WebSphere Portal.

  8. Select the following directory as a target directory: <portlet_project>/Web Content/WEB-INF/tld - where <portlet_project> is the name of your project.
  9. Override the existing portlet.tld file with the new one.
The Struts Portlet Framework
In WebSphere Portal 5.0, the supported Struts framework is Struts 1.1 RC 1. In a standard installation, you will find the Struts framework in the <wp_root>\dev\struts\ directory.

In WebSphere Studio, the Portlet Deployment Descriptor should be checked for this application (do you mean Struts 1.1 RC 1?) to verify that the Struts filter chain is specified. The filter chain is used to implement solutions for some of the differences between the versions of WebSphere Portal.

1.  The Struts application must be migrated to the newer version of the Struts Portlet Framework. Unzip the PortalStrutsBlank.war file located in the <wp_root>/dev/struts/Struts portlet directory. This is an actual Struts application, so the directory structure is similar to many Struts applications. Copy the following JAR files in the WEB-INF/lib directory from the PortalStrutsBlank.war to the WEB-INF/lib directory of the Struts application:

  • commons-beanutils.jar
  • commons-collections.jar
  • commons-dbcp.jar
  • commons-digester.jar
  • commons-fileupload.jar
  • commons-lang.jar
  • commons-logging.jar
  • commons-pool.jar
  • commons-resources.jar
  • commons-services.jar
  • commons-validator.jar
  • jakarta-oro.jar
  • jdbc2_0-stdext.jar
  • PortalStruts.jar (Struts Portlet Framework)
  • PortalStrutsCommon.jar (Struts Portlet Framework)
  • PortalStrutsTags.jar (Struts Portlet Framework - new)
  • struts.jar
  • StrutsUpdateForPortal.jar (Struts Portlet Framework)
Note: Overwrite any file if it already exists.

2.  Remove the following files from the WEB-INF/lib directory, they exist:

  • commons-services.jar
  • jdbc2_0-stdext.jar
  • commons-dpcp.jar
  • commons-pool.jar
  • commons-resources.jar
3.  Move the TLD files from WEB-INF to the WEB-INF/tld directory. Note that the location of the TLD files has changed; they are now in the WEB-INF/tld directory. Update the path of these files inside the web.xml file and also inside the JSP files where the taglib tag is defined. Make sure you don't have multiple entries for the same TLD in the web.xml file.

4.  Update the TLD files with the versions from the WEB-INF/tld directory of the PortalStrutsBlank.war. The TLD files that ship with the Struts Portlet Framework and should be used in the Struts application are listed here.

  • struts-bean.tld
  • struts-chtml.tld
  • struts-html.tld
  • struts-logic.tld
  • struts-nested.tld
  • struts-portal-html.tld
  • struts-portal-wml.tld
  • struts-template.tld
  • struts-tiles.tld
  • struts-wml.tld
5.  Remove the ForwardAction class (if it exists) when migrating to the current release. The ForwardAction class can be found in the WEB-INF/classes/org/apache/struts/actions directory. Struts also ships an IncludeAction class. The Struts implementation of IncludeAction writes directly to the response object; this behavior is not supported for an action in WebSphere Portal, so I recommend that you use ForwardAction instead of the IncludeAction.

6.  In WebSphere Studio, right-click on the project name and select Refresh so WebSphere Studio updates the project with the new library and property files.

Modifications Needed to Run in WebSphere Portal

To run the application in the portal environment, the following changes are needed in some of the application configuration files.

Web Deployment Descriptor: web.xml
Most of the configuration for a Struts application is in the Web deployment descriptor file (web.xml).

1.  Define a unique ID for the Web application.


<web-app id="WebApp_1">
		...
	</web-app>

2.  Define the display name for the portlet.

<display-name>StrutsPortletUI</display-name>

3.  Change the <servlet-class> to com.ibm.wps.portlets.struts.WpsStrutsPortlet.


<servlet id="Servlet_1">
     <servlet-name>MyStrutsApp</servlet-name>
     <servlet-class>com.ibm.wps.portlets.struts.WpsStrutsPortlet
     </servlet-class>
     ...
 </servlet>

Note: The servlet ID should be suffixed with a unique ID to prevent conflicts with other portlets. Define a servlet ID for all the defined servlets inside web.xml.

4.  In a portlet, you need to use a servlet URL mapping for your portlet. You would typically use a path prefix servlet mapping:


<servlet-mapping id="Unique_ServletMapping">
  <servlet-name>Struts</servlet-name>
  <url-pattern>/Struts/*</url-pattern>
</servlet-mapping>

5.  A normal Struts application requires a servlet mapping to associate paths to actions. The Struts Portlet Framework handles this using a pseudo servlet mapping that needs to be specified as an init parameter:


<init-param>
  <param-name>struts-servlet-mapping</param-name>
  <param-value>*.do</param-value>
</init-param>

6.  The Struts application needs to specify what the initial screen is for the application.


<welcome-file-list>
  	<welcome-file>index.jsp</welcome-file>
 </welcome-file-list>

7.  The Struts Portlet Framework takes advantage of this module support to provide both mode and device (markup) differentiation of the Struts configuration. There are two paths that can be specified in the web.xml for supporting differentiation of modes and device types:

a.  The first is the search path, used to determine which module (and which struts-config.xml file) to use. It also determines the base directory for locating JSPs. The following init param setting will set the search path to consider markup name and mode when searching for modules:


<init-param>
  <param-name>SubApplicationSearchPath</param-name>
  <param-value>markupName, mode</param-value>
</init-param>

b.  The second path is the include path, used to include common JSP files in the search. The search will progress from the most qualified to the least qualified, based on the path settings. The search completes when the first file match is found:


<init-param>
  <param-name>IncludesSearchPath</param-name>
  <param-value>locale</param-value>
</init-param>

Portlet Deployment Descriptor: portlet.xml

1.  In order to run our Struts application as a portlet we also need to create a portlet.xml file. Keep in mind that the portlet href attribute defined in portlet.xml must map to the servlet ID in the web.xml file. The definition of the servlets in the web.xml must be in the same order as the definition of portlets in the portlet.xml.


<portlet id="Portlet_1" href="WEB-INF/web.xml#Servlet_1">
    	<portlet-name>Mail</portlet-name>
    ...
  </portlet>

2.  Specify the Struts filter chain inside the portlet.xml by adding the following lines:

<config-param>
<param-name>FilterChain</param-name>
<param-value>StrutsTranscoding</param-value>
</config-param>

The filter chain is used to implement solutions for some of the differences between the versions of WebSphere Portal.

Struts Configuration File: struts-config.xml

1.  The Struts configuration used by Struts portlets references the 1.1 version of the DTD. Change the DOCTYPE if it is of a different version.


<!DOCTYPE struts-config PUBLIC
"-//Apache Software Foundation//DTD Struts Configuration 1.1//EN"
"http://jakarta.apache.org/struts/dtds/struts-config_1_1.dtd">

2.  For the Struts Portlet Framework to operate properly, the RequestProcessor must be configured. The RequestProcessor is responsible for the main functionality of processing a request. The default RequestProcessor can be overridden in the struts-config.xml via the controller element. In the struts-config.xml, the following Portal Server RequestProcessor must be specified:

<controller processorClass="com.ibm.wps.portlets.struts.WpsRequestProcessor">
</controller>

Changes to the JSPs
The JSPs for Struts applications in the portal environment have to be modified to adapt to the way the portal server expects portlet URIs to be created.

1.  Remove the following tags from each JSP:

  • <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  • <HTML> and </HTML>
  • <HEAD> and </HEAD>; Delete all enclosed within these tags, including <META> content, <TITLE> content, and <LINK> content.
  • <BODY> and </BODY>
2.  Portlet JSPs cannot link directly to content (e.g., images or JavaScript files) within the portlet's WAR directory structure. Instead, they have to use the services of the portlet container to create portlet URIs from which the content can be accessed. Use the encodeURL() method of ServletResponse to access content within the portlet WAR structure. For example:

<IMG border="0" src="<%= response.encodeURL("/images/logo.jpg")%>">

or

<script language="JavaScript" type="text/javascript" src="<%=
response.encodeURL("/js/myScript.js")%>"></script>

The the encodeURL() method returns the relative URL of the content, without the hostname and domain information.

Rebuild the Project
After making all these changes, rebuild the project by selecting Project from the Web perspective and choosing the Rebuild All option from the Project menu.

Deploying a Portlet to a WebSphere Portal Test Environment

To deploy a portlet to a test environment, do as follows:
  1. Create a server and server configuration.
  2. Add projects to the server.
  3. Deploy and test the portlet.
Creating a Server and Server Configuration
1.  Inside WebSphere Studio, select File > New > Other.... The "New" panel appears. Select "Server" on the left pane and "Server and Server Configuration" on the right (see Figure 1).

2.  Click Next. The creation wizard appears. Select WebSphere Portal version 5.0 > Test Environment as the Server type.

Note: The procedure for creating a test environment in WebSphere Portal is the same as the one for creating a test environment with WebSphere Studio.

When the wizard has finished, the server and server configuration are shown in the Server Configuration view.

Adding Projects to the Server
The next step is to add the target portlet project to the server.

  1. In the Server Configuration view, expand Servers.
  2. Right-click on the appropriate server project and select Add.
  3. Select the enterprise application project that the portlet project that you want to debug is associated with.
Deploy and Test the Portlet
In order to deploy and test the portlet in a WebSphere Portal test environment, right-click on the project and select "Run on Server...". This will start the WebSphere Portal test environment and will show the portlet on a portal page.

Deploying a Portlet to WebSphere Portal Server

  1. Build and export the portal project to create a portlet WAR file by right-clicking the portal project and then selecting Export.
  2. Install this WAR file into WebSphere Portal by using Portal Administration functions.
  3. Add it to the page container.

Summary

This article discussed the minimal steps required to migrate an existing Struts servlet-based application to a Struts portlet-based application by using WebSphere Studio Application developer with a WebSphere Portal test environment.

More Stories By Asim Saddal

Asim Saddal works in the Middleware (WebSphere Application Server, WebSphere Datapower, WebSphere Process Server, WebSphere VE) practice of IBM Software Services for WebSphere.

Comments (0)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


@ThingsExpo Stories
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
SYS-CON Events announced today that Datera, that offers a radically new data management architecture, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Datera is transforming the traditional datacenter model through modern cloud simplicity. The technology industry is at another major inflection point. The rise of mobile, the Internet of Things, data storage and Big...
While the focus and objectives of IoT initiatives are many and diverse, they all share a few common attributes, and one of those is the network. Commonly, that network includes the Internet, over which there isn't any real control for performance and availability. Or is there? The current state of the art for Big Data analytics, as applied to network telemetry, offers new opportunities for improving and assuring operational integrity. In his session at @ThingsExpo, Jim Frey, Vice President of S...
DX World EXPO, LLC., a Lighthouse Point, Florida-based startup trade show producer and the creator of "DXWorldEXPO® - Digital Transformation Conference & Expo" has announced its executive management team. The team is headed by Levent Selamoglu, who has been named CEO. "Now is the time for a truly global DX event, to bring together the leading minds from the technology world in a conversation about Digital Transformation," he said in making the announcement.
"We provide IoT solutions. We provide the most compatible solutions for many applications. Our solutions are industry agnostic and also protocol agnostic," explained Richard Han, Head of Sales and Marketing and Engineering at Systena America, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"We are focused on SAP running in the clouds, to make this super easy because we believe in the tremendous value of those powerful worlds - SAP and the cloud," explained Frank Stienhans, CTO of Ocean9, Inc., in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"DX encompasses the continuing technology revolution, and is addressing society's most important issues throughout the entire $78 trillion 21st-century global economy," said Roger Strukhoff, Conference Chair. "DX World Expo has organized these issues along 10 tracks with more than 150 of the world's top speakers coming to Istanbul to help change the world."
"We've been engaging with a lot of customers including Panasonic, we've been involved with Cisco and now we're working with the U.S. government - the Department of Homeland Security," explained Peter Jung, Chief Product Officer at Pulzze Systems, in this SYS-CON.tv interview at @ThingsExpo, held June 6-8, 2017, at the Javits Center in New York City, NY.
With tough new regulations coming to Europe on data privacy in May 2018, Calligo will explain why in reality the effect is global and transforms how you consider critical data. EU GDPR fundamentally rewrites the rules for cloud, Big Data and IoT. In his session at 21st Cloud Expo, Adam Ryan, Vice President and General Manager EMEA at Calligo, will examine the regulations and provide insight on how it affects technology, challenges the established rules and will usher in new levels of diligence...
The financial services market is one of the most data-driven industries in the world, yet it’s bogged down by legacy CPU technologies that simply can’t keep up with the task of querying and visualizing billions of records. In his session at 20th Cloud Expo, Karthik Lalithraj, a Principal Solutions Architect at Kinetica, discussed how the advent of advanced in-database analytics on the GPU makes it possible to run sophisticated data science workloads on the same database that is housing the rich...
SYS-CON Events announced today that Massive Networks will exhibit at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Massive Networks mission is simple. To help your business operate seamlessly with fast, reliable, and secure internet and network solutions. Improve your customer's experience with outstanding connections to your cloud.
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
"The Striim platform is a full end-to-end streaming integration and analytics platform that is middleware that covers a lot of different use cases," explained Steve Wilkes, Founder and CTO at Striim, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that Calligo, an innovative cloud service provider offering mid-sized companies the highest levels of data privacy and security, has been named "Bronze Sponsor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Calligo offers unparalleled application performance guarantees, commercial flexibility and a personalised support service from its globally located cloud plat...
Everything run by electricity will eventually be connected to the Internet. Get ahead of the Internet of Things revolution and join Akvelon expert and IoT industry leader, Sergey Grebnov, in his session at @ThingsExpo, for an educational dive into the world of managing your home, workplace and all the devices they contain with the power of machine-based AI and intelligent Bot services for a completely streamlined experience.
"MobiDev is a Ukraine-based software development company. We do mobile development, and we're specialists in that. But we do full stack software development for entrepreneurs, for emerging companies, and for enterprise ventures," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
In his opening keynote at 20th Cloud Expo, Michael Maximilien, Research Scientist, Architect, and Engineer at IBM, discussed the full potential of the cloud and social data requires artificial intelligence. By mixing Cloud Foundry and the rich set of Watson services, IBM's Bluemix is the best cloud operating system for enterprises today, providing rapid development and deployment of applications that can take advantage of the rich catalog of Watson services to help drive insights from the vast t...
SYS-CON Events announced today that EnterpriseTech has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. EnterpriseTech is a professional resource for news and intelligence covering the migration of high-end technologies into the enterprise and business-IT industry, with a special focus on high-tech solutions in new product development, workload management, increased effic...
SYS-CON Events announced today that Massive Networks, that helps your business operate seamlessly with fast, reliable, and secure internet and network solutions, has been named "Exhibitor" of SYS-CON's 21st International Cloud Expo ®, which will take place on Oct 31 - Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. As a premier telecommunications provider, Massive Networks is headquartered out of Louisville, Colorado. With years of experience under their belt, their team of...