|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.lang.Throwable
java.lang.Exception
org.jasig.portal.PortalException
Base portal exception class. Information contained in this class allows ErrorChannel to handle errors gracefully. This class also reports itself to the ProblemsTable whenever it is instantiated. The Problems servlet displays recently reported PortalExceptions.
Constructor Summary | |
PortalException()
|
|
PortalException(ErrorID errorid)
|
|
PortalException(ErrorID errorid,
java.lang.Exception exc)
|
|
PortalException(java.lang.Exception exc)
Construct a new portal exception, recording the exception that originally caused the error. |
|
PortalException(java.lang.String msg)
Creates a new PortalException instance,
with a contained text message. |
|
PortalException(java.lang.String msg,
boolean refresh,
boolean reinstantiate)
|
|
PortalException(java.lang.String msg,
java.lang.Exception exc)
|
|
PortalException(java.lang.String msg,
java.lang.Exception exc,
boolean refresh,
boolean reinstantiate)
|
Method Summary | |
boolean |
allowRefresh()
Legacy support for badly named property accessor |
boolean |
allowReinstantiation()
Legacy support for badly named property accessor |
ErrorID |
getErrorID()
|
java.lang.String |
getMessage()
Override Exception getMessage() method to
append the recorded exception message, if applicable |
java.lang.String |
getParameter()
|
java.lang.Exception |
getRecordedException()
Retrieve an optionally recorded exception that caused the error. |
java.util.Date |
getTimestamp()
|
boolean |
isLogPending()
|
boolean |
isRefreshable()
Check if user-mediated referesh is allowed. |
boolean |
isReinstantiable()
Check if user-mediated reinstantiation is allowed. |
void |
printStackTrace()
Overrides Exception printStackTrace() method |
void |
printStackTrace(java.io.PrintStream stream)
Overrides Exception printStackTrace(PrintStream stream) method |
void |
printStackTrace(java.io.PrintWriter writer)
Overrides Exception printStackTrace(PrintWriter writer)
method to print recorded exception stack trace if applicable |
void |
setErrorID(ErrorID errorID)
|
void |
setLogPending(boolean b)
|
void |
setParameter(java.lang.String string)
|
void |
setRecordedException(java.lang.Exception exc)
Allows to record the exception that caused the error. |
void |
setRefreshable(boolean refresh)
Set if the user should be presented with an option to retry the same operation on the component that has generated the error. |
void |
setReinstantiable(boolean reinstantiate)
Set if the user should be presented with an option to reinstantiate the component (channel) that generated the error. |
Methods inherited from class java.lang.Throwable |
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, setStackTrace, toString |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public PortalException()
public PortalException(java.lang.Exception exc)
exc
- an Exception
valuepublic PortalException(java.lang.String msg)
PortalException
instance,
with a contained text message.
msg
- a String
valuepublic PortalException(ErrorID errorid)
public PortalException(java.lang.String msg, java.lang.Exception exc)
public PortalException(ErrorID errorid, java.lang.Exception exc)
public PortalException(java.lang.String msg, boolean refresh, boolean reinstantiate)
public PortalException(java.lang.String msg, java.lang.Exception exc, boolean refresh, boolean reinstantiate)
Method Detail |
public boolean isRefreshable()
public boolean allowRefresh()
public boolean isReinstantiable()
boolean
valuepublic boolean allowReinstantiation()
public java.lang.Exception getRecordedException()
Exception
valuepublic void setRefreshable(boolean refresh)
refresh
- a boolean
valuepublic void setReinstantiable(boolean reinstantiate)
reinstantiate
- a boolean
valuepublic void setRecordedException(java.lang.Exception exc)
exc
- an Exception
valuepublic boolean isLogPending()
true
if the log is pending, otherwise false
public void setLogPending(boolean b)
b
- public ErrorID getErrorID()
public void setErrorID(ErrorID errorID)
errorID
- public java.lang.String getParameter()
public void setParameter(java.lang.String string)
string
- public java.lang.String getMessage()
Exception
getMessage() method to
append the recorded exception message, if applicable
public void printStackTrace()
Exception
printStackTrace() method
public void printStackTrace(java.io.PrintWriter writer)
Exception
printStackTrace(PrintWriter writer)
method to print recorded exception stack trace if applicable
public void printStackTrace(java.io.PrintStream stream)
Exception
printStackTrace(PrintStream stream) method
public java.util.Date getTimestamp()
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |