javax.servlet
Class ServletException

java.lang.Object
  |
  +--java.lang.Throwable
        |
        +--java.lang.Exception
              |
              +--javax.servlet.ServletException

Direct Known Subclasses:

UnavailableException

public class ServletException

extends java.lang.Exception

Defines a general exception a servlet throws when it encounters difficulty.

Version:

$Version$

Author:

Various

See Also:

Serialized Form

Constructor Summary

ServletException()
Constructs a new servlet exception.

ServletException(java.lang.String message)
Constructs a new servlet exception with the message you specify.

ServletException(java.lang.String message, java.lang.Throwable rootCause)
Constructs a new servlet exception when the servlet needs to throw an exception and include a message about another exception that interfered with its normal operation.

ServletException(java.lang.Throwable rootCause)
Constructs a new servlet exception as a result of a system exception and uses the localized system exception message.

Method Summary

java.lang.Throwable

getRootCause() Returns the Throwable system exception that makes this servlet exception necessary.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ServletException

public ServletException()

Constructs a new servlet exception.

ServletException

public ServletException(java.lang.String message)

Constructs a new servlet exception with the message you specify. The message can be written to the server log file or displayed for the user.

Parameters:

message - a String specifying the text of the exception message

ServletException

public ServletException(java.lang.String message,
                        java.lang.Throwable rootCause)

Constructs a new servlet exception when the servlet needs to throw an exception and include a message about another exception that interfered with its normal operation.

Parameters:

message - a String containing the text of the exception message

rootCause - the Throwable exception that interfered with the servlet's normal operation, making this servlet exception necessary

ServletException

public ServletException(java.lang.Throwable rootCause)

Constructs a new servlet exception as a result of a system exception and uses the localized system exception message.

The system exception is a Throwable exception. This method calls the getLocalizedMessage method on the Throwable exception to get a localized exception message. If you subclass ServletException, you can override this method to create an exception message designed for a specific locale.

Parameters:

rootCause - the system exception that makes this servlet exception necessary

Method Detail

getRootCause

public java.lang.Throwable getRootCause()

Returns the Throwable system exception that makes this servlet exception necessary.

You can use any of the methods defined in java.lang.Throwable on the Throwable object, including getMessage to get a text message about the exception, getLocalizedMessage to get a localized exception message, and printStackTrace.

Returns:

the Throwable system exception that makes this servlet exception necessary