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

Snippet Preview

Snippet HTML Code

Stack Overflow Questions 
1
  /*
2
   * The Apache Software License, Version 1.1
3
   *
4
   * Copyright (c) 1999 The Apache Software Foundation.  All rights 
5
   * reserved.
6
   *
7
   * Redistribution and use in source and binary forms, with or without
8
   * modification, are permitted provided that the following conditions
9
   * are met:
10
  *
11
  * 1. Redistributions of source code must retain the above copyright
12
  *    notice, this list of conditions and the following disclaimer. 
13
  *
14
  * 2. Redistributions in binary form must reproduce the above copyright
15
  *    notice, this list of conditions and the following disclaimer in
16
  *    the documentation and/or other materials provided with the
17
  *    distribution.
18
  *
19
  * 3. The end-user documentation included with the redistribution, if
20
  *    any, must include the following acknowlegement:  
21
  *       "This product includes software developed by the 
22
  *        Apache Software Foundation (http://www.apache.org/)."
23
  *    Alternately, this acknowlegement may appear in the software itself,
24
  *    if and wherever such third-party acknowlegements normally appear.
25
  *
26
  * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
27
  *    Foundation" must not be used to endorse or promote products derived
28
  *    from this software without prior written permission. For written 
29
  *    permission, please contact apache@apache.org.
30
  *
31
  * 5. Products derived from this software may not be called "Apache"
32
  *    nor may "Apache" appear in their names without prior written
33
  *    permission of the Apache Group.
34
  *
35
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46
  * SUCH DAMAGE.
47
  * ====================================================================
48
  *
49
  * This software consists of voluntary contributions made by many
50
  * individuals on behalf of the Apache Software Foundation.  For more
51
  * information on the Apache Software Foundation, please see
52
  * <http://www.apache.org/>.
53
  *
54
  * ====================================================================
55
  *
56
  * This source code implements specifications defined by the Java
57
  * Community Process. In order to remain compliant with the specification
58
  * DO NOT add / change / or delete method signatures!
59
  */ 
60
 
61
 package javax.servlet;


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

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

A servlet 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 for a period of time suggested by the servlet, rather than rejecting them until the servlet container restarts.

Author(s):
Various
Version:
$Version$
92
 
93
 
94
 public class UnavailableException
95
 extends ServletException {
96
 
97
     private Servlet     servlet;           // what's unavailable
98
     private boolean     permanent;         // needs admin action?
99
     private int         seconds;           // unavailability estimate
100

    

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
114
    public UnavailableException(Servlet servlet, String msg) {
115
	super(msg);
116
	this. = servlet;
117
	 = true;
118
    }
 
    

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.
136
    
137
    public UnavailableException(int seconds, Servlet servlet, String msg) {
138
	super(msg);
139
	this. = servlet;
140
	if (seconds <= 0)
141
	    this. = -1;
142
	else
143
	    this. = seconds;
144
	 = false;
145
    }

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

Parameters:
msg a String specifying the descriptive message
158
    public UnavailableException(String msg) {
159
	super(msg);
161
	 = true;
162
    }

    
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
185
    
186
    public UnavailableException(String msg, int seconds) {
187
	super(msg);
189
	if (seconds <= 0)
190
	    this. = -1;
191
	else
192
	    this. = seconds;
194
	 = false;
195
    }

    
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
210
     
211
    public boolean isPermanent() {
212
	return ;
213
    }
  
    

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
224
     
225
    public Servlet getServlet() {
226
	return ;
227
    }

    
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
245
     
246
    public int getUnavailableSeconds() {
247
	return  ? -1 : ;
248
    }
New to GrepCode? Check out our FAQ X