javax.servlet

クラス UnavailableException

java.lang.Object

java.lang.Throwable

java.lang.Exception

javax.servlet.ServletException

javax.servlet.UnavailableException

すべての実装されたインタフェース:

Serializable

public class UnavailableException
extends ServletException

サーブレットやフィルターが永続的もしくは一時的に使用できない場合にスローする例外を定義します。

サーブレットやフィルターが永続的もしくは一時的に使用できない時、何かが間違っていて、なんらかの手段が講じられるまでそれらはリクエストを扱うことができません。 例えば、サーブレットが正しく設定されていない場合やフィルターが正しくない場合、コンポーネントはエラーと修正のための必要なアクションをログに出力する必要があります。

システム全体の問題でリクエストをしばらく処理できない場合に、サーブレットやフィルターが一時的に使用できなくなります。 例えば、3層アーキテクチャでデータ層にアクセスできない場合やリクエストを処理するためのメモリやディスクが不足している場合です。システムアドミニストレーターは修正のためのアクションを取る必要があります。

サーブレットコンテナは両方の使用不能を表す例外を同じ方法で安全に処理することができます。 しかしながら、一時的な使用不能をうまく扱うことでサーブレットコンテナはより強固になります。 具体的にはサーブレットコンテナは再起動されるまで、サーブレットやフィルタへのリクエストを拒否するのではなく、例外によって示された期間ブロックします。

作成者:

Various

関連項目:

直列化された形式

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
UnavailableException(int seconds, Servlet servlet, String msg) 非推奨です。 Java Servlet API 2.2以降では UnavailableException(String, int) を使用してください。
UnavailableException(Servlet servlet, String msg) 非推奨です。 Java Servlet API 2.2以降では UnavailableException(String) を使用してください。
UnavailableException(String msg) サーブレットが永続的に使用できないことを説明する文で新しい例外を構築します。
UnavailableException(String msg, int seconds) サーブレットが一時的に使用できないことを説明する文と使用できるようになるまでの時間で新しい例外を構築します。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
Servlet	getServlet() 非推奨です。 Java Servlet API 2.2以降での代替手段はありません。 使用できないことを報告したサーブレットのインスタンスを返します。
int	getUnavailableSeconds() サーブレットが一時的に使用できないと予想される秒数を返します。
boolean	isPermanent() サーブレット永続的に使用不能かどうかを booleanで返します。

クラスから継承されたメソッド javax.servlet.ServletException

getRootCause

クラスから継承されたメソッド java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

UnavailableException

@Deprecated
public UnavailableException(Servlet servlet,
                                        String msg)

非推奨です。 Java Servlet API 2.2以降では UnavailableException(String) を使用してください。

パラメータ:

servlet - 使用できない Servlet のインスタンス

msg - 説明文

UnavailableException

@Deprecated
public UnavailableException(int seconds,
                                        Servlet servlet,
                                        String msg)

非推奨です。 Java Servlet API 2.2以降では UnavailableException(String, int) を使用してください。

パラメータ:

seconds - サーブレットが利用できないと予想される秒数; もしゼロか負の数の場合はサーブレットが永続的に使用できないか使用できない期間を見積もれない場合を表します。

servlet - 使用できない Servlet のインスタンス

msg - ログファイルに出力するかユーザーに表示するための説明文

UnavailableException

public UnavailableException(String msg)

サーブレットが永続的に使用できないことを説明する文で新しい例外を構築します。

パラメータ:

msg - 説明文

UnavailableException

public UnavailableException(String msg,
                            int seconds)

サーブレットが一時的に使用できないことを説明する文と使用できるようになるまでの時間で新しい例外を構築します。

いくつかのケースでサーブレットは使用可能になるまでの時間を見積もれません。 サーブレットは実行に必要なサーバーが動作していないことを知ることはできたとしても、動くように修正されるまでの時間を知ることはできません。 このような場合は seconds 引数をゼロもしくは負の数で指定します。

パラメータ:

msg - ログファイルに出力するかユーザーに表示するための説明文

seconds - サーブレットが利用できないと予想される秒数; もしゼロか負の数の場合はサーブレットが永続的に使用できないか使用できない期間を見積もれない場合を表します。

メソッドの詳細

isPermanent

public boolean isPermanent()

サーブレット永続的に使用不能かどうかを booleanで返します。 その場合、サーブレットが何か間違っているのでシステムアドミニストレーターは修正のためのアクションを行わなければいけません。

戻り値:

true の場合、サーブレットは永続的に使用できません。 ; falseの場合、サーブレットは一時的に使用できません。

getServlet

@Deprecated
public Servlet getServlet()

非推奨です。 Java Servlet API 2.2以降での代替手段はありません。 使用できないことを報告したサーブレットのインスタンスを返します。

戻り値:

UnavailableExceptionをスローした Servletのインスタンス

getUnavailableSeconds

public int getUnavailableSeconds()

サーブレットが一時的に使用できないと予想される秒数を返します。

サーブレットが永続的に使用できない場合やどれくらいの期間使用できないかの予測時間を提供できない場合はこのメソッドは負の数を返します。 最初に例外が報告されてからの経過時間は正確には保たれてはいません。

戻り値:

サーブレットが利用できないと予想される秒数、負の数はサーブレットが永続的に使用できないか使用できない期間を見積もれない場合を表します。