Package se.swedenconnect.security.credential.spring.actuator

Class CredentialMonitorHealthIndicator

java.lang.Object

se.swedenconnect.security.credential.spring.actuator.CredentialMonitorHealthIndicator

All Implemented Interfaces:

org.springframework.boot.actuate.health.HealthContributor, org.springframework.boot.actuate.health.HealthIndicator

public class CredentialMonitorHealthIndicator
extends Object
implements org.springframework.boot.actuate.health.HealthIndicator

A HealthIndicator for monitoring credentials.

The indicator can either work in a passive mode where it listens to monitor events (use CredentialMonitorHealthIndicator()), or in "active" mode where the indicator sets up a CredentialMonitorBean (use CredentialMonitorHealthIndicator(List)).

Author:

Martin Lindström

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CredentialMonitorHealthIndicator.MonitorStatus

Field Summary

Fields

Modifier and Type	Field	Description
static final org.springframework.boot.actuate.health.Status	WARNING	Custom health status for warnings.

Constructor Summary

Constructors

Constructor	Description
CredentialMonitorHealthIndicator()	Credential assuming that monitor events will be published.
CredentialMonitorHealthIndicator(List<ReloadablePkiCredential> credentials)	Constructor setting up a monitor.

Method Summary

Modifier and Type	Method	Description
org.springframework.boot.actuate.health.Health	health()	Tests all configured credentials, and performs reload on those that fail tests.
void	onFailedCredentialReloadEvent(FailedCredentialReloadEvent event)
void	onFailedCredentialTestEvent(FailedCredentialTestEvent event)
void	onSuccessfulCredentialReloadEvent(SuccessfulCredentialReloadEvent event)
void	onSuccessfulCredentialTestEvent(SuccessfulCredentialTestEvent event)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.actuate.health.HealthIndicator

getHealth

Field Details

WARNING

public static final org.springframework.boot.actuate.health.Status WARNING

Custom health status for warnings.

Constructor Details

CredentialMonitorHealthIndicator

public CredentialMonitorHealthIndicator()

Credential assuming that monitor events will be published.

CredentialMonitorHealthIndicator

public CredentialMonitorHealthIndicator(@Nonnull
 List<ReloadablePkiCredential> credentials)

Constructor setting up a monitor.

Parameters:

credentials - the credentials to monitor

Method Details

health

public org.springframework.boot.actuate.health.Health health()

Tests all configured credentials, and performs reload on those that fail tests.

Specified by:

health in interface org.springframework.boot.actuate.health.HealthIndicator

onSuccessfulCredentialTestEvent

@EventListener
public void onSuccessfulCredentialTestEvent(SuccessfulCredentialTestEvent event)

onFailedCredentialTestEvent

@EventListener
public void onFailedCredentialTestEvent(FailedCredentialTestEvent event)

onSuccessfulCredentialReloadEvent

@EventListener
public void onSuccessfulCredentialReloadEvent(SuccessfulCredentialReloadEvent event)

onFailedCredentialReloadEvent

@EventListener
public void onFailedCredentialReloadEvent(FailedCredentialReloadEvent event)