JavaRanch Home    
 
This page:         last edited 19 August 2010         What's Changed?         Edit

Illegal State Exception   

The most common cause of this exception is a servlet or JSP attempting to write to the output stream after the response has been committed.

For servlets, the easiest way to avoid this is to branch the code in your service method in such a way as to insure that calls to HttpServletResponse.sendRedirect or RequestDispatcher.forward are always the last call made before the end of the method. This can be achieved by adding a return call just after either of these.

Example:


public void doGet(HttpServletRequest  request, 
                  HttpServletResponse response) throws ServletExceptionIOException{

    if("client".equals(request.getParameter("user_type"))){
        response.sendRedirect("client-screen.jsp");
        return;  // <-------  This return statement prevents any further writing to the outputStream
    }
    //
    // Other code that may write to the outputStream....
    //
}


Another way this can happen is by attempting to redirect from within the middle of a JSP page, eg:


...
<div>hello world</div>
<%
 if ("not logged in")
        response.sendRedirect("login.jsp");
%>
<div>more stuff</div>
...


Another common place where an IllegalStateException is likely to occur is in a JSP that attempts to stream binary data. JSPs are primarily designed to format output as HTML. With HTML, white space characters are ignored. It is not uncommon for JSP compilers to inject their own white space charaters to the beginning and/or end of the output stream. Line breaks in the developer's code can also be interpreted as white space in the output stream. These white space characters can interfere with the generated servlet's ability to create and stream the binary outputdata, resulting in the IllegalStateException.

The simple solution to this problem is to always use a servlet for streaming binary data.


NOTE: Tomcat 5.5.X seems to be lenient on throwing an IllegalStateException. Although the reponse has been flushed, it seems to allow the redirection, without throwing any exception. Refer to this thread

Another -completely unrelated- source of this exception is calling the remove method of JavaDoc:java.util.Iterator more than once between calls to next.

Back to the JspFaq ServletsFaq ScwcdFaq


JavaRanchContact us — Copyright © 1998-2014 Paul Wheaton