org.jasig.portal
Class PortalException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          java.lang.RuntimeException
              org.jasig.portal.PortalException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AuthorizationException, CachingException, CasProxyTicketAcquisitionException, GeneralRenderingException, GroupsException, InconsistentPortletModelException, InternalTimeoutException, InvalidPortalRequestException, LockingException, PortalSecurityException, PortletActionFailureException, PortletDispatchException, PortletLoadFailureException, ResourceMissingException

public class PortalException
extends RuntimeException

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.

Version:

$Revision: 19776 $

Author:

Peter Kharchenko

See Also:

Serialized Form

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, Throwable cause)
Instantiate a PortalException representing an instance of the type of error represented by the given ErrorID, with the given underlying cause.

PortalException(String msg)
Creates a new PortalException instance, with a contained text message.

PortalException(String msg, boolean refresh, boolean reinstantiate)
Instantiate a PortalException with the given message and refresh, reinstantiate state.

PortalException(String msg, Throwable cause)
Instantiate a PortalException with the given message and underlying cause.

PortalException(String msg, Throwable cause, boolean refresh, boolean reinstantiate)
Instantiate a PortalException with the given message, underlying cause, refresh, and reinstantiate state.

PortalException(Throwable cause)
Construct a new portal exception, recording an underlying cause.

Method Summary

ErrorID	getErrorID() Get the ErrorID representing the type of this error.
String	getParameter() Get the parameter to the ErrorID template message.
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(String string) Set the parameter to the ErrorID template message.
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

Constructor Detail

PortalException

public PortalException()

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)

Construct a new portal exception, recording an underlying cause.

Parameters:

cause - a Throwable causing this exception

PortalException

public PortalException(String msg)

Creates a new PortalException instance, with a contained text message.

Parameters:

msg - describes exceptional condition

PortalException

public PortalException(ErrorID errorid)

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)

Instantiate a PortalException with the given message and underlying cause.

Parameters:

msg - - message describing the error

cause - - underlying cause of the error

PortalException

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.

Parameters:

errorid - - type of error

cause - - underlying cause of error.

PortalException

public PortalException(String msg,
                       boolean refresh,
                       boolean reinstantiate)

Instantiate a PortalException with the given message and refresh, reinstantiate state.

Parameters:

msg - - message describing the problem

refresh - - whether refresh is appropriate response

reinstantiate - - whether reinstantiate is appropriate response

PortalException

public PortalException(String msg,
                       Throwable cause,
                       boolean refresh,
                       boolean reinstantiate)

Instantiate a PortalException with the given message, underlying cause, refresh, and reinstantiate state.

Parameters:

msg - - message describing the problem

cause - - underlying cause of problem

refresh - - true if refresh is an appropriate response

reinstantiate - - true if reinstantiate is an appropriate response

Method Detail

isRefreshable

public boolean isRefreshable()

Check if user-mediated referesh is allowed.

Returns:

true if refresh allowed, false otherwise.

isReinstantiable

public boolean isReinstantiable()

Check if user-mediated reinstantiation is allowed.

Returns:

true if reinstantiation allowed, false otherwise

setRefreshable

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.

Parameters:

refresh - a boolean value

setReinstantiable

public void setReinstantiable(boolean reinstantiate)

Set if the user should be presented with an option to reinstantiate the component (channel) that generated the error.

Parameters:

reinstantiate - a boolean value

isLogPending

public boolean isLogPending()

Determine whether logging is pending on this PortalException.

Returns:

true if the log is pending, otherwise false

setLogPending

public void setLogPending(boolean b)

Set whether logging is pending on this PortalException.

Parameters:

b - true if logging is pending

getErrorID

public ErrorID getErrorID()

Get the ErrorID representing the type of this error.

Returns:

the error ID

setErrorID

public void setErrorID(ErrorID errorID)

Set the ErrorID categorizing this PortalException.

Parameters:

errorID - the ErrorID categorizing this PortalException.

getParameter

public String getParameter()

Get the parameter to the ErrorID template message.

Returns:

the parameter

setParameter

public void setParameter(String string)

Set the parameter to the ErrorID template message.

Parameters:

string - - parameter to ErrorID template message.

getTimestamp

public Date getTimestamp()

Get the Date at which this PortalException instance was instantiated.

Returns:

Returns the timestamp.