|
Jetty example source code file (UnavailableException.java)
The Jetty UnavailableException.java source code/* * The contents of this file are subject to the terms * of the Common Development and Distribution License * (the "License"). You may not use this file except * in compliance with the License. * * You can obtain a copy of the license at * glassfish/bootstrap/legal/CDDLv1.0.txt or * https://glassfish.dev.java.net/public/CDDLv1.0.html. * See the License for the specific language governing * permissions and limitations under the License. * * When distributing Covered Code, include this CDDL * HEADER in each file and include the License file at * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable, * add the following below this CDDL HEADER, with the * fields enclosed by brackets "[]" replaced with your * own identifying information: Portions Copyright [yyyy] * [name of copyright owner] * * Copyright 2005 Sun Microsystems, Inc. All rights reserved. * * Portions Copyright Apache Software Foundation. */ package javax.servlet; /** * Defines an exception that a servlet or filter throws to indicate * that it is permanently or temporarily unavailable. * * <p>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. * * <p>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. * * <p>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. * * * @author Various * */ public class UnavailableException extends ServletException { private Servlet servlet; // what's unavailable private boolean permanent; // needs admin action? private int seconds; // unavailability estimate /** * * @deprecated As of Java Servlet API 2.2, use {@link * #UnavailableException(String)} instead. * * @param servlet the <code>Servlet instance that is * unavailable * * @param msg a <code>String specifying the * descriptive message * */ public UnavailableException(Servlet servlet, String msg) { super(msg); this.servlet = servlet; permanent = true; } /** * @deprecated As of Java Servlet API 2.2, use {@link * #UnavailableException(String, int)} instead. * * @param 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 * * @param servlet the <code>Servlet that is unavailable * * @param msg a <code>String specifying the descriptive * message, which can be written to a log file or * displayed for the user. * */ public UnavailableException(int seconds, Servlet servlet, String msg) { super(msg); this.servlet = servlet; if (seconds <= 0) this.seconds = -1; else this.seconds = seconds; permanent = false; } /** * * Constructs a new exception with a descriptive * message indicating that the servlet is permanently * unavailable. * * @param msg a <code>String specifying the * descriptive message * */ public UnavailableException(String msg) { super(msg); permanent = true; } /** * 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. * * <p>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 <code>seconds argument. * * @param msg a <code>String specifying the * descriptive message, which can be written * to a log file or displayed for the user. * * @param 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 * */ public UnavailableException(String msg, int seconds) { super(msg); if (seconds <= 0) this.seconds = -1; else this.seconds = seconds; permanent = false; } /** * * Returns a <code>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. * * @return <code>true if the servlet is * permanently unavailable; <code>false * if the servlet is available or temporarily * unavailable * */ public boolean isPermanent() { return permanent; } /** * @deprecated As of Java Servlet API 2.2, with no replacement. * * Returns the servlet that is reporting its unavailability. * * @return the <code>Servlet object that is * throwing the <code>UnavailableException * */ public Servlet getServlet() { return servlet; } /** * Returns the number of seconds the servlet expects to * be temporarily unavailable. * * <p>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. * * @return 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 * */ public int getUnavailableSeconds() { return permanent ? -1 : seconds; } } Other Jetty examples (source code examples)Here is a short list of links related to this Jetty UnavailableException.java source code file: |
... this post is sponsored by my books ... | |
#1 New Release! |
FP Best Seller |
Copyright 1998-2021 Alvin Alexander, alvinalexander.com
All Rights Reserved.
A percentage of advertising revenue from
pages under the /java/jwarehouse
URI on this website is
paid back to open source projects.