UnavailableException (GNU Servlet API documentation)

JavaScript is disabled on your browser.

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

javax.servlet

Class UnavailableException

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - javax.servlet.ServletException
    - - javax.servlet.UnavailableException

All Implemented Interfaces:

java.io.Serializable
```
public class UnavailableException
extends ServletException 
```
This is a special kind of exception telling the server that this particular servlet is currently not available. It has two kinds of unavailability:

Permanent unavailable
This servlet is now and forever in the future unavailable. If another class in spite of this fact asks this exception for how long it is unavailable it returns a negative number of seconds. (-1 as a matter of fact)
Temporary unavailable The servlet is currently unavailable, but will be available within a certain number of seconds. A class can ask the exception for that number of seconds.

Since:

1.0

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`UnavailableException (int seconds, Servlet servlet, java.lang.String message)` Deprecated. use `UnavailableException(String)`.
`UnavailableException (Servlet servlet, java.lang.String message)` Deprecated. use `UnavailableException(String)`.
`UnavailableException (java.lang.String message)` Constructor for a permanent unavailable exception
`UnavailableException (java.lang.String message, int seconds)` Constructor for a temporary unavailable exception

Method Summary

Methods
Modifier and Type	Method and Description
`Servlet`	`getServlet ()` Deprecated. no replacement
`int`	`getUnavailableSeconds ()` Gets the number of seconds the servlet is unavailable
`boolean`	`isPermanent ()` Check whether the servlet is permanently unavailable

Methods inherited from class javax.servlet.ServletException
getRootCause

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, 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
  - UnavailableException
```
public UnavailableException(java.lang.String message)
```
    Constructor for a permanent unavailable exception
    
    Since:
    
    2.2
  - UnavailableException
```
public UnavailableException(java.lang.String message,
 int seconds)
```
    Constructor for a temporary unavailable exception
    
    Since:
    
    2.2
  - UnavailableException
```
public UnavailableException(Servlet servlet,
 java.lang.String message)
```
    Deprecated. use UnavailableException(String).
    
    Constructor for a permanent unavailable exception
  - UnavailableException
```
public UnavailableException(int seconds,
 Servlet servlet,
 java.lang.String message)
```
    Deprecated. use UnavailableException(String).
    
    Constructor for a temporary unavailable exception
- Method Detail
  - isPermanent
```
public boolean isPermanent()
```
    Check whether the servlet is permanently unavailable
    
    Returns:
    whether the servlet is permanently unavailable
  - getServlet
```
public Servlet getServlet()
```
    Deprecated. no replacement
    
    Gets the servlet that is unavailable
  - getUnavailableSeconds
```
public int getUnavailableSeconds()
```
    Gets the number of seconds the servlet is unavailable
    
    Returns:
    the number of seconds. Negative if permanently unavailable

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method