Welcome!

Weblogic Authors: Yeshim Deniz, Elizabeth White, Michael Meiner, Michael Bushong, Avi Rosenthal

Related Topics: Weblogic, Eclipse

Weblogic: Article

Configuring Eclipse for Remote Debugging a WebLogic Java Application

A J2EE application deployed in the WebLogic server may be debugged in the Eclipse ID

A J2EE application deployed in the WebLogic server may be debugged in the Eclipse IDE with the remote debugger provided by Eclipse. Without a debugger the error message has to be obtained from the application server error log to debug the application.

With the remote debugger provided by Eclipse, exception breakpoints may be added to the application file to debug. When an application is run in WebLogic and the application generates an error, the application gets suspended and the Eclipse IDE Debug perspective displays the error. In this tutorial we will debug a WebLogic Application Server application in Eclipse.

To debug an application deployed in the WebLogic Server from Eclipse, start the WebLogic Server in debug mode and configure a remote debugging configuration in Eclipse. Next, connect the Eclipse remote debugger to the WebLogic Server and debug applications running in the server. We will develop an example servlet application and deploy the application in WebLogic. First, the servlet is run without any error and subsequently an error is introduced in the servlet to demonstrate the remote debugging feature in Eclipse.

Preliminary Setup
Download the WebLogic 8.1 Application Server and install it. Download the Eclipse 3.0 or Eclipse 3.02 zip file eclipse-SDK-3.0-win32.zip (www.eclipse.org/downloads/index.php) and install it as well.

Developing a WebLogic Application
After installing the WebLogic Server and the Eclipse IDE, develop a servlet application to run and debug in the WebLogic Server. The example servlet application consists of a doGet method, which prints out a String message to the browser. The example servlet, WebLogicServlet.java, is shown in Listing 1.

Create a directory structure for a Web application. Create a WEB-INF directory and a classes directory in the WEB-INF directory. Create a package directory servlets for the example servlet and copy the WebLogicServlet.java file to the servlets directory. Create a web.xml deployment descriptor for the Web application. Copy the web.xml file to the WEB-INF directory. Listing 2 shows the web.xml file.

The example servlet is mapped to URL pattern /weblogic. The structure of the Web application is illustrated below.


/WEB-INF
| |
web.xml classes
|
servlets
|
WebLogicServlet.class
The compiling, packaging, and deploying of the Web application is done in the Eclipse IDE with an Ant build.xml file. Develop an Ant build.xml file that consists of targets to compile the WebLogicServlet.java and package and deploy the webapp.war Web application. Listing 3 shows the build.xml file.

Table 1 shows the properties of the build.xml file. Table 2 shows the file's targets.

Set the debug attribute of the javac task in the build target to true to enable compilation in debug mode. By compiling an application in debug mode the line number, which generates the exception in a WebLogic Server application, gets displayed in the Debug perspective. Create a new project in the Eclipse IDE. Select File>New>Project. The New Project frame gets displayed. In the New Project wizard select Java>Java Project. Click on the Next button. The New Java Project frame gets displayed. In the New Java Project frame specify a Project Name, EclipseWebLogic for example, and click on the Next button. In the Java Settings frame add a source folder to the project with the Add Folder button.

The New Source Folder frame gets displayed. In the New Source Folder frame specify a folder name, src for example. A source folder gets added to the project. A message prompt gets displayed to update the source folder and the output folder. In the New Java Project frame click on the Finish button to create the project. A new project gets added to the Eclipse IDE. Next, select File>Import to import the example servlet source folder to the project. In the Import Select frame select File System and click on the Next button. In the Import File System frame select the src folder and the build.xml file and then click on the Finish button. The servlet source files get added to the project.

Run the build.xml file to compile, package, and deploy the servlet Web application to the WebLogic Server. Right-click on the build.xml file and select Run>Ant Build. The Web application .war file webapp.war gets generated and is deployed to the WebLogic 8.1 Application Server applications directory. Next, start the WebLogic Server with the bin/run script. Invoke the example servlet in a Web browser with the URL http://localhost:7001/webapp/weblogic. The WebLogicServlet runs in the WebLogic Server and the output gets displayed in the browser.

Configuring a Remote Debugging Configuration in Eclipse
To remote debug a WebLogic application in Eclipse start the WebLogic Server in debug mode. Set the WebLogic Server in debug mode by setting the debug options in the startWebLogic batch script file. The debugging provided by WebLogic is based on the Java Platform Debugger Architecture (JPDA). Set the JAVA_OPTS variable as:

set JAVA_OPTS= -Xdebug -Xnoagent
-Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n %JAVA_OPTS%

