Welcome!

IBM Cloud Authors: Pat Romanski, Liz McMillan, Yeshim Deniz, 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 Evatronix 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. Evatronix SA offers comprehensive solutions in the design and implementation of electronic systems, in CAD / CAM deployment, and also is a designer and manufacturer of advanced 3D scanners for professional applications.
SYS-CON Events announced today that Synametrics Technologies will exhibit at SYS-CON's 22nd International Cloud Expo®, which will take place on June 5-7, 2018, at the Javits Center in New York, NY. Synametrics Technologies is a privately held company based in Plainsboro, New Jersey that has been providing solutions for the developer community since 1997. Based on the success of its initial product offerings such as WinSQL, Xeams, SynaMan and Syncrify, Synametrics continues to create and hone inn...
To get the most out of their data, successful companies are not focusing on queries and data lakes, they are actively integrating analytics into their operations with a data-first application development approach. Real-time adjustments to improve revenues, reduce costs, or mitigate risk rely on applications that minimize latency on a variety of data sources. In his session at @BigDataExpo, Jack Norris, Senior Vice President, Data and Applications at MapR Technologies, reviewed best practices to ...
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, examined the regulations and provided insight on how it affects technology, challenges the established rules and will usher in new levels of diligence arou...
Recently, WebRTC has a lot of eyes from market. The use cases of WebRTC are expanding - video chat, online education, online health care etc. Not only for human-to-human communication, but also IoT use cases such as machine to human use cases can be seen recently. One of the typical use-case is remote camera monitoring. With WebRTC, people can have interoperability and flexibility for deploying monitoring service. However, the benefit of WebRTC for IoT is not only its convenience and interopera...
The 22nd International Cloud Expo | 1st DXWorld Expo has announced that its Call for Papers is open. Cloud Expo | DXWorld Expo, to be held June 5-7, 2018, at the Javits Center in New York, NY, brings together Cloud Computing, Digital Transformation, Big Data, Internet of Things, DevOps, Machine Learning and WebRTC to one location. With cloud computing driving a higher percentage of enterprise IT budgets every year, it becomes increasingly important to plant your flag in this fast-expanding busin...
Smart cities have the potential to change our lives at so many levels for citizens: less pollution, reduced parking obstacles, better health, education and more energy savings. Real-time data streaming and the Internet of Things (IoT) possess the power to turn this vision into a reality. However, most organizations today are building their data infrastructure to focus solely on addressing immediate business needs vs. a platform capable of quickly adapting emerging technologies to address future ...
No hype cycles or predictions of a gazillion things here. IoT is here. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, an Associate Partner of Analytics, IoT & Cybersecurity at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He also discussed the evaluation of communication standards and IoT messaging protocols, data...
Product connectivity goes hand and hand these days with increased use of personal data. New IoT devices are becoming more personalized than ever before. In his session at 22nd Cloud Expo | DXWorld Expo, Nicolas Fierro, CEO of MIMIR Blockchain Solutions, will discuss how in order to protect your data and privacy, IoT applications need to embrace Blockchain technology for a new level of product security never before seen - or needed.
In his session at 21st Cloud Expo, Raju Shreewastava, founder of Big Data Trunk, provided a fun and simple way to introduce Machine Leaning to anyone and everyone. He solved a machine learning problem and demonstrated an easy way to be able to do machine learning without even coding. Raju Shreewastava is the founder of Big Data Trunk (www.BigDataTrunk.com), a Big Data Training and consulting firm with offices in the United States. He previously led the data warehouse/business intelligence and B...
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...
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, whic...
"Evatronix provides design services to companies that need to integrate the IoT technology in their products but they don't necessarily have the expertise, knowledge and design team to do so," explained Adam Morawiec, VP of Business Development at Evatronix, in this SYS-CON.tv interview at @ThingsExpo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Recently, REAN Cloud built a digital concierge for a North Carolina hospital that had observed that most patient call button questions were repetitive. In addition, the paper-based process used to measure patient health metrics was laborious, not in real-time and sometimes error-prone. In their session at 21st Cloud Expo, Sean Finnerty, Executive Director, Practice Lead, Health Care & Life Science at REAN Cloud, and Dr. S.P.T. Krishnan, Principal Architect at REAN Cloud, discussed how they built...
Digital Transformation (DX) is not a "one-size-fits all" strategy. Each organization needs to develop its own unique, long-term DX plan. It must do so by realizing that we now live in a data-driven age, and that technologies such as Cloud Computing, Big Data, the IoT, Cognitive Computing, and Blockchain are only tools. In her general session at 21st Cloud Expo, Rebecca Wanta explained how the strategy must focus on DX and include a commitment from top management to create great IT jobs, monitor ...
"Digital transformation - what we knew about it in the past has been redefined. Automation is going to play such a huge role in that because the culture, the technology, and the business operations are being shifted now," stated Brian Boeggeman, VP of Alliances & Partnerships at Ayehu, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
Nordstrom is transforming the way that they do business and the cloud is the key to enabling speed and hyper personalized customer experiences. In his session at 21st Cloud Expo, Ken Schow, VP of Engineering at Nordstrom, discussed some of the key learnings and common pitfalls of large enterprises moving to the cloud. This includes strategies around choosing a cloud provider(s), architecture, and lessons learned. In addition, he covered some of the best practices for structured team migration an...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...
22nd International Cloud Expo, taking place June 5-7, 2018, at the Javits Center in New York City, NY, and co-located with the 1st DXWorld Expo will feature technical sessions from a rock star conference faculty and the leading industry players in the world. Cloud computing is now being embraced by a majority of enterprises of all sizes. Yesterday's debate about public vs. private has transformed into the reality of hybrid cloud: a recent survey shows that 74% of enterprises have a hybrid cloud ...