UnavailableException when
the portlet is either temporarily or permanently unavailable to handle requests.
| Modifier and Type | Field and Description |
|---|---|
| private boolean | |
| private int | |
| private static final long |
| Access | Constructor and Description |
|---|---|
| public | UnavailableException(String
a text)String specifying the
descriptive messageConstructs a new exception with a descriptive message indicating that the portlet is permanently unavailable. |
| public | UnavailableException(String
a text, int String specifying the
descriptive message. This message can be written
to a log file or displayed for the user.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. 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. |
| Modifier and Type | Method and Description |
|---|---|
| public int | Returns: an integer specifying the number of seconds the portlet will be temporarily unavailable, or zero or a negative number if the portlet is permanently unavailable or cannot make an estimate.Returns the time in seconds for which the portlet can be expected to be unavailable. |
| public boolean | Returns: true if the portlet is
permanently unavailable; false
if the portlet is temporarily
unavailable.Returns a |
| permanent | back to summary |
|---|---|
| private boolean permanent | |
| seconds | back to summary |
|---|---|
| private int seconds | |
| serialVersionUID | back to summary |
|---|---|
| private static final long serialVersionUID | |
| UnavailableException | back to summary |
|---|---|
| public UnavailableException(String text) Constructs a new exception with a descriptive message indicating that the portlet is permanently unavailable.
| |
| UnavailableException | back to summary |
|---|---|
| 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. 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
| |
| getUnavailableSeconds | back to 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. 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.
| |
| isPermanent | back to summary |
|---|---|
| public boolean isPermanent() Returns a
| |