Getting Started with the Portal Toolkit Java Debugger for WebSphere Studio V5.01

Transcription

1 Getting Started with the Portal Toolkit Java Debugger for WebSphere Studio V5.01 Keith Wright Application Integration Middleware Solution Architect IBM Austin November, 2003 Copyright International Business Machines Corporation All rights reserved. This guide is for portlet programmers who want to use IBM s Java source debugger as a tool in developing portlets. The debugger is one of the components in the Portal Toolkit V5.0, which you can install into IBM WebSphere Studio V5.01. It runs on an application server embedded in either IBM WebSphere Studio Application Developer or WebSphere Studio Site Developer. It does not require DB2. This article shows how to install the the Portal Toolkit, which includes the debugger, into WebSphere Studio Site Developer (hereafter called Site Developer). It also describes how to configure the various components that enable the debugger, and finally, how to use some of the standard features of the debugger. To get the most out of this article, you should be familiar with WebSphere Studio and WebSphere Portal installation procedures. The procedure described below was tested using a T30 ThinkPad, with 1 Gig of memory, and a 30 Gig hard drive. This is the minimum configuration you should use. Introduction This guide is written as a lab exercise and involves the following tasks. It takes about two hours to complete. 1. Scrub your machine. 2. Install WebSphere Studio Site Developer V Install the Site Developer Fixpack Install the WebSphere Fixpack Install the WebSphere Portal efixes. 6. Install Portal Toolkit Disable the Transcoding Publisher subsystem. 8. Configure a Site Developer server. 9. Create a Site Developer portlet project. 10. Set breakpoints in the Java code. 11. Start the debugger. 1

2 Software requirements You need to installed the following software before beginning this exercise. Windows 2000 Professional Edition with Service Pack 3 1. Scrub your machine a. Uninstall old versions of Site Developer, WebSphere Studio Application Developer, Portal Toolkit, Symantec Firewall, ATT Net Client. Delete directories manually. b. Configure a fully-qualified machine name. c. Configure your network adapter for a fixed IP address. If you cannot get a fixed IP address, disconnect from the network and use the Microsoft loop-back adapter. Otherwise, the embedded WebSphere servers will not run correctly, but the rest of WebSphere Studio will work OK. d. Add the fully qualified hostname (for example, kwright.austin.ibm.com) to c:\winnt\system32\drivers\etc\hosts, and add the current IP address of the machine. 2. Install WebSphere Studio Site Developer 5.01 This guide was tested using CDs 4_1, 4_2, and 4_3 from the WebSphere Portal 5.0 CDs dated August 22, a. Unzip C528TML.exe from CD 4_1 into some directory x. b. Unzip C528UML.exe from CD 4_2, into your x directory, overwriting older files. c. Follow the instructions in the following file on your WebSphere Portal 5 installer CD \Portal Toolkit\InstallGuide\install_studio5.htm The Site Developer install takes about 45 min. 3. Install Site Developer Fixpack 1 a. Follow instructions in the following file on your WebSphere Portal 5 installer CD. \Portal Toolkit\InstallGuide\studio_ptf1.htm 2

3 4. Install the WebSphere Fixpack into Site Developer a. Follow instructions in the following file on your WebSphere Portal 5 installer CD \Portal Toolkit\InstallGuide\was_ptf1.htm 5. Install the WebSphere Portal efixes into Site Developer a. Follow instructions in the following file on your WebSphere Portal 5 installer CD \Portal Toolkit\InstallGuide\was5_efixes.htm 6. Install the Portal Toolkit 5.0 into Site Developer a. Excute the Portal Toolkit install.bat file on the WebSphere Portal 5.0 installer CD as shown below. b. Follow the appropriate part of the PortalToolkit_Install.pdf file in that same directory 3

4 7. Disable the Transcoding Publisher subsystem This is a work-around for PMR a. In <studio installoot>.../portalserver/shared/app/config/services/portletfilterservice.properties, comment-out the lines under the #-- Transcoding --# comment. b. In <studio install root>.../portalserver/shared/app/config/services/portalfilterservice.properties, comment-out everything. c. In <studio install root>./portalserver/shared/app/config/services.properties, comment out the com.ibm.transform.wps.transcodingservice property at the bottom of the file. 8. Configure a Site Developer server a. From the portlet perspective, click Fle-> New-> Other, as shown below. 4

5 b. Create a Server and Server Configuration, as shown below. 5

6 c. Supply your server names, as shown below. These can be anything. 6

7 d. Accept the default port, and click Next. e. Associate your project with the server, as shown below. At this point, you have installed the Portal Toolkit, which includes the Java source debugger, into WebSphere Studio, and you have completed configuring WebSphere Studio to use the debugger. Next, you walk through a simple scenario in which you use the debugger with the Hello World sample application. 9. Create a Site Developer portlet project If you prefer, you can skip this step and use one of your own projects instead. a. Open Site Developer to an empty workspace directory. A clean directory seems to minimize problems configuring a test server. 7

8 b. Switch to portlet perspective c. Import the following file into Site Developer: C:\WebSphereStudio_SD\runtimes\portal_v50\dev\samples\helloworld.war d. Add the.jar files as shown below. 10. Set breakpoints in the Java code Next, add a breakpoint at the beginning of the doview() method, as shown below. 8

9 9

10 11. Start the debugger First, right-click on your project. 10

11 g. Within a couple minutes you see the screen below. h. Set screen options, as shown above, then click OK. 11

12 i. In a few seconds you see the screen below. _j. Click on the Step over icon at the top left side of the screen. 12

13 k. Execution proceeds by one instruction, as shown below. l. Click on the Resume icon which is six icons to the left of the Step over icon. m. Click on the Web Browser tab in the left middle of your screen. 13

14 n. In a few seconds you should see the screen below. o. If you want, you can return to your breakpoint by refreshing the browser view, as if it were an external browser. End of Exercise Conclusion This article summarized how you can install, configure, and start using IBM's Java source debugger (a component of the Portal Toolkit) for portlet development. The article showed you how to install it into WebSphere Studio Site Developer; you could also choose to install it into Websphere Studio Application Developer. Using the debugger, you can trace through your portlet s individual Java instructions, while continuing to use all the other features in WebSphere Studio. You can also see the complete program state at any point in a portlet's execution. Although this article did not cover all the debugger s features, you can learn more by referring to the Portal Toolkit online help that is added to the WebSphere Studio help system when you install the toolkit. 14

15 Related information Portal Toolkit, for the latest updates, fixes and documentation: Portal Toolkit online help: Installed into the WebSphere Studio help system when you install Portal Toolkit. To view in WebSphere Studio, select Help > Help Contents > Portlet developer information. IBM WebSphere Studio InfoCenter: WebSphere Studio Zone: IBM Portlet API Javadoc for WebSphere Portal: IBM WebSphere Portal documentation: WebSphere Portal Zone: About the author Keith Wright has been in software development roles for more than fifteen years. He has worked at IBM for seven years, as a training course developer and as a J2EE architect in WebSphere Business Partner Technical Support. Before coming to IBM, Keith was a developer for a variety of other Fortune 500 companies including United AirLines and Levi Strauss. Keith holds an MBA from the University of San Francisco and a Ph.D. in Information Systems from the University of Texas, in Austin where he lives. You can reach Keith at mkwright@us.ibm.com. Trademarks DB2, IBM, and WebSphere are trademarks or registered trademarks of IBM Corporation in the United States, other countries, or both. Windows and Windows NT are registered trademarks of Microsoft Corporation in the United States, other countries, or both. 15

16 Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Other company, product, and service names may be trademarks or service marks of others. IBM copyright and trademark information: 16