IBM Cloud Authors: Pat Romanski, Elizabeth White, Liz McMillan, Yeshim Deniz, William Schmarzo

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:


    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">

2.  Define the display name for the portlet.


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

<servlet id="Servlet_1">

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">

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:


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


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:

  <param-value>markupName, mode</param-value>

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:


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">

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


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"

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">

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")%>">


<script language="JavaScript" type="text/javascript" src="<%=

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.


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
Enterprises have taken advantage of IoT to achieve important revenue and cost advantages. What is less apparent is how incumbent enterprises operating at scale have, following success with IoT, built analytic, operations management and software development capabilities - ranging from autonomous vehicles to manageable robotics installations. They have embraced these capabilities as if they were Silicon Valley startups.
The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...
Poor data quality and analytics drive down business value. In fact, Gartner estimated that the average financial impact of poor data quality on organizations is $9.7 million per year. But bad data is much more than a cost center. By eroding trust in information, analytics and the business decisions based on these, it is a serious impediment to digital transformation.
Predicting the future has never been more challenging - not because of the lack of data but because of the flood of ungoverned and risk laden information. Microsoft states that 2.5 exabytes of data are created every day. Expectations and reliance on data are being pushed to the limits, as demands around hybrid options continue to grow.
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
As IoT continues to increase momentum, so does the associated risk. Secure Device Lifecycle Management (DLM) is ranked as one of the most important technology areas of IoT. Driving this trend is the realization that secure support for IoT devices provides companies the ability to deliver high-quality, reliable, secure offerings faster, create new revenue streams, and reduce support costs, all while building a competitive advantage in their markets. In this session, we will use customer use cases...
Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
The IoT Will Grow: In what might be the most obvious prediction of the decade, the IoT will continue to expand next year, with more and more devices coming online every single day. What isn’t so obvious about this prediction: where that growth will occur. The retail, healthcare, and industrial/supply chain industries will likely see the greatest growth. Forrester Research has predicted the IoT will become “the backbone” of customer value as it continues to grow. It is no surprise that retail is ...
Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...
The best way to leverage your Cloud Expo presence as a sponsor and exhibitor is to plan your news announcements around our events. The press covering Cloud Expo and @ThingsExpo will have access to these releases and will amplify your news announcements. More than two dozen Cloud companies either set deals at our shows or have announced their mergers and acquisitions at Cloud Expo. Product announcements during our show provide your company with the most reach through our targeted audiences.
DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. Digital Transformation (DX) is a major focus with the introduction of DXWorldEXPO within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of bus...
With 10 simultaneous tracks, keynotes, general sessions and targeted breakout classes, @CloudEXPO and DXWorldEXPO are two of the most important technology events of the year. Since its launch over eight years ago, @CloudEXPO and DXWorldEXPO have presented a rock star faculty as well as showcased hundreds of sponsors and exhibitors! In this blog post, we provide 7 tips on how, as part of our world-class faculty, you can deliver one of the most popular sessions at our events. But before reading...
DXWorldEXPO LLC announced today that "Miami Blockchain Event by FinTechEXPO" has announced that its Call for Papers is now open. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to info@dxworldexpo.com. Financial enterprises in New York City, London, Singapore, and other world financial capitals are embracing a new generation of smart, automated FinTech that eliminates many cumbersome, slow, and expe...
Cloud Expo | DXWorld Expo have announced the conference tracks for Cloud Expo 2018. Cloud Expo will be held June 5-7, 2018, at the Javits Center in New York City, and November 6-8, 2018, at the Santa Clara Convention Center, Santa Clara, CA. Digital Transformation (DX) is a major focus with the introduction of DX Expo within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive ov...
DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
DXWorldEXPO | CloudEXPO are the world's most influential, independent events where Cloud Computing was coined and where technology buyers and vendors meet to experience and discuss the big picture of Digital Transformation and all of the strategies, tactics, and tools they need to realize their goals. Sponsors of DXWorldEXPO | CloudEXPO benefit from unmatched branding, profile building and lead generation opportunities.
DXWorldEXPO LLC announced today that ICOHOLDER named "Media Sponsor" of Miami Blockchain Event by FinTechEXPO. ICOHOLDER give you detailed information and help the community to invest in the trusty projects. Miami Blockchain Event by FinTechEXPO has opened its Call for Papers. The two-day event will present 20 top Blockchain experts. All speaking inquiries which covers the following information can be submitted by email to info@dxworldexpo.com. Miami Blockchain Event by FinTechEXPO also offers s...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Widespread fragmentation is stalling the growth of the IIoT and making it difficult for partners to work together. The number of software platforms, apps, hardware and connectivity standards is creating paralysis among businesses that are afraid of being locked into a solution. EdgeX Foundry is unifying the community around a common IoT edge framework and an ecosystem of interoperable components.
Digital Transformation and Disruption, Amazon Style - What You Can Learn. Chris Kocher is a co-founder of Grey Heron, a management and strategic marketing consulting firm. He has 25+ years in both strategic and hands-on operating experience helping executives and investors build revenues and shareholder value. He has consulted with over 130 companies on innovating with new business models, product strategies and monetization. Chris has held management positions at HP and Symantec in addition to ...