JSP - Debugging

In this chapter, we will discuss Debugging a JSP. It is always difficult testing/debugging a JSP and servlets. JSP and Servlets tend to involve a large amount of client/server interaction, making errors likely but hard to reproduce.
The following are a few hints and suggestions that may aid you in your debugging.

Using System.out.println()

System.out.println() is easy to use as a marker to test whether a certain piece of code is being executed or not. We can print out variable values as well. Consider the following additional points −
  • Since the System object is part of the core Java objects, it can be used everywhere without the need to install any extra classes. This includes Servlets, JSP, RMI, EJB's, ordinary Beans and classes, and standalone applications.
  • Compared to stopping at breakpoints, writing to System.out doesn't interfere much with the normal execution flow of the application, which makes it very valuable when the iming is crucial.
Following is the syntax to use System.out.println() −
System.out.println("Debugging message");
Following example shows how to use System.out.print() −
<%@taglib prefix = "c" uri = "http://java.sun.com/jsp/jstl/core" %>

<html>
   <head><title>System.out.println</title></head>
   <body>
      <c:forEach var = "counter" begin = "1" end = "10" step = "1" >
      
         <c:out value = "${counter-5}"/></br>
         <% System.out.println( "counter = " + pageContext.findAttribute("counter") ); %>
      </c:forEach>
      
   </body>
</html>
Access the above JSP, the browser will show the following result −
-4
-3
-2
-1
0
1
2
3
4
5
If you are using Tomcat, you will also find these lines appended to the end of stdout.log in the logs directory.
counter = 1
counter = 2
counter = 3
counter = 4
counter = 5
counter = 6
counter = 7
counter = 8
counter = 9
counter = 10
This way you can bring variables and other information into the system log which can be analyzed to find out the root cause of the problem or for various other reasons.

Using the JDB Logger

The J2SE logging framework is designed to provide logging services for any class running in the JVM. We can make use of this framework to log any information.
Let us re-write the above example using JDK logger API −
<%@taglib prefix = "c" uri = "http://java.sun.com/jsp/jstl/core" %>
<%@page import = "java.util.logging.Logger" %>

<html>
   <head><title>Logger.info</title></head>
   
   <body>
      <% Logger logger = Logger.getLogger(this.getClass().getName());%>

      <c:forEach var = "counter" begin = "1" end = "10" step = "1" >
      <c:set var = "myCount" value = "${counter-5}" />
      <c:out value = "${myCount}"/></br>
         <% String message = "counter = "
            + pageContext.findAttribute("counter") + "myCount = "
            + pageContext.findAttribute("myCount");
            logger.info( message );
         %>
      </c:forEach>
      
   </body>
</html>
The above code will generate similar result on the browser and in stdout.log, but you will have additional information in stdout.log. We will use the infomethod of the logger because and log the message just for informational purpose. Following is a snapshot of the stdout.log file −
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 1 myCount = -4
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 2 myCount = -3
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 3 myCount = -2
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 4 myCount = -1
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 5 myCount = 0
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 6 myCount = 1
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 7 myCount = 2
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 8 myCount = 3
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 9 myCount = 4
24-Sep-2010 23:31:31 org.apache.jsp.main_jsp _jspService
INFO: counter = 10 myCount = 5
Messages can be sent at various levels by using the convenience functions severe(), warning(), info(), config(), fine(), finer(), and finest(). Here finest() method can be used to log finest information and the severe() method can be used to log severe information.
You can use Log4J Framework to log messages in different files based on their severity levels and importance.

Debugging Tools

NetBeans is a free and open-source Java Integrated Development Environment that supports the development of standalone Java applications and Web applications supporting the JSP and servlet specifications and includes a JSP debugger as well.
NetBeans supports the following basic debugging functionalities −
  • Breakpoints
  • Stepping through code
  • Watchpoints
You can refere to NetBeans documentation to understand above debugging functionalities.

Using JDB Debugger

You can debug JSP and servlets with the same jdb commands you use to debug an applet or an application.
To debug a JSP or servlet, you can debug sun.servlet.http.HttpServer, then observe as HttpServer executes the JSP/servlets in response to HTTP requests we make from a browser. This is very similar to how applets are debugged. The difference is that with applets, the actual program being debugged is sun.applet.AppletViewer.
Most debuggers hide this detail by automatically knowing how to debug applets. Until they do the same for JSP, you have to help your debugger by considering the following −
  • Set your debugger's classpath. This helps you find sun.servlet.http.Http-Server and the associated classes.
  • Set your debugger's classpath. This helps you find your JSP and support classes, typically ROOT\WEB-INF\classes.
