| java.lang.Object
 java.lang.Throwable
java.lang.Exception
javax.portlet.PortletException
javax.portlet.UnavailableException
| UnavailableException | | public class UnavailableException extends PortletException (Code) | | The portlet should throw the UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests.
|
| Constructor Summary | |
| public | UnavailableException(String text)
Constructs a new exception with a descriptive
message indicating that the portlet is permanently
unavailable. | | public | 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.
In some cases, the portlet cannot make an estimate. |
| Method Summary | |
| public int | getUnavailableSeconds()
Returns the time in seconds for which the portlet can be expected to
be unavailable.
If the portlet is called again while it is still unavailable, it
indicates the same time estimate. | | public boolean | isPermanent()
Returns a boolean indicating
whether the portlet is permanently unavailable. |
| UnavailableException | | public UnavailableException(String text)(Code) | | Constructs a new exception with a descriptive
message indicating that the portlet is permanently
unavailable.
Parameters:
text - a String specifying thedescriptive message |
| UnavailableException | | public UnavailableException(String text, int seconds)(Code) | | 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 - a String specifying thedescriptive message. This message can be writtento a log file or displayed for the user.
Parameters:
seconds - an integer specifying the number of secondsfor which the portlet expects to be unavailable; ifthis is zero or negative, it indicates that the portletcannot make an estimate. |
| getUnavailableSeconds | | public int getUnavailableSeconds()(Code) | | Returns the time in seconds for which the portlet can be expected to
be unavailable.
If the portlet is called again while it is still unavailable, it
indicates the same time estimate. No effort is
made to correct for the time elapsed since the exception was
first reported.
If this method returns zero or a negative number, the portlet
is permanently unavailable or cannot provide an estimate of
how long it will be unavailable.
an integer specifying the number of secondsthe portlet will be temporarily unavailable,or zero or a negative number if the portlet is permanentlyunavailable or cannot make an estimate. |
| isPermanent | | public boolean isPermanent()(Code) | | Returns a boolean indicating
whether the portlet is permanently unavailable.
If so, something is wrong with the portlet, and the
system administrator must take some corrective action.
true if the portlet ispermanently unavailable; falseif the portlet is temporarilyunavailable. |
|
|