|
||||||||||
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
public class 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.
Field Summary | |
---|---|
(package private) ErrorID |
errorID
ErrorID categorizing this PortalException instance. |
private org.apache.commons.logging.Log |
log
|
(package private) boolean |
logPending
True if logging is pending on this exception instance (has not yet been logged but potentially will be). |
(package private) java.lang.String |
parameter
Parameter to the ErrorID's template message. |
(package private) boolean |
refreshable
should the user be given an option to retry rendering that same channel instance |
(package private) boolean |
reinstantiable
should the user be given an option to reinstantiate the channel in a given session |
(package private) java.util.Date |
timestamp
The time at which this PortalException instance was instantiated. |
Constructor Summary | |
---|---|
PortalException()
Instantiate a generic PortalException. |
|
PortalException(ErrorID errorid)
Instantiate a PortalException representing an instance of the type of error represented by the given ErrorID. |
|
PortalException(ErrorID errorid,
java.lang.Throwable cause)
Instantiate a PortalException representing an instance of the type of error represented by the given ErrorID, with the given underlying cause. |
|
PortalException(java.lang.String msg)
Creates a new PortalException instance,
with a contained text message. |
|
PortalException(java.lang.String msg,
boolean refresh,
boolean reinstantiate)
Instantiate a PortalException with the given message and refresh, reinstantiate state. |
|
PortalException(java.lang.String msg,
java.lang.Throwable cause)
Instantiate a PortalException with the given message and underlying cause. |
|
PortalException(java.lang.String msg,
java.lang.Throwable cause,
boolean refresh,
boolean reinstantiate)
Instantiate a PortalException with the given message, underlying cause, refresh, and reinstantiate state. |
|
PortalException(java.lang.Throwable cause)
Construct a new portal exception, recording an underlying cause. |
Method Summary | |
---|---|
boolean |
allowRefresh()
Deprecated. use isRefreshable(). |
boolean |
allowReinstantiation()
Deprecated. use isReinstantiable() |
ErrorID |
getErrorID()
Get the ErrorID representing the type of this error. |
java.lang.String |
getParameter()
Get the parameter to the ErrorID template message. |
java.lang.Exception |
getRecordedException()
Deprecated. - use Throwable.getCause() |
java.util.Date |
getTimestamp()
Get the Date at which this PortalException instance was instantiated. |
boolean |
isLogPending()
Determine whether logging is pending on this PortalException. |
boolean |
isRefreshable()
Check if user-mediated referesh is allowed. |
boolean |
isReinstantiable()
Check if user-mediated reinstantiation is allowed. |
void |
setErrorID(ErrorID errorID)
Set the ErrorID categorizing this PortalException. |
void |
setLogPending(boolean b)
Set whether logging is pending on this PortalException. |
void |
setParameter(java.lang.String string)
Set the parameter to the ErrorID template message. |
void |
setRecordedException(java.lang.Exception exc)
Deprecated. use initCause() instead. |
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, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
private final org.apache.commons.logging.Log log
boolean reinstantiable
boolean refreshable
boolean logPending
ErrorID errorID
java.lang.String parameter
java.util.Date timestamp
Constructor Detail |
---|
public PortalException()
public PortalException(java.lang.Throwable cause)
cause
- a Throwable
causing this exceptionpublic PortalException(java.lang.String msg)
PortalException
instance,
with a contained text message.
msg
- describes exceptional conditionpublic PortalException(ErrorID errorid)
errorid
- - type of errorpublic PortalException(java.lang.String msg, java.lang.Throwable cause)
msg
- - message describing the errorcause
- - underlying cause of the errorpublic PortalException(ErrorID errorid, java.lang.Throwable cause)
errorid
- - type of errorcause
- - underlying cause of error.public PortalException(java.lang.String msg, boolean refresh, boolean reinstantiate)
msg
- - message describing the problemrefresh
- - whether refresh is appropriate responsereinstantiate
- - whether reinstantiate is appropriate responsepublic PortalException(java.lang.String msg, java.lang.Throwable cause, boolean refresh, boolean reinstantiate)
msg
- - message describing the problemcause
- - underlying cause of problemrefresh
- - true if refresh is an appropriate responsereinstantiate
- - true if reinstantiate is an appropriate responseMethod Detail |
---|
public boolean isRefreshable()
public boolean allowRefresh()
public boolean isReinstantiable()
public boolean allowReinstantiation()
public java.lang.Exception getRecordedException()
public 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
- true if logging is pendingpublic ErrorID getErrorID()
public void setErrorID(ErrorID errorID)
errorID
- the ErrorID categorizing this PortalException.public java.lang.String getParameter()
public void setParameter(java.lang.String string)
string
- - parameter to ErrorID template message.public java.util.Date getTimestamp()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |