| java.lang.Object
 java.lang.Throwable
java.lang.Exception
java.lang.RuntimeException
org.jasig.portal.PortalException
All known Subclasses: org.jasig.portal.InternalTimeoutException, org.jasig.portal.concurrency.CachingException, org.jasig.portal.ResourceMissingException, org.jasig.portal.security.provider.cas.CasProxyTicketAcquisitionException, org.jasig.portal.GeneralRenderingException, org.jasig.portal.groups.GroupsException, org.jasig.portal.concurrency.LockingException, org.jasig.portal.AuthorizationException, org.jasig.portal.security.PortalSecurityException,
| PortalException | | public class PortalException extends RuntimeException (Code) | | 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.
author:
Peter Kharchenko
version:
$Revision: 36782 $ |
| Field Summary | |
| ErrorID | errorID
ErrorID categorizing this PortalException instance. | | boolean | logPending
True if logging is pending on this exception instance
(has not yet been logged but potentially will be). | | String | parameter
Parameter to the ErrorID's template message. | | boolean | refreshable
| | boolean | reinstantiable
| | Date | timestamp
The time at which this PortalException instance was instantiated. |
| Constructor Summary | |
| public | PortalException()
Instantiate a generic PortalException.
Instantiating a bare, no-message, no ErrorID, no frills
PortalException is pretty anti-social. | | public | PortalException(Throwable cause)
Construct a new portal exception, recording an
underlying cause. | | public | PortalException(String msg)
Creates a new PortalException instance,
with a contained text message. | | public | PortalException(ErrorID errorid)
Instantiate a PortalException representing an instance of the
type of error represented by the given ErrorID. | | public | PortalException(String msg, Throwable cause)
Instantiate a PortalException with the given message and underlying cause. | | public | PortalException(ErrorID errorid, Throwable cause)
Instantiate a PortalException representing an instance of the type of error
represented by the given ErrorID, with the given underlying cause. | | public | PortalException(String msg, boolean refresh, boolean reinstantiate)
Instantiate a PortalException with the given message and refresh,
reinstantiate state. | | public | PortalException(String msg, Throwable cause, boolean refresh, boolean reinstantiate)
Instantiate a PortalException with the given message, underlying cause,
refresh, and reinstantiate state. |
| Method Summary | |
| public boolean | allowRefresh()
Legacy support for old name of property accessor. | | public boolean | allowReinstantiation()
| | public ErrorID | getErrorID()
Get the ErrorID representing the type of this error. | | public String | getParameter()
Get the parameter to the ErrorID template message. | | public Exception | getRecordedException()
Retrieve an optionally recorded exception that
caused the error. | | public Date | getTimestamp()
Get the Date at which this PortalException instance was instantiated. | | public boolean | isLogPending()
Determine whether logging is pending on this PortalException. | | public boolean | isRefreshable()
Check if user-mediated referesh is allowed. | | public boolean | isReinstantiable()
Check if user-mediated reinstantiation is allowed. | | public void | setErrorID(ErrorID errorID)
Set the ErrorID categorizing this PortalException. | | public void | setLogPending(boolean b)
Set whether logging is pending on this PortalException. | | public void | setParameter(String string)
Set the parameter to the ErrorID template message. | | public void | setRecordedException(Exception exc)
Allows to record the exception that caused the error. | | public 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. | | public void | setReinstantiable(boolean reinstantiate)
Set if the user should be presented with an option
to reinstantiate the component (channel) that generated
the error. |
| errorID | | ErrorID errorID(Code) | | ErrorID categorizing this PortalException instance.
|
| logPending | | boolean logPending(Code) | | True if logging is pending on this exception instance
(has not yet been logged but potentially will be). True
if all the logging that ought to happen has happened.
|
| parameter | | String parameter(Code) | | Parameter to the ErrorID's template message.
|
| refreshable | | boolean refreshable(Code) | | should the user be given an option to retry rendering
that same channel instance
|
| reinstantiable | | boolean reinstantiable(Code) | | should the user be given an option to reinstantiate
the channel in a given session
|
| timestamp | | Date timestamp(Code) | | The time at which this PortalException instance was instantiated.
|
| PortalException | | public PortalException()(Code) | | Instantiate a generic PortalException.
Instantiating a bare, no-message, no ErrorID, no frills
PortalException is pretty anti-social. Wouldn't you rather
use a constructor that provides more information?
|
| PortalException | | public PortalException(Throwable cause)(Code) | | Construct a new portal exception, recording an
underlying cause.
Parameters:
cause - a Throwable causing this exception |
| PortalException | | public PortalException(String msg)(Code) | | Creates a new PortalException instance,
with a contained text message.
Parameters:
msg - describes exceptional condition |
| PortalException | | public PortalException(ErrorID errorid)(Code) | | Instantiate a PortalException representing an instance of the
type of error represented by the given ErrorID.
Parameters:
errorid - - type of error |
| PortalException | | public PortalException(String msg, Throwable cause)(Code) | | Instantiate a PortalException with the given message and underlying cause.
Parameters:
msg - - message describing the error
Parameters:
cause - - underlying cause of the error |
| PortalException | | public PortalException(ErrorID errorid, Throwable cause)(Code) | | Instantiate a PortalException representing an instance of the type of error
represented by the given ErrorID, with the given underlying cause.
Parameters:
errorid - - type of error
Parameters:
cause - - underlying cause of error. |
| PortalException | | public PortalException(String msg, boolean refresh, boolean reinstantiate)(Code) | | Instantiate a PortalException with the given message and refresh,
reinstantiate state.
Parameters:
msg - - message describing the problem
Parameters:
refresh - - whether refresh is appropriate response
Parameters:
reinstantiate - - whether reinstantiate is appropriate response |
| PortalException | | public PortalException(String msg, Throwable cause, boolean refresh, boolean reinstantiate)(Code) | | Instantiate a PortalException with the given message, underlying cause,
refresh, and reinstantiate state.
Parameters:
msg - - message describing the problem
Parameters:
cause - - underlying cause of problem
Parameters:
refresh - - true if refresh is an appropriate response
Parameters:
reinstantiate - - true if reinstantiate is an appropriate response |
| allowRefresh | | public boolean allowRefresh()(Code) | | Legacy support for old name of property accessor.
isRefreshable() |
| allowReinstantiation | | public boolean allowReinstantiation()(Code) | | Legacy support for old name of property accessor
isRinstantiable(); |
| getErrorID | | public ErrorID getErrorID()(Code) | | Get the ErrorID representing the type of this error.
the error ID |
| getParameter | | public String getParameter()(Code) | | Get the parameter to the ErrorID template message.
the parameter |
| getRecordedException | | public Exception getRecordedException()(Code) | | Retrieve an optionally recorded exception that
caused the error.
the cause if it is an Exception |
| getTimestamp | | public Date getTimestamp()(Code) | | Get the Date at which this PortalException instance was instantiated.
Returns the timestamp. |
| isLogPending | | public boolean isLogPending()(Code) | | Determine whether logging is pending on this PortalException.
true if the log is pending, otherwise false |
| isRefreshable | | public boolean isRefreshable()(Code) | | Check if user-mediated referesh is allowed.
true if refresh allowed, false otherwise. |
| isReinstantiable | | public boolean isReinstantiable()(Code) | | Check if user-mediated reinstantiation is allowed.
true if reinstantiation allowed, false otherwise |
| setErrorID | | public void setErrorID(ErrorID errorID)(Code) | | Set the ErrorID categorizing this PortalException.
Parameters:
errorID - the ErrorID categorizing this PortalException. |
| setLogPending | | public void setLogPending(boolean b)(Code) | | Set whether logging is pending on this PortalException.
Parameters:
b - true if logging is pending |
| setParameter | | public void setParameter(String string)(Code) | | Set the parameter to the ErrorID template message.
Parameters:
string - - parameter to ErrorID template message. |
| setRecordedException | | public void setRecordedException(Exception exc)(Code) | | Allows to record the exception that caused the error.
The exception information can later be used in error
reporting and user interaction.
Parameters:
exc - an Exception value |
| setRefreshable | | public void setRefreshable(boolean refresh)(Code) | | Set if the user should be presented with an option
to retry the same operation on the component that
has generated the error.
Parameters:
refresh - a boolean value |
| setReinstantiable | | public void setReinstantiable(boolean reinstantiate)(Code) | | Set if the user should be presented with an option
to reinstantiate the component (channel) that generated
the error.
Parameters:
reinstantiate - a boolean value |
|
|