nablarch.fw.web.handler.health

Class HealthCheckResponseBuilder

java.lang.Object

nablarch.fw.web.handler.health.HealthCheckResponseBuilder

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

ヘルスチェック結果からレスポンスを作成するビルダ。

Constructor Summary

Constructors

Constructor and Description
HealthCheckResponseBuilder()

Method Summary

Modifier and Type	Method and Description
HttpResponse	build(HttpRequest request, ExecutionContext context, HealthCheckResult result) ヘルスチェック結果からレスポンスを作成する。 デフォルトではJSONのレスポンスを作成する。 ヘルスチェックが成功した場合 {"status":"UP","targets":[{"name":"DB","status":"UP"},{"name":"Redis","status":"UP"}]} ヘルスチェックが失敗した場合 {"status":"DOWN","targets":[{"name":"DB","status":"UP"},{"name":"Redis","status":"DOWN"}]}
protected java.lang.String	buildResponseBody(HttpRequest request, ExecutionContext context, HealthCheckResult result) レスポンスボディを作成する。
protected java.lang.String	getContentType() コンテンツタイプを取得する。
protected java.lang.String	getStatus(boolean isHealthy) ヘルスチェック結果に応じたステータスの表現を取得する。
void	setHealthyStatus(java.lang.String healthyStatus) ヘルスチェックが成功した場合のステータスの表現を設定する。 デフォルトは"UP"。
void	setHealthyStatusCode(int healthyStatusCode) ヘルスチェックが成功した場合のステータスコードを設定する。 デフォルトは"200"。
void	setUnhealthyStatus(java.lang.String unhealthyStatus) ヘルスチェックが失敗した場合のステータスの表現を設定する。 デフォルトは"DOWN"。
void	setUnhealthyStatusCode(int unhealthyStatusCode) ヘルスチェックが失敗した場合のステータスコードを設定する。 デフォルトは"503"。
void	setWriteBody(boolean writeBody) レスポンスボディを書き込むか否かを設定する。 デフォルトは"true"。 ステータスコードだけでよい場合は"false"を指定する。

Methods inherited from class java.lang.Object

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

Constructor Detail

HealthCheckResponseBuilder

public HealthCheckResponseBuilder()

Method Detail

build

public HttpResponse build(HttpRequest request,
                          ExecutionContext context,
                          HealthCheckResult result)

ヘルスチェック結果からレスポンスを作成する。 デフォルトではJSONのレスポンスを作成する。 ヘルスチェックが成功した場合 {"status":"UP","targets":[{"name":"DB","status":"UP"},{"name":"Redis","status":"UP"}]} ヘルスチェックが失敗した場合 {"status":"DOWN","targets":[{"name":"DB","status":"UP"},{"name":"Redis","status":"DOWN"}]}

Parameters:

request - リクエスト

context - コンテキスト

result - ヘルスチェック結果

Returns:

レスポンス

getContentType

protected java.lang.String getContentType()

コンテンツタイプを取得する。

Returns:

コンテンツタイプ

buildResponseBody

protected java.lang.String buildResponseBody(HttpRequest request,
                                             ExecutionContext context,
                                             HealthCheckResult result)

レスポンスボディを作成する。

Parameters:

request - リクエスト

context - コンテキスト

result - ヘルスチェック結果

Returns:

レスポンスボディ

getStatus

protected java.lang.String getStatus(boolean isHealthy)

ヘルスチェック結果に応じたステータスの表現を取得する。

Parameters:

isHealthy - ヘルスチェック結果。成功した場合はtrue

Returns:

ヘルスチェック結果に応じたステータスの表現

setHealthyStatusCode

public void setHealthyStatusCode(int healthyStatusCode)

ヘルスチェックが成功した場合のステータスコードを設定する。 デフォルトは"200"。

Parameters:

healthyStatusCode - ヘルスチェックが成功した場合のステータスコード

setHealthyStatus

public void setHealthyStatus(java.lang.String healthyStatus)

ヘルスチェックが成功した場合のステータスの表現を設定する。 デフォルトは"UP"。

Parameters:

healthyStatus - ヘルスチェックが成功した場合のステータスの表現

setUnhealthyStatusCode

public void setUnhealthyStatusCode(int unhealthyStatusCode)

ヘルスチェックが失敗した場合のステータスコードを設定する。 デフォルトは"503"。

Parameters:

unhealthyStatusCode - ヘルスチェックが失敗した場合のステータスコード

setUnhealthyStatus

public void setUnhealthyStatus(java.lang.String unhealthyStatus)

ヘルスチェックが失敗した場合のステータスの表現を設定する。 デフォルトは"DOWN"。

Parameters:

unhealthyStatus - ヘルスチェックが失敗した場合のステータスの表現

setWriteBody

public void setWriteBody(boolean writeBody)

レスポンスボディを書き込むか否かを設定する。 デフォルトは"true"。 ステータスコードだけでよい場合は"false"を指定する。

Parameters:

writeBody - レスポンスボディを書き込む場合はtrue