Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
Copyright 2003-2004 The Apache Software Foundation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 
16
 
17
 
18
 //
19
 // This source code implements specifications defined by the Java
20
 // Community Process. In order to remain compliant with the specification
21
 // DO NOT add / change / or delete method signatures!
22
 //
23
 
24
 package javax.servlet;

Defines an exception that a servlet or filter throws to indicate that it is permanently or temporarily unavailable.

When a servlet or filter is permanently unavailable, something is wrong with it, and it cannot handle requests until some action is taken. For example, a servlet might be configured incorrectly, or a filter's state may be corrupted. The component should log both the error and the corrective action that is needed.

A servlet or filter is temporarily unavailable if it cannot handle requests momentarily due to some system-wide problem. For example, a third-tier server might not be accessible, or there may be insufficient memory or disk storage to handle requests. A system administrator may need to take corrective action.

Servlet containers can safely treat both types of unavailable exceptions in the same way. However, treating temporary unavailability effectively makes the servlet container more robust. Specifically, the servlet container might block requests to the servlet or filter for a period of time suggested by the exception, rather than rejecting them until the servlet container restarts.

Version:
$Rev: 46019 $ $Date: 2004-09-14 04:56:06 -0500 (Tue, 14 Sep 2004) $
51
 
52
 public class UnavailableException extends ServletException {
    
What is unavailable 
55
 
56
     private Servlet servlet;
    
Does this need an admin action? 
59
 
60
     private boolean permanent;
    
Estimate of how long the resource will be unavaile. 
63
 
64
     private int seconds;

    

Deprecated:
As of Java Servlet API 2.2, use UnavailableException(java.lang.String) instead.
Parameters:
servlet the Servlet instance that is unavailable
msg a String specifying the descriptive message
73
 
74
     public UnavailableException(Servlet servlet, String msg) {
75
         super(msg);
76
         this. = servlet;
77
          = true;
78
     }

    

Deprecated:
As of Java Servlet API 2.2, use UnavailableException(java.lang.String,int) instead.
Parameters:
seconds an integer specifying the number of seconds the servlet expects to be unavailable; if zero or negative, indicates that the servlet can't make an estimate
servlet the Servlet that is unavailable
msg a String specifying the descriptive message, which can be written to a log file or displayed for the user.
93
 
94
     public UnavailableException(int seconds, Servlet servlet, String msg) {
95
         super(msg);
96
         this. = servlet;
97
         if (seconds <= 0) {
98
             this. = -1;
99
         } else {
100
            this. = seconds;
101
        }
102
         = false;
103
    }

    
Constructs a new exception with a descriptive message indicating that the servlet is permanently unavailable.

Parameters:
msg a String specifying the descriptive message
112
    public UnavailableException(String msg) {
113
        super(msg);
115
         = true;
116
    }

    
Constructs a new exception with a descriptive message indicating that the servlet is temporarily unavailable and giving an estimate of how long it will be unavailable.

In some cases, the servlet cannot make an estimate. For example, the servlet might know that a server it needs is not running, but 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:
msg a String specifying the descriptive message, which can be written to a log file or displayed for the user.
seconds an integer specifying the number of seconds the servlet expects to be unavailable; if zero or negative, indicates that the servlet can't make an estimate
137
    public UnavailableException(String msg, int seconds) {
138
        super(msg);
140
        if (seconds <= 0) {
141
            this. = -1;
142
        } else {
143
            this. = seconds;
144
        }
145
         = false;
146
    }

    
Returns a boolean indicating whether the servlet is permanently unavailable. If so, something is wrong with the servlet, and the system administrator must take some corrective action.

Returns:
true if the servlet is permanently unavailable; false if the servlet is available or temporarily unavailable
158
    public boolean isPermanent() {
159
        return ;
160
    }

    

Deprecated:
As of Java Servlet API 2.2, with no replacement. Returns the servlet that is reporting its unavailability.
Returns:
the Servlet object that is throwing the UnavailableException
170
    public Servlet getServlet() {
171
        return ;
172
    }

    
Returns the number of seconds the servlet expects to be temporarily unavailable.

If this method returns a negative number, the servlet is permanently unavailable or cannot provide an estimate of how long it will be unavailable. No effort is made to correct for the time elapsed since the exception was first reported.

Returns:
an integer specifying the number of seconds the servlet will be temporarily unavailable, or a negative number if the servlet is permanently unavailable or cannot make an estimate
189
    public int getUnavailableSeconds() {
190
        return  ? -1 : ;
191
    }
New to GrepCode? Check out our FAQ X