org.apache.jetspeed.portlet
Class PortletException

java.lang.Object
  javax.servlet.ServletException
      org.apache.jetspeed.portlet.PortletException

Direct Known Subclasses:

AccessDeniedException, CredentialSecretNotSetException, PortletServiceException, UnavailableException

public class PortletException
extends javax.servlet.ServletException

The PortletException class defines a general exception that a portlet can throw when it encounters difficulty.

Since:

4.1

Constructor Summary

PortletException()
Constructs a new portlet exception.

PortletException(java.lang.String text)
Constructs a new portlet exception with the given text.

PortletException(java.lang.String text, java.lang.Throwable cause)
Constructs a new portlet exception when the portlet needs to throw an exception and include a message about the "root case" that interfered with its normal operation, including a description message.

PortletException(java.lang.Throwable cause)
Constructs a new portlet exception when the portlet needs to throw an exception.

Method Summary

void	printStackTrace() Prints the stack trace of this exception to the standard error stream.
void	java.io.PrintStream)">printStackTrace(java.io.PrintStream out) Prints the stack trace of this exception to the specified print stream.
void	java.io.PrintWriter)">printStackTrace(java.io.PrintWriter out) Prints the stack trace of this exception to the specified print writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletException

public PortletException()

Constructs a new portlet exception.

PortletException

public PortletException(java.lang.String text)

Constructs a new portlet exception with the given text. The portlet container may use the text write it to a log.

Parameters:

text - the exception text

PortletException

public PortletException(java.lang.String text,
                        java.lang.Throwable cause)

Constructs a new portlet exception when the portlet needs to throw an exception and include a message about the "root case" that interfered with its normal operation, including a description message.

Parameters:

text - the exception text

cause - the root cause

PortletException

public PortletException(java.lang.Throwable cause)

Constructs a new portlet exception when the portlet needs to throw an exception. The exception's message is based on the localized message of the underlying exception.

Parameters:

cause - the root cause

Method Detail

printStackTrace

public void printStackTrace()

Prints the stack trace of this exception to the standard error stream.

java.io.PrintStream)">

printStackTrace

public void printStackTrace(java.io.PrintStream out)

Prints the stack trace of this exception to the specified print stream.

Parameters:

out - the PrintStream to use for output

java.io.PrintWriter)">

printStackTrace

public void printStackTrace(java.io.PrintWriter out)

Prints the stack trace of this exception to the specified print writer.

Parameters:

out - the PrintWriter to use for output.