Once you have set the proper classpath, start debugging sun.servlet.http.HttpServer. You can set breakpoints in whatever JSP you're interested in debugging, then use a web browser to make a request to the HttpServer for the given JSP (http://localhost:8080/JSPToDebug). The execution here stops at breakpoints.

Using Comments

Comments in your code can help the debugging process in various ways. Comments can be used in lots of other ways in the debugging process.
The JSP uses Java comments and single line (// ...) and multiple line (/* ... */) comments can be used to temporarily remove parts of your Java code. If the bug disappears, take a closer look at the code you just commented and find out the problem.

Client and Server Headers

Sometimes when a JSP doesn't behave as expected, it's useful to look at the raw HTTP request and response. If you're familiar with the structure of HTTP, you can read the request and response and see what exactly is going with those headers.

Important Debugging Tips

Here is a list of some more debugging tips on JSP debugging −
  • Ask a browser to show the raw content of the page it is displaying. This can help identify formatting problems. It's usually an option under the View menu.
  • Make sure the browser isn't caching a previous request's output by forcing a full reload of the page. With Netscape Navigator, use Shift-Reload; with Internet Explorer use Shift-Refresh.

Comments

Post a Comment

Popular posts from this blog

About JSP(Java Server Pages)

What is JSP(Java Server Pages) Java Server Pages (JSP) is a server-side programming technology that enables the creation of dynamic, platform-independent method for building Web-based applications. JSP have access to the entire family of Java APIs, including the JDBC API to access enterprise databases. This tutorial will teach you how to use Java Server Pages to develop your web applications in simple and easy steps.                                                                     Audience For These tutorial has been prepared for the beginners to help them understand basic functionality of Java Server Pages (JSP) to develop your web applications. After completing this tutorial you will find yourself at a moderate level of expertise in using JSP from where you can take yourself to next levels. ...
Read more

JSP - Handling Date

In this chapter, we will discuss how to handle data in JSP. One of the most important advantages of using JSP is that you can use all the methods available in core Java. We will take you through the  Date  class which is available in the  java.util  package; this class encapsulates the current date and time. The Date class supports two constructors. The first constructor initializes the object with the current date and time. Date( ) The following constructor accepts one argument that equals the number of milliseconds that have elapsed since midnight, January 1, 1970. Date(long millisec) Once you have a Date object available, you can call any of the following support methods to play with dates − S.No. Methods & Description 1 boolean after(Date date) Returns true if the invoking Date object contains a date that is later than the one specified by date, otherwise, it returns false. 2 boolean before(Date date) Returns true if the invoking Date obj...
Read more

JSP - Standard Tag Library (JSTL) Tutorial

In this chapter, we will understand the different tags in JSP. The JavaServer Pages Standard Tag Library (JSTL) is a collection of useful JSP tags which encapsulates the core functionality common to many JSP applications. JSTL has support for common, structural tasks such as iteration and conditionals, tags for manipulating XML documents, internationalization tags, and SQL tags. It also provides a framework for integrating the existing custom tags with the JSTL tags. Install JSTL Library To begin working with JSP tages you need to first install the JSTL library. If you are using the Apache Tomcat container, then follow these two steps − Step 1  − Download the binary distribution from  Apache Standard Taglib and unpack the compressed file. Step 2  − To use the Standard Taglib from its  Jakarta Taglibs distribution , simply copy the JAR files in the distribution's 'lib' directory to your application's  webapps\ROOT\WEB-INF\lib  directory. To use...
Read more

JSP - Security

JavaServer Pages and servlets make several mechanisms available to Web developers to secure applications. Resources are protected declaratively by identifying them in the application deployment descriptor and assigning a role to them. Several levels of authentication are available, ranging from basic authentication using identifiers and passwords to sophisticated authentication using certificates. Role Based Authentication The authentication mechanism in the servlet specification uses a technique called  role-based security . The idea is that rather than restricting resources at the user level, you create roles and restrict the resources by role. You can define different roles in file  tomcat-users.xml , which is located off Tomcat's home directory in conf. An example of this file is shown below − <? xml version = '1.0' encoding = 'utf-8' ?> <tomcat-users> <role rolename = "tomcat" /> <role rolename = ...
Read more

JSP - Internationalization| i18n| l10n

In this chapter, we will discuss the concept of Internationalization in JSP. Before we proceed, let us understand the following three important terms − Internationalization (i18n)  − This means enabling a website to provide different versions of content translated into the visitor's language or nationality. Localization (l10n)  − This means adding resources to a website to adapt it to a particular geographical or cultural region for example Hindi translation to a web site. locale  − This is a particular cultural or geographical region. It is usually referred to as a language symbol followed by a country symbol which are separated by an underscore. For example, " en_US " represents english locale for US. There are a number of items which should be taken care of while building up a global Website. This tutorial will not give you complete detail on this but it will give you a good example on how you can offer your Webpage in different languages to the internet...
Read more

JSP - XML Data

When you send the XML data via HTTP, it makes sense to use JSP to handle incoming and outgoing XML documents; for example, RSS documents. As an XML document is merely a bunch of text, creating one through a JSP is much easier than creating an HTML document. Sending XML from a JSP You can send the XML content using JSPs the same way you send HTML. The only difference is that you must set the content type of your page to text/xml. To set the content type, use the  <%@page%>  tag, like this − <%@ page contentType = "text/xml" %> Following example will show how to send XML content to the browser − <%@ page contentType = "text/xml" %> <books> <book> <name> Padam History </name> <author> ZARA </author> <price> 100 </price> </book> </books> Access the above XML using different browsers to see the document tree presentation of the above XML. Processi...
Read more

JSP - Session Tracking

In this chapter, we will discuss session tracking in JSP. HTTP is a "stateless" protocol which means each time a client retrieves a Webpage, the client opens a separate connection to the Web server and the server automatically does not keep any record of previous client request. Maintaining Session Between Web Client And Server Let us now discuss a few options to maintain the session between the Web Client and the Web Server − Cookies A webserver can assign a unique session ID as a cookie to each web client and for subsequent requests from the client they can be recognized using the received cookie. This may not be an effective way as the browser at times does not support a cookie. It is not recommended to use this procedure to maintain the sessions. Hidden Form Fields A web server can send a hidden HTML form field along with a unique session ID as follows − <input type = "hidden" name = "sessionid" value = "12345"> This ...
Read more

JSP - Http Status Codes

In this chapter, we will discuss the Http Status Codes in JSP. The format of the HTTP request and the HTTP response messages are similar and will have the following structure − An initial status line + CRLF (Carriage Return + Line Feed ie. New Line) Zero or more header lines + CRLF A blank line ie. a CRLF An optional message body like file, query data or query output. For example, a server response header looks like the following − HTTP / 1.1 200 OK Content - Type : text / html Header2 : ... ... HeaderN : ... ( Blank Line ) <! doctype ...> <html> <head> ...</ head > <body> ... </ body > </ html > The status line consists of the  HTTP version (HTTP/1.1 in the example) , a status code (200 in the example), and a very short message corresponding to the status code  (OK in the example) . Following table lists out the HTTP status codes and associated messages that might be return...
Read more

JSP - Filters

In this chapter, we will discuss Filters in JSP. Servlet and JSP Filters are Java classes that can be used in Servlet and JSP Programming for the following purposes − To intercept requests from a client before they access a resource at back end. To manipulate responses from server before they are sent back to the client. There are various types of filters suggested by the specifications − Authentication Filters Data compression Filters Encryption Filters Filters that trigger resource access events Image Conversion Filters Logging and Auditing Filters MIME-TYPE Chain Filters Tokenizing Filters XSL/T Filters That Transform XML Content Filters are deployed in the deployment descriptor file  web.xml  and then map to either servlet or JSP names or URL patterns in your application's deployment descriptor. The deployment descriptor file web.xml can be found in  <Tomcat-installation-directory>\conf  directory. When the JSP container starts up...
Read more

JSP - Database Access

In this chapter, we will discuss how to access database with JSP. We assume you have good understanding on how JDBC application works. Before starting with database access through a JSP, make sure you have proper JDBC environment setup along with a database. For more detail on how to access database using JDBC and its environment setup you can go through our  JDBC Tutorial . To start with basic concept, let us create a table and create a few records in that table as follows − Create Table To create the  Employees  table in the EMP database, use the following steps − Step 1 Open a  Command Prompt  and change to the installation directory as follows − C : \> C : \>cd Program Files \MySQL\b in C : \Program Files \MySQL\b in > Step 2 Login to the database as follows − C : \Program Files \MySQL\b in > mysql - u root - p Enter password : ******** mysql > Step 3 Create the  Employee  table in the  TEST  da...
Read more