Table 3 shows the different debug parameters. For further explanation of the debug settings refer to the JPDA documentation (http://java.sun.com/j2se/1.4.2/docs/guide/jpda/). To demonstrate the remote debugging feature of Eclipse, add an exception to the WebLogicServlet.java file. For example, add a NullPointerException to the WebLogicServlet.java class. Replace

out.println("Eclipse WebLogic Remote Debugging");

with

String str=null;
out.println(str.toString());

Next, configure a debug configuration for the Eclipse project. Select the Debug option in the Debug option list. The Debug frame gets displayed. In the Debug frame select the Remote Java Application node. Right-click on the node and select New. In the Debug configuration frame specify a name for the Debug configuration. Select the project that is to be debugged. Select the EclipseWebLogic project previously created in the Eclipse IDE. Select the default value for Connection Type. In the Connection Properties, specify localhost as the Host and specify the Port as the port that was specified in the startWebLogic batch script of the WebLogic server, 8787. Click on the Apply button. A remote Java application debug configuration gets added.

Next add exception breakpoints to the WebLogicServlet.java file. To demonstrate the remote debug feature of Eclipse a NullPointerException was added to the WebLogicServlet.java file earlier in this section. To add a breakpoint to the servlet class, Select Run>Add Java Exception Breakpoint. In the Add Java Exception Breakpoint frame select the NullPointerException. The NullPointerException breakpoint gets added to the servlet class. If a NullPointerException is generated in the servlet application in the WebLogic Server, the application gets suspended and the Debug perspective of the Eclipse IDE displays the exception.

Remote Debugging a WebLogic Application
After configuring a debug configuration for the example servlet application deployed in the WebLogic Server, we will debug the servlet application in the Eclipse IDE. Create a webapp.war Web application from the modified (with the NullPointerException) WebLogicServlet.class file with the build.xml file as explained in the "Developing a WebLogic Application" section. Start the WebLogic Server. The server starts in debug mode with the debug options specified in the startWebLogic batch file.

Next, select the EclipseDebug debug configuration in the Debug frame. Click on the Debug button to connect the remote debugger to the WebLogic Server. The Eclipse remote debugger gets connected to the WebLogic Server. Select the Debug Perspective button to display the debug perspective of the Eclipse IDE. In the Debug perspective the remote debugger is shown connected to the WebLogic server at localhost, port 8787. Access the WebLogicServlet in the WebLogic Server with the URL http://localhost:7001/webapp/weblogic. Because the servlet has a NullPointerException, the servlet gets suspended with a NullPointerException in the Debug perspective. The line that produced the exception gets displayed.

The line that throws the exception is the out.println(str.toString()); code line. The servlet application may be debugged with the different debug options listed by selecting Run in the Eclipse IDE.

Summary
In this tutorial a WebLogic application was debugged in the Eclipse IDE. A WebLogic application may also be debugged from another IDE such as JDeveloper.

More Stories By Deepak Vohra

Deepak Vohra is a Sun Certified Java 1.4 Programmer and a Web developer.

More Stories By Ajay Vohra

Ajay Vohra is a senior solutions architect with DataSynapse Inc.

Comments (3) View Comments

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.


Most Recent Comments
Sreedhar 05/18/06 01:15:58 PM EDT

Does any one know how to do remote debug ging in clustered environment??

Neena 03/09/06 05:59:07 PM EST

Do you know how to debug a Clustered WebLogic Environment or where we can get the information on to set up debugging for Cluster?

SYS-CON Brazil News Desk 01/18/06 07:19:38 PM EST

A J2EE application deployed in the WebLogic server may be debugged in the Eclipse IDE with the remote debugger provided by Eclipse. Without a debugger the error message has to be obtained from the application server error log to debug the application.

@ThingsExpo Stories
"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.
"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.
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...
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...
"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.
"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.
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.
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...
"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.
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...
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...
SYS-CON Events announced today that Cloud Academy named "Bronze Sponsor" of 21st International Cloud Expo which will take place October 31 - November 2, 2017 at the Santa Clara Convention Center in Santa Clara, CA. Cloud Academy is the industry’s most innovative, vendor-neutral cloud technology training platform. Cloud Academy provides continuous learning solutions for individuals and enterprise teams for Amazon Web Services, Microsoft Azure, Google Cloud Platform, and the most popular cloud com...
SYS-CON Events announced today that Cloudistics, an on-premises cloud computing company, 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. Cloudistics delivers a complete public cloud experience with composable on-premises infrastructures to medium and large enterprises. Its software-defined technology natively converges network, storage, compute, virtualization, and ...
SYS-CON Events announced today that CHEETAH Training & Innovation 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. CHEETAH Training & Innovation is a cloud consulting and IT training firm specializing in improving clients cloud strategies and infrastructures for medium to large companies.
SYS-CON Events announced today that Datanami 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. Datanami is a communication channel dedicated to providing insight, analysis and up-to-the-minute information about emerging trends and solutions in Big Data. The publication sheds light on all cutting-edge technologies including networking, storage and applications, and thei...
The current age of digital transformation means that IT organizations must adapt their toolset to cover all digital experiences, beyond just the end users’. Today’s businesses can no longer focus solely on the digital interactions they manage with employees or customers; they must now contend with non-traditional factors. Whether it's the power of brand to make or break a company, the need to monitor across all locations 24/7, or the ability to proactively resolve issues, companies must adapt to...