javax.servlet
Class UnavailableException

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

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:

Servlet API 1.0

Version:

Servlet API 2.1

See Also:

Serialized Form

Constructor Summary

UnavailableException(int seconds, Servlet servlet, java.lang.String message)
Constructor for a temporary unavailable exception

UnavailableException(Servlet servlet, java.lang.String message)
Constructor for a permanent unavailable exception

Method Summary

Servlet	getServlet() Gets the servlet that is unavailable
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

fillInStackTrace, getLocalizedMessage, getMessage, printStackTrace, printStackTrace, printStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UnavailableException

public UnavailableException(Servlet servlet,
                            java.lang.String message)

Constructor for a permanent unavailable exception

Since:

Servlet API 1.0

UnavailableException

public UnavailableException(int seconds,
                            Servlet servlet,
                            java.lang.String message)

Constructor for a temporary unavailable exception

Since:

Servlet API 1.0

Method Detail

isPermanent

public boolean isPermanent()

Check whether the servlet is permanently unavailable

Returns:

whether the servlet is permanently unavailable

Since:

Servlet API 1.0

getServlet

public Servlet getServlet()

Gets the servlet that is unavailable

Since:

Servlet API 1.0

getUnavailableSeconds

public int getUnavailableSeconds()

Gets the number of seconds the servlet is unavailable

Returns:

the number of seconds. Negative if permanently unavailable

Since:

Servlet API 1.0