Package com.github.jpmsilva.jsystemd

Class SystemdHealthProviderProperties

java.lang.Object

com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties

@ConfigurationProperties(prefix="systemd.health-provider")
public class SystemdHealthProviderProperties
extends Object

Properties class for systemd integration when using Spring Boot Actuator.

Author:

Christian Lorenz

Method Summary

Modifier and Type	Method	Description
@Nullable Long	getUnhealthyPendingPeriodMs()	Check the delay reporting unhealthy status to systemd watchdog.
@NotNull List<String>	getUnhealthyStatusCodes()	Check the status codes from Status to consider as unhealthy.
boolean	isEnabled()	Check if the integration between Spring Boot Actuator health status and systemd watchdog is enabled.
void	setEnabled(boolean enabled)	Enable integration between Spring Boot Actuator health status and systemd watchdog.
void	setUnhealthyPendingPeriodMs(@Nullable Long unhealthyPendingPeriodMs)	Set the delay reporting unhealthy status to systemd watchdog.
void	setUnhealthyStatusCodes(@NotNull List<String> unhealthyStatusCodes)	Set the status codes from Status to consider as unhealthy.

Methods inherited from class java.lang.Object

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

Method Details

isEnabled

public boolean isEnabled()

Check if the integration between Spring Boot Actuator health status and systemd watchdog is enabled.

Returns:

true if the integration between Spring Boot Actuator health status and systemd watchdog is enabled

setEnabled

public void setEnabled(boolean enabled)

Enable integration between Spring Boot Actuator health status and systemd watchdog.

Parameters:

enabled - true to enable the integration between Spring Boot Actuator health status and systemd watchdog

getUnhealthyStatusCodes

@NotNull
public @NotNull List<String> getUnhealthyStatusCodes()

Check the status codes from Status to consider as unhealthy.

Returns:

the status codes from Status to consider as unhealthy

See Also:

• setUnhealthyStatusCodes(List)

setUnhealthyStatusCodes

public void setUnhealthyStatusCodes(@NotNull
 @NotNull List<String> unhealthyStatusCodes)

Set the status codes from Status to consider as unhealthy. If omitted Status.DOWN is used.

Parameters:

unhealthyStatusCodes - the status codes from Status to consider as unhealthy

getUnhealthyPendingPeriodMs

@Nullable
public @Nullable Long getUnhealthyPendingPeriodMs()

Check the delay reporting unhealthy status to systemd watchdog.

Returns:

the delay reporting unhealthy status to systemd watchdog

See Also:

• setUnhealthyPendingPeriodMs(Long)

setUnhealthyPendingPeriodMs

public void setUnhealthyPendingPeriodMs(@Nullable
 @Nullable Long unhealthyPendingPeriodMs)

Set the delay reporting unhealthy status to systemd watchdog. This parameter is provided in milliseconds, and may be null to disable the delay.

Parameters:

unhealthyPendingPeriodMs - the delay reporting unhealthy status to systemd watchdog