Index

A B C D E F G H I J L N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

ACCEPTING_TRAFFIC - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ReadyEvent
Once the application accepts traffic (ReadinessState.ACCEPTING_TRAFFIC), after its ApplicationRunner and CommandLineRunner beans have run.
ActuatorHealthStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Provides the application health based on Spring Boot Actuator health contributors: as a HealthProvider, for the systemd watchdog, and as a StatusProvider, for the systemd status.
ActuatorHealthStatusProvider(HealthContributors, Set<Status>, Predicate<String>, boolean) - Constructor for class com.github.jpmsilva.jsystemd.spring.ActuatorHealthStatusProvider
Creates a new instance using the provided health contributors and unhealthy status codes.
addHealthProviders(int, HealthProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the health providers to the list of health providers in the specified position.
addHealthProviders(int, List<HealthProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the health providers to the list of health providers in the specified position.
addHealthProviders(HealthProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the health providers to the end of the list of health providers.
addHealthProviders(List<HealthProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the health providers to the end of the list of health providers.
addStatusProviders(int, StatusProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the status providers to the list of providers in the specified position.
addStatusProviders(int, List<StatusProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the status providers to the list of providers in the specified position.
addStatusProviders(StatusProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the status providers to the end of the list of providers.
addStatusProviders(List<StatusProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Adds the status providers to the end of the list of providers.
afterPropertiesSet() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Rejects invalid values, naming the property, rather than failing later, or silently ignoring them.
afterSingletonsInstantiated() - Method in class com.github.jpmsilva.jsystemd.spring.HikariStatusProvider
Finds the HikariCP connection pools among the data source beans that are already created.
afterSingletonsInstantiated() - Method in class com.github.jpmsilva.jsystemd.spring.TaskExecutorStatusProvider
Finds the task executors among the singleton beans that are already created.
APPLICATION_STARTED - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ReadyEvent
Once the application has started, as soon as its application context is refreshed, before its ApplicationRunner and CommandLineRunner beans run, for runners that run for long, or never end.
ApplicationContextStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the bean creation progress of a bean factory.
ApplicationContextStatusProvider(ConfigurableListableBeanFactory) - Constructor for class com.github.jpmsilva.jsystemd.spring.ApplicationContextStatusProvider
Creates a new instance, which sends the status to systemd as the beans are created.
ApplicationRunStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the Spring Boot application startup sequence state.
ApplicationRunStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider
Creates a new instance, which sends the status to systemd on every change of state.
ApplicationRunStatusProvider.ApplicationState - Enum Class in com.github.jpmsilva.jsystemd.spring
Enumeration of supported application startup sequence state.
apply(HttpServer) - Method in class com.github.jpmsilva.jsystemd.spring.NettyStatusProvider
Makes the server count its connections and requests, and report them once it listens.
AvailabilityStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Provides the availability of the application, as Spring Boot reports it with its AvailabilityChangeEvent: as a StatusProvider, whether it is live, and whether it is ready to accept traffic, such as Liveness: correct; readiness: accepting traffic, and as a HealthProvider, for the systemd watchdog, reporting the application as unhealthy while its liveness is broken, if enabled.
AvailabilityStatusProvider(boolean) - Constructor for class com.github.jpmsilva.jsystemd.spring.AvailabilityStatusProvider
Create a new AvailabilityStatusProvider.

B

beansStage() - Method in class com.github.jpmsilva.jsystemd.spring.ShutdownStatusProvider
Returns the life cycle bean that reports when the beans start being destroyed: it is stopped after every other life cycle bean, after which the context destroys its beans.
BufferPoolStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the memory used by the direct and mapped buffers, such as Buffers: 64.0 MiB/1.0 GiB direct (412); 2.0 GiB mapped (3).
BufferPoolStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.BufferPoolStatusProvider
Create a new BufferPoolStatusProvider.

C

CgroupMemoryStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the memory used by the control group of the process, out of its limit, such as Cgroup memory: 700.0 MiB/1.0 GiB, or without the limit when there is none, such as Cgroup memory: 700.0 MiB.
CgroupMemoryStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.CgroupMemoryStatusProvider
Create a new CgroupMemoryStatusProvider, for the control group the process is in when created.
ClassLoaderStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides information regarding loaded classes.
ClassLoaderStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.ClassLoaderStatusProvider
Create a new ClassLoaderStatusProvider.
clearPhase() - Method in class com.github.jpmsilva.jsystemd.PhaseStatusProvider
Clears the current phase, so that nothing is reported.
close() - Method in interface com.github.jpmsilva.jsystemd.keycloak.SystemdProvider
 
close() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
Stops the integration with systemd, once Keycloak closes its providers, telling systemd that Keycloak is stopping if not done before.
close() - Method in class com.github.jpmsilva.jsystemd.Systemd
Stops the periodic tasks of this instance: the status updates, the watchdog heartbeats and the periodic extension of the timeout.
close() - Static method in class com.github.jpmsilva.jsystemd.SystemdNotify
Attempts to orderly close the systemd integration channel.
com.github.jpmsilva.jsystemd - package com.github.jpmsilva.jsystemd
Integration of Java applications with systemd, through its notification protocol.
com.github.jpmsilva.jsystemd.keycloak - package com.github.jpmsilva.jsystemd.keycloak
The provider that integrates Keycloak with systemd.
com.github.jpmsilva.jsystemd.spring - package com.github.jpmsilva.jsystemd.spring
The building blocks of the integration of Spring Boot applications with systemd.
com.github.jpmsilva.jsystemd.spring.autoconfigure - package com.github.jpmsilva.jsystemd.spring.autoconfigure
The autoconfiguration of the integration of Spring Boot applications with systemd.
ConditionalOnSystemd - Annotation Interface in com.github.jpmsilva.jsystemd.spring
Conditional that only matches when the process is running under systemd.
CONTEXT_LOADED - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application context is loaded.
CONTEXT_PREPARED - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application context is prepared.
contextLoaded(ConfigurableApplicationContext) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
contextPrepared(ConfigurableApplicationContext) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
CpuStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the CPU usage, such as CPU: 12.5% process; 40.1% system; load 1.20: the share of the available processors the process used since the status was last read, or since this provider was created, the recent CPU usage of the whole system, and the system load average over the last minute.
CpuStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.CpuStatusProvider
Create a new CpuStatusProvider, which reports the CPU usage of the process since it was created on the first read.
create(KeycloakSession) - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
 

D

DelayableHealthProvider - Class in com.github.jpmsilva.jsystemd
Base class for the health providers that support delaying their unhealthy state: while the delay has not elapsed since the application became unhealthy, it is reported as healthy, so that the systemd watchdog does not restart it on short outages.
DelayableHealthProvider() - Constructor for class com.github.jpmsilva.jsystemd.DelayableHealthProvider
Create a new DelayableHealthProvider, without delay.
details() - Method in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Returns the value of the details record component.
disableExtendTimeout() - Method in class com.github.jpmsilva.jsystemd.Systemd
Disables the periodic extension of the timeout.
disableStatusUpdate() - Method in class com.github.jpmsilva.jsystemd.Systemd
Disables the periodic status updates.
disableWatchdog() - Method in class com.github.jpmsilva.jsystemd.Systemd
Disables the periodic watchdog heartbeats.

E

enableExtendTimeout(Duration, Duration) - Method in class com.github.jpmsilva.jsystemd.Systemd
Enables the periodic extension of the timeout that systemd enforces while the application starts up or stops: TimeoutStartSec until Systemd.ready() is called, and TimeoutStopSec once Systemd.stopping() is called.
enableStatusUpdate(Duration) - Method in class com.github.jpmsilva.jsystemd.Systemd
Enables the periodic status updates, which send the status to systemd with Systemd.updateStatus() at the given period.
enableWatchdog() - Method in class com.github.jpmsilva.jsystemd.Systemd
Enables the periodic watchdog heartbeats when systemd expects them, that is, when the service unit sets WatchdogSec.
enableWatchdog(Duration) - Method in class com.github.jpmsilva.jsystemd.Systemd
Enables the periodic watchdog heartbeats, which are sent with Systemd.watchdog() at the given period, once the application is ready.
ENVIRONMENT_PREPARED - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application environment is prepared.
environmentPrepared(ConfigurableBootstrapContext, ConfigurableEnvironment) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
equals(Object) - Method in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Indicates whether some other object is "equal to" this one.
evaluateHealth() - Method in class com.github.jpmsilva.jsystemd.DelayableHealthProvider
Provides the actual health of the application, without the delay.
evaluateHealth() - Method in class com.github.jpmsilva.jsystemd.FileDescriptorStatusProvider
Provides the health of the application, without the delay: unhealthy while the open file descriptors are at or above the threshold, if enabled.
evaluateHealth() - Method in class com.github.jpmsilva.jsystemd.spring.ActuatorHealthStatusProvider
Provides the health of the application for the watchdog, without the delay: always healthy unless reporting the unhealthy state to the watchdog is enabled.
evaluateHealth() - Method in class com.github.jpmsilva.jsystemd.spring.AvailabilityStatusProvider
Provides the health of the application, without the delay: unhealthy while the liveness state is broken, if enabled.
evaluateHealth() - Method in class com.github.jpmsilva.jsystemd.spring.HikariStatusProvider
Provides the health of the application, without the delay: unhealthy while any pool is starved, if enabled.
ExecutorStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides information regarding a thread pool: the busy threads out of the threads in the pool, and the tasks waiting for a thread, such as workers: 3/10 threads, 5 queued.
ExecutorStatusProvider(String, ThreadPoolExecutor) - Constructor for class com.github.jpmsilva.jsystemd.ExecutorStatusProvider
Create a new ExecutorStatusProvider for the given thread pool.
ExecutorStatusProvider(String, Supplier<? extends ThreadPoolExecutor>) - Constructor for class com.github.jpmsilva.jsystemd.ExecutorStatusProvider
Create a new ExecutorStatusProvider for the thread pool given by the supplier, when the status is read.
extendTimeout() - Method in class com.github.jpmsilva.jsystemd.Systemd
Forces the timeout to be extended.

F

failed(ConfigurableApplicationContext, Throwable) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
Closes the instance if the application fails to start, as the context may not have created the bean yet, in which case it would not close it.
FileDescriptorStatusProvider - Class in com.github.jpmsilva.jsystemd
Provides information regarding the file descriptors of the process: as a StatusProvider, the open file descriptors out of the most the process can open, such as File descriptors: 812/65536, and as a HealthProvider, for the systemd watchdog, reporting the application as unhealthy when they are about to run out, if enabled.
FileDescriptorStatusProvider(boolean, double) - Constructor for class com.github.jpmsilva.jsystemd.FileDescriptorStatusProvider
Create a new FileDescriptorStatusProvider.

G

GarbageCollectionStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the garbage collection pauses since the status was last read, or since this provider was created: how many there were, and the share of the time they took, such as GC: 12 pauses, 0.4% of time.
GarbageCollectionStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.GarbageCollectionStatusProvider
Create a new GarbageCollectionStatusProvider, which reports the pauses since it was created on the first read.
getActuatorHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the ActuatorHealthStatusProvider.
getApplicationContext() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
getApplicationRun() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the ApplicationRunStatusProvider.
getAvailability() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the AvailabilityStatusProvider.
getBufferPools() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the BufferPoolStatusProvider.
getCgroupMemory() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the CgroupMemoryStatusProvider.
getClassLoader() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the ClassLoaderStatusProvider.
getConfigMetadata() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
 
getCpu() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the CpuStatusProvider.
getFileDescriptors() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the FileDescriptorStatusProvider.
getGarbageCollection() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the GarbageCollectionStatusProvider.
getGroup() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Check the name of the Spring Boot Actuator health group whose members are taken into account.
getHealthProviders() - Method in class com.github.jpmsilva.jsystemd.Systemd
Returns a read only snapshot of the current health providers.
getHeap() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the HeapStatusProvider.
getHikari() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the HikariStatusProvider.
getId() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
 
getJetty() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the JettyStatusProvider.
getLiquibase() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the LiquibaseStatusProvider.
getName() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
 
getNetty() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the NettyStatusProvider.
getNonHeap() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the NonHeapStatusProvider.
getOldGeneration() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the OldGenerationStatusProvider.
getOrder() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
getPhase() - Method in class com.github.jpmsilva.jsystemd.PhaseStatusProvider
Returns the current phase.
getProviderClass() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
 
getProviderFactoryClass() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
 
getReadyEvent() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Returns when systemd is told that the application is ready.
getShutdown() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the ShutdownStatusProvider.
getStatusProviders() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
The settings of the built-in status providers.
getStatusProviders() - Method in class com.github.jpmsilva.jsystemd.Systemd
Returns a read only snapshot of the current providers.
getStatusUpdatePeriod() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Returns how often the status is sent to systemd.
getTaskExecutors() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the TaskExecutorStatusProvider.
getThreads() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the ThreadStatusProvider.
getThreshold() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Check the share of the limit of file descriptors from which the application is unhealthy.
getTomcat() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.StatusProviders
The settings of the TomcatStatusProvider.
getUnhealthyDelay() - Method in class com.github.jpmsilva.jsystemd.DelayableHealthProvider
Returns the delay before the unhealthy state is reported.
getUnhealthyDelay() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Check the delay before suppressing the watchdog heartbeat while the application is unhealthy.
getUnhealthyDelay() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Availability
Check the delay before suppressing the watchdog heartbeat while the liveness state of the application is broken.
getUnhealthyDelay() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Check the delay before suppressing the watchdog heartbeat while the open file descriptors are at or above the threshold.
getUnhealthyDelay() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Hikari
Check the delay before suppressing the watchdog heartbeat while any connection pool is starved.
getUnhealthyStatusCodes() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Check the status codes from Status to consider as unhealthy.

H

hashCode() - Method in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Returns a hash code value for this object.
health() - Method in class com.github.jpmsilva.jsystemd.DelayableHealthProvider
Provides the health of the application, reporting it as healthy while it has been unhealthy for less than the delay.
health() - Method in interface com.github.jpmsilva.jsystemd.HealthProvider
Determines if an application is healthy.
health() - Method in class com.github.jpmsilva.jsystemd.ThreadStatusProvider
Reports the application as unhealthy while any of the enabled health conditions holds.
Health(boolean, Map<String, Object>) - Constructor for record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Provides for a health representation (healthy/unhealthy), with health details for each component.
HealthProvider - Interface in com.github.jpmsilva.jsystemd
A health provider can be used to control the watchdog heartbeat.
HealthProvider.Health - Record Class in com.github.jpmsilva.jsystemd
The health state of an application.
healthy() - Method in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Returns the value of the healthy record component.
HEALTHY - Static variable in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
A health object that represents a healthy application state.
HeapStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the memory used by the heap, out of its committed size, such as Heap: 139.5 MiB/256.0 MiB.
HeapStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.HeapStatusProvider
Create a new HeapStatusProvider.
HikariStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Provides information regarding the HikariCP connection pools of the application: as a StatusProvider, for each pool, named after its data source bean, the connections in use out of the most the pool opens, and the threads waiting for a connection, such as dataSource: 7/10 connections, 3 waiting, and as a HealthProvider, for the systemd watchdog, reporting the application as unhealthy while a pool is starved, if enabled.
HikariStatusProvider(ConfigurableListableBeanFactory, boolean) - Constructor for class com.github.jpmsilva.jsystemd.spring.HikariStatusProvider
Creates a new instance that finds the data sources in the given bean factory.

I

ID - Static variable in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
The id of the factory, which is part of its options.
init(Config.Scope) - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
Starts the integration with systemd, when Keycloak initializes its providers, at the start of its bootstrap.
instance() - Static method in class com.github.jpmsilva.jsystemd.Systemd
Returns the instance of this process, creating it on first use.
isDeadlockDetection() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Threads
Check if deadlocked threads are detected.
isDeadlockHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Threads
Check if the watchdog heartbeat is suppressed while any thread is deadlocked.
isEnabled() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Toggle
Check if the status provider is enabled.
isHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Check if the watchdog heartbeat is suppressed while the application is unhealthy.
isHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Availability
Check if the watchdog heartbeat is suppressed while the liveness state of the application is broken.
isHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Check if the watchdog heartbeat is suppressed while the open file descriptors are at or above the threshold.
isHealth() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Hikari
Check if the watchdog heartbeat is suppressed while any connection pool is starved.
isInternal() - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
 
isReady() - Method in class com.github.jpmsilva.jsystemd.Systemd
Returns if the startup of the application is over.
isUnderSystemd() - Static method in class com.github.jpmsilva.jsystemd.Systemd
Returns if the application runs under systemd, that is, if the notifications sent to systemd reach it: the operating system is Linux, systemd set the NOTIFY_SOCKET environment variable, and the notifications could be set up: on Java 22 and later, with the Foreign Function and Memory API, unless native access is denied, and otherwise, as on Java 17 to 21 or for vsock: addresses, the native libsystemd library could be loaded.
isWatchdogSuppressWarning() - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Check if the warnings logged when the application health is signalled to the systemd watchdog, but in a way that never suppresses the heartbeat, are suppressed.

J

JettyStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the embedded Jetty servers of the application.
JettyStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.spring.JettyStatusProvider
Create a new JettyStatusProvider.

L

LiquibaseStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides the progress of the Liquibase database migrations run on startup, such as Liquibase: applying changeset 042-add-index (41 applied).
LiquibaseStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.spring.LiquibaseStatusProvider
Creates a new instance, which sends the status to systemd on every change, and extends the startup timeout on every changeset.
logStatus() - Method in class com.github.jpmsilva.jsystemd.Systemd
Logs information regarding the status of the integration with systemd.

N

NAME - Static variable in class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
The name of the SPI, which prefixes its options.
NettyStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the embedded Reactor Netty servers of the application.
NettyStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.spring.NettyStatusProvider
Create a new NettyStatusProvider.
NonHeapStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the memory used outside of the heap by the JVM, such as by the metaspace and the code cache, out of its committed size, such as Non-heap: 62.7 MiB/64.1 MiB.
NonHeapStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.NonHeapStatusProvider
Create a new NonHeapStatusProvider.

O

OldGenerationStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider that provides the memory used by the old generation of the heap after the last garbage collection, out of its maximum size (or its committed size, when it has no maximum), such as Old gen after GC: 120.0 MiB/512.0 MiB.
OldGenerationStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.OldGenerationStatusProvider
Create a new OldGenerationStatusProvider.
onApplicationEvent(AvailabilityChangeEvent<?>) - Method in class com.github.jpmsilva.jsystemd.spring.AvailabilityStatusProvider
Keeps the latest liveness and readiness states of the event.
onApplicationEvent(WebServerInitializedEvent) - Method in class com.github.jpmsilva.jsystemd.spring.JettyStatusProvider
Adds the server of the event to the servers that are reported, if it is a Jetty server.
onApplicationEvent(WebServerInitializedEvent) - Method in class com.github.jpmsilva.jsystemd.spring.TomcatStatusProvider
Adds the server of the event to the servers whose connectors are reported, if it is a Tomcat server.
onApplicationEvent(ContextClosedEvent) - Method in class com.github.jpmsilva.jsystemd.spring.ShutdownStatusProvider
Reports that the application started shutting down, when the event is about its own application context: the events of child contexts, such as the one of the management endpoints when they use a port of their own, are also published to their parents.
onApplicationEvent(ContextClosedEvent) - Method in class com.github.jpmsilva.jsystemd.spring.SystemdLifecycle
Sends the stopping signal, when the event is about its own application context: the events of child contexts, such as the one of the management endpoints when they use a port of their own, are also published to their parents.
ORDER - Static variable in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
The order of this listener.

P

PhaseStatusProvider - Class in com.github.jpmsilva.jsystemd
Implementation of StatusProvider whose status is set by the application, to report what it is doing, such as Reindexing 40% or Migrating the schema.
PhaseStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.PhaseStatusProvider
Create a new PhaseStatusProvider, whose changes of phase are sent to systemd with the next status update.
PhaseStatusProvider(boolean) - Constructor for class com.github.jpmsilva.jsystemd.PhaseStatusProvider
Create a new PhaseStatusProvider, whose changes of phase are sent to systemd either right away or with the next status update.
postInit(KeycloakSessionFactory) - Method in class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
Tells systemd that Keycloak is ready once it has completed its bootstrap, and its HTTP server listens.
postProcessAfterInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationContextStatusProvider
 
postProcessAfterInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.spring.LiquibaseStatusProvider
Clears the progress once a SpringLiquibase bean ran the migrations.
postProcessBeforeInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationContextStatusProvider
Notifies systemd of the bean creation progress, at most once a second, while the application starts up: the beans created afterwards, such as prototype or request scoped beans, are not part of the startup, and must neither extend the shutdown timeout once the application is stopping, nor update the status on the threads that create them, such as the threads that serve requests.
postProcessBeforeInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.spring.LiquibaseStatusProvider
Makes the Liquibase instance run by a SpringLiquibase bean report each changeset it applies, before the bean runs the migrations.

R

ready() - Method in class com.github.jpmsilva.jsystemd.Systemd
Notifies systemd that the application is ready.
ready(ConfigurableApplicationContext, Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
READY - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application is ready.
registerShutdownHook() - Static method in class com.github.jpmsilva.jsystemd.SystemdNotify
Registers a JVM shutdown hook that closes the systemd integration channel.
removeHealthProviders(HealthProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Removes the health providers from the list of health providers.
removeHealthProviders(List<HealthProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Removes the health providers from the list of health providers.
removeStatusProviders(StatusProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
Removes the status providers from the list of providers.
removeStatusProviders(List<StatusProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
Removes the status providers from the list of providers.
requestsStage() - Method in class com.github.jpmsilva.jsystemd.spring.ShutdownStatusProvider
Returns the life cycle bean that reports when the web server starts waiting for the active requests: it is stopped right before the web server shuts down gracefully.

S

setDeadlockDetection(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Threads
Enable or disable the detection of deadlocked threads.
setDeadlockHealth(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Threads
Enable or disable suppressing the watchdog heartbeat while any thread is deadlocked.
setEnabled(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Toggle
Enable or disable the status provider.
setGroup(String) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Set the name of the Spring Boot Actuator health group whose members are shown in the systemd status and taken into account for the health signal.
setHealth(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Enable or disable suppressing the watchdog heartbeat while the application is unhealthy.
setHealth(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Availability
Enable or disable suppressing the watchdog heartbeat while the liveness state of the application is broken.
setHealth(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Enable or disable suppressing the watchdog heartbeat while the open file descriptors are at or above the threshold.
setHealth(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Hikari
Enable or disable suppressing the watchdog heartbeat while any connection pool is starved.
setPhase(String) - Method in class com.github.jpmsilva.jsystemd.PhaseStatusProvider
Sets the current phase, which is shown as is in the status.
setReadyEvent(SystemdProperties.ReadyEvent) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Sets when systemd is told that the application is ready.
setStatusUpdatePeriod(Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Sets how often the status is sent to systemd.
setThreshold(double) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Set the share of the limit of file descriptors from which the application is unhealthy.
setUnhealthyDelay(Duration) - Method in class com.github.jpmsilva.jsystemd.DelayableHealthProvider
Sets the delay before the unhealthy state is reported.
setUnhealthyDelay(Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Set the delay before suppressing the watchdog heartbeat while the application is unhealthy.
setUnhealthyDelay(Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Availability
Set the delay before suppressing the watchdog heartbeat while the liveness state of the application is broken.
setUnhealthyDelay(Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.FileDescriptors
Set the delay before suppressing the watchdog heartbeat while the open file descriptors are at or above the threshold.
setUnhealthyDelay(Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.Hikari
Set the delay before suppressing the watchdog heartbeat while any connection pool is starved.
setUnhealthyStatusCodes(List<String>) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ActuatorHealth
Set the status codes from Status to consider as unhealthy.
setWatchdogSuppressWarning(boolean) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties
Suppress the warnings logged when the application health is signalled to the systemd watchdog, but in a way that never suppresses the heartbeat.
ShutdownStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides the stage the application is at while it shuts down, such as Shutdown: waiting for active requests, so that a slow shutdown can be told apart from a hung one with systemctl status.
ShutdownStatusProvider(ApplicationContext) - Constructor for class com.github.jpmsilva.jsystemd.spring.ShutdownStatusProvider
Creates a new instance, which sends the status to systemd on every change of stage.
started(AvailabilityChangeEvent<ReadinessState>) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdAutoConfiguration
Event listener for the AvailabilityChangeEvent event to report to systemd that the service is ready.
started(ConfigurableApplicationContext, Duration) - Method in class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
 
STARTED - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application is started.
STARTING - Enum constant in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
The application is starting.
state(ApplicationRunStatusProvider.ApplicationState) - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider
Updates the current application startup sequence state of the application, sending the update to systemd as well.
state(ApplicationRunStatusProvider.ApplicationState, Duration) - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider
Updates the current application startup sequence state of the application, sending the update to systemd as well.
status() - Method in class com.github.jpmsilva.jsystemd.BufferPoolStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.CgroupMemoryStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.ClassLoaderStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.CpuStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.ExecutorStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.FileDescriptorStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.GarbageCollectionStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.HeapStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.NonHeapStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.OldGenerationStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.PhaseStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.ActuatorHealthStatusProvider
Provides the application health for the systemd status, naming the unhealthy contributors, if any.
status() - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationContextStatusProvider
Returns the bean creation progress, counting the singletons created so far, out of those created on startup: lazy ones, which may only be created once used, are left out, and nothing is reported when all of them are lazy.
status() - Method in class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.AvailabilityStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.HikariStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.JettyStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.LiquibaseStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.NettyStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.ShutdownStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.TaskExecutorStatusProvider
 
status() - Method in class com.github.jpmsilva.jsystemd.spring.TomcatStatusProvider
 
status() - Method in interface com.github.jpmsilva.jsystemd.StatusProvider
Exposes status information to send to systemd.
status() - Method in class com.github.jpmsilva.jsystemd.ThreadStatusProvider
 
StatusProvider - Interface in com.github.jpmsilva.jsystemd
Interface that represents any object that can contribute with status information regarding the running process to the service supervisor.
stopping() - Method in class com.github.jpmsilva.jsystemd.Systemd
Signals that the application is stopping.
Systemd - Class in com.github.jpmsilva.jsystemd
The main systemd integration class.
SystemdAutoConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Autoconfiguration class for systemd integration.
SystemdAutoConfiguration.SystemdActuatorHealthConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when using Spring Boot Actuator, providing a HealthProvider based on its health contributors.
SystemdAutoConfiguration.SystemdHikariConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when using HikariCP connection pools.
SystemdAutoConfiguration.SystemdJettyConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when running under the embedded Jetty of Spring Boot.
SystemdAutoConfiguration.SystemdLiquibaseConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when using Liquibase, reporting the progress of the database migrations run on startup.
SystemdAutoConfiguration.SystemdNettyConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when running under the embedded Reactor Netty of Spring Boot.
SystemdAutoConfiguration.SystemdOperatingSystemConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for the status providers that read the operating system beans specific to the JVMs based on OpenJDK, which are left out on other JVMs.
SystemdAutoConfiguration.SystemdTomcatConfiguration - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Configuration class for systemd integration when running under the embedded Tomcat of Spring Boot.
SystemdLifecycle - Class in com.github.jpmsilva.jsystemd.spring
Sends the stopping signal to systemd when the application context starts closing, before its life cycle beans stop, such as the embedded web server, which then waits for the active requests.
SystemdLifecycle(ApplicationContext) - Constructor for class com.github.jpmsilva.jsystemd.spring.SystemdLifecycle
Creates a new instance, which sends the stopping signal with Systemd.instance() when the given context starts closing.
SystemdNotify - Class in com.github.jpmsilva.jsystemd
Low level API that sends notifications to systemd, through the socket in the environment variable NOTIFY_SOCKET.
SystemdProperties - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Properties of the integration with systemd when using Spring Boot, all under systemd.
SystemdProperties.ActuatorHealth - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The ActuatorHealthStatusProvider, which provides the application health when using Spring Boot Actuator.
SystemdProperties.Availability - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The AvailabilityStatusProvider, which provides the liveness and readiness of the application.
SystemdProperties.FileDescriptors - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The FileDescriptorStatusProvider, which provides information regarding the open file descriptors.
SystemdProperties.Hikari - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The HikariStatusProvider, which provides information regarding the HikariCP connection pools.
SystemdProperties.ReadyEvent - Enum Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The event on which systemd is told that the application is ready, with Systemd.ready().
SystemdProperties.StatusProviders - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The built-in status providers, under their keys: each can be enabled or disabled, and some can be configured further.
SystemdProperties.Threads - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
The ThreadStatusProvider, which provides information regarding the live threads, and detects deadlocks.
SystemdProperties.Toggle - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
Enables or disables one status provider.
SystemdProvider - Interface in com.github.jpmsilva.jsystemd.keycloak
The provider of the systemd SPI.
SystemdProviderFactory - Class in com.github.jpmsilva.jsystemd.keycloak
Integrates Keycloak with systemd, following the life cycle of Keycloak: when Keycloak initializes its providers, at the start of its bootstrap, the integration starts, and the status shows Startup: bootstrapping; once Keycloak has completed its bootstrap, which includes migrating the database and importing realms, and its HTTP server listens, systemd is told that Keycloak is ready.
SystemdProviderFactory() - Constructor for class com.github.jpmsilva.jsystemd.keycloak.SystemdProviderFactory
Creates a new instance, as Keycloak does.
SystemdSpi - Class in com.github.jpmsilva.jsystemd.keycloak
The systemd SPI, whose only factory, SystemdProviderFactory, integrates Keycloak with systemd.
SystemdSpi() - Constructor for class com.github.jpmsilva.jsystemd.keycloak.SystemdSpi
 
SystemdSpringApplicationRunListener - Class in com.github.jpmsilva.jsystemd.spring.autoconfigure
A Spring Application Run Listener that sets up the integration with systemd, as early as possible during the startup of the application.
SystemdSpringApplicationRunListener(SpringApplication, String[]) - Constructor for class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdSpringApplicationRunListener
Mandatory constructor of SpringApplicationRunListener.

T

TaskExecutorStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the thread pools of the task executors and schedulers of the application, such as the ones Spring Boot sets up for @Async and @Scheduled methods, each reported by an ExecutorStatusProvider named after its bean, such as applicationTaskExecutor: 2/8 threads, 5 queued, taskScheduler: 1/1 threads, 3 scheduled.
TaskExecutorStatusProvider(ConfigurableListableBeanFactory) - Constructor for class com.github.jpmsilva.jsystemd.spring.TaskExecutorStatusProvider
Creates a new instance that finds the task executors in the given bean factory.
ThreadStatusProvider - Class in com.github.jpmsilva.jsystemd
Provides information regarding the live threads: as a StatusProvider, the number of threads by state, and the number of deadlocked threads, if any, for the systemd status, and as a HealthProvider, for the systemd watchdog, reporting the application as unhealthy under the health conditions it is configured with.
ThreadStatusProvider(boolean, boolean) - Constructor for class com.github.jpmsilva.jsystemd.ThreadStatusProvider
Create a new ThreadStatusProvider.
TomcatStatusProvider - Class in com.github.jpmsilva.jsystemd.spring
Implementation of StatusProvider that provides information regarding the connectors of the embedded Tomcat servers of the application.
TomcatStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.spring.TomcatStatusProvider
Create a new TomcatStatusProvider.
toString() - Method in record class com.github.jpmsilva.jsystemd.HealthProvider.Health
Returns a string representation of this record class.

U

updateStatus() - Method in class com.github.jpmsilva.jsystemd.Systemd
Forces the current status to be calculated and sent to systemd.

V

valueOf(String) - Static method in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ReadyEvent
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.jpmsilva.jsystemd.spring.ApplicationRunStatusProvider.ApplicationState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.jpmsilva.jsystemd.spring.autoconfigure.SystemdProperties.ReadyEvent
Returns an array containing the constants of this enum class, in the order they are declared.

W

watchdog() - Method in class com.github.jpmsilva.jsystemd.Systemd
Forces the watchdog timestamp to be updated.
watchdogTimeout() - Static method in class com.github.jpmsilva.jsystemd.Systemd
Returns the watchdog timeout of the service unit, that is, the WatchdogSec it sets, which systemd passes to the application in the WATCHDOG_USEC environment variable.
A B C D E F G H I J L N O P R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values