nablarch.fw.web.handler.health

Class HealthChecker

java.lang.Object

nablarch.fw.web.handler.health.HealthChecker

Direct Known Subclasses:

DbHealthChecker, RedisHealthChecker

@Published(tag="architect")
public abstract class HealthChecker
extends java.lang.Object

ヘルスチェックを行うクラス。

Constructor Summary

Constructors

Constructor and Description
HealthChecker()

Method Summary

Modifier and Type	Method and Description
boolean	check(HttpRequest request, ExecutionContext context) ヘルスチェックを行う。 tryOut(HttpRequest, ExecutionContext)を呼び出し、その結果を返す。 tryOut(HttpRequest, ExecutionContext)で例外が発生した場合はfalseを返す。
java.lang.String	getName() ヘルスチェックの対象を表す名前を取得する。
void	setName(java.lang.String name) ヘルスチェックの対象を表す名前を設定する。
protected abstract boolean	tryOut(HttpRequest request, ExecutionContext context) ヘルシーと判断できる処理を試す。

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthChecker

public HealthChecker()

Method Detail

getName

public java.lang.String getName()

ヘルスチェックの対象を表す名前を取得する。

Returns:

ヘルスチェックの対象を表す名前

setName

public void setName(java.lang.String name)

ヘルスチェックの対象を表す名前を設定する。

Parameters:

name - ヘルスチェックの対象を表す名前

check

public boolean check(HttpRequest request,
                     ExecutionContext context)

ヘルスチェックを行う。 tryOut(HttpRequest, ExecutionContext)を呼び出し、その結果を返す。 tryOut(HttpRequest, ExecutionContext)で例外が発生した場合はfalseを返す。

Parameters:

request - リクエスト

context - コンテキスト

Returns:

ヘルスチェックに成功した場合はtrue

tryOut

protected abstract boolean tryOut(HttpRequest request,
                                  ExecutionContext context)
                           throws java.lang.Exception

ヘルシーと判断できる処理を試す。

Parameters:

request - リクエスト

context - コンテキスト

Returns:

ヘルシーな場合はtrue

Throws:

java.lang.Exception - 試した結果発生した例外