Package nablarch.fw.web.handler.health
Class HealthChecker
java.lang.Object
nablarch.fw.web.handler.health.HealthChecker
- Direct Known Subclasses:
DbHealthChecker
,RedisHealthChecker
ヘルスチェックを行うクラス。
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
check
(HttpRequest request, ExecutionContext context) ヘルスチェックを行う。tryOut(HttpRequest, ExecutionContext)
を呼び出し、その結果を返す。tryOut(HttpRequest, ExecutionContext)
で例外が発生した場合はfalseを返す。getName()
ヘルスチェックの対象を表す名前を取得する。void
ヘルスチェックの対象を表す名前を設定する。protected abstract boolean
tryOut
(HttpRequest request, ExecutionContext context) ヘルシーと判断できる処理を試す。
-
Constructor Details
-
HealthChecker
public HealthChecker()
-
-
Method Details
-
getName
ヘルスチェックの対象を表す名前を取得する。- Returns:
- ヘルスチェックの対象を表す名前
-
setName
ヘルスチェックの対象を表す名前を設定する。- Parameters:
name
- ヘルスチェックの対象を表す名前
-
check
ヘルスチェックを行う。tryOut(HttpRequest, ExecutionContext)
を呼び出し、その結果を返す。tryOut(HttpRequest, ExecutionContext)
で例外が発生した場合はfalseを返す。- Parameters:
request
- リクエストcontext
- コンテキスト- Returns:
- ヘルスチェックに成功した場合はtrue
-
tryOut
ヘルシーと判断できる処理を試す。- Parameters:
request
- リクエストcontext
- コンテキスト- Returns:
- ヘルシーな場合はtrue
- Throws:
Exception
- 試した結果発生した例外
-