Package javax.portlet
Class UnavailableException
java.lang.Object
java.lang.Throwable
java.lang.Exception
javax.portlet.PortletException
javax.portlet.UnavailableException
- All Implemented Interfaces:
Serializable
The portlet should throw the
UnavailableException
when
the portlet is either temporarily or permanently unavailable to handle requests.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionUnavailableException
(String text) Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.UnavailableException
(String text, int seconds) Constructs a new exception with a descriptive message indicating that the portlet is temporarily unavailable and giving an estimate of how long it will be unavailable. -
Method Summary
Modifier and TypeMethodDescriptionint
Returns the time in seconds for which the portlet can be expected to be unavailable.boolean
Returns aboolean
indicating whether the portlet is permanently unavailable.Methods inherited from class javax.portlet.PortletException
getCause, printStackTrace, printStackTrace, printStackTrace
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString
-
Field Details
-
permanent
private boolean permanent -
seconds
private int seconds
-
-
Constructor Details
-
UnavailableException
Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.- Parameters:
text
- aString
specifying the descriptive message
-
UnavailableException
Constructs a new exception with a descriptive message indicating that the portlet is temporarily unavailable and giving an estimate of how long it will be unavailable.In some cases, the portlet cannot make an estimate. For example, the portlet might know that a server it needs is not running, but it might not be able to report how long it will take to be restored to functionality. This can be indicated with a negative or zero value for the
seconds
argument.- Parameters:
text
- aString
specifying the descriptive message. This message can be written to a log file or displayed for the user.seconds
- an integer specifying the number of seconds for which the portlet expects to be unavailable; if this is zero or negative, it indicates that the portlet cannot make an estimate.
-
-
Method Details
-
isPermanent
public boolean isPermanent()Returns aboolean
indicating whether the portlet is permanently unavailable. If so, something is wrong with the portlet, and the system administrator must take some corrective action.- Returns:
true
if the portlet is permanently unavailable;false
if the portlet is temporarily unavailable.
-