Index
All Classes and Interfaces|All Packages
A
- addStatusProviders(int, SystemdStatusProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Adds the status providers to the list of providers in the specified position.
- addStatusProviders(int, List<SystemdStatusProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Adds the status providers to the list of providers in the specified position.
- addStatusProviders(SystemdStatusProvider...) - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Adds the status providers to the end of the list of providers.
B
- build() - Method in class com.github.jpmsilva.jsystemd.Systemd.Builder
-
Builds a
Systemd
instance. - builder() - Static method in class com.github.jpmsilva.jsystemd.Systemd
-
Provides a dedicated builder instance that knows how to create Systemd instances.
C
- close() - Method in class com.github.jpmsilva.jsystemd.Systemd
- 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
- ConditionalOnSystemd - Annotation Interface in com.github.jpmsilva.jsystemd
-
Conditional
that only matches when the process is running under systemd. - CONTEXT_LOADED - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application context is loaded.
- CONTEXT_PREPARED - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application context is prepared.
- contextDestroyed(ServletContextEvent) - Method in class com.github.jpmsilva.jsystemd.SystemdServletContextListener
- contextLoaded(ConfigurableApplicationContext) - Method in class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
- contextPrepared(ConfigurableApplicationContext) - Method in class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
D
- details - Variable in class com.github.jpmsilva.jsystemd.HealthProvider.Health
-
Additional health details for each application component.
- disablePeriodicExtendTimeout() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Disables the periodic extension of the timeout.
E
- enablePeriodicExtendTimeout() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Enables the periodic extension of the timeout.
- ENVIRONMENT_PREPARED - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application environment is prepared.
- environmentPrepared(ConfigurableBootstrapContext, ConfigurableEnvironment) - Method in class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
- extendTimeout() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Forces the timeout to be extended.
- extendTimeout(long, TimeUnit, long) - Method in class com.github.jpmsilva.jsystemd.Systemd.Builder
-
Enables periodic timeout extensions.
G
- getHealthProvider() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Returns the current health provider.
- getStatusProviders() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Returns a read only view of the current providers.
- getUnhealthyPendingPeriodMs() - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Check the delay reporting unhealthy status to systemd watchdog.
- getUnhealthyStatusCodes() - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Check the status codes from
Status
to consider as unhealthy.
H
- health() - Method in interface com.github.jpmsilva.jsystemd.HealthProvider
-
Determines if an application is healthy.
- health() - Method in class com.github.jpmsilva.jsystemd.PendingHealthProvider
- health() - Method in class com.github.jpmsilva.jsystemd.SystemdActuatorHealthProvider
- Health(boolean, Map<String, Object>) - Constructor for 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 - Class in com.github.jpmsilva.jsystemd
-
Wrapper of health state.
- healthy - Variable in class com.github.jpmsilva.jsystemd.HealthProvider.Health
-
true
if this object represents a healthy state,false
otherwise. - healthy() - Static method in class com.github.jpmsilva.jsystemd.HealthProvider.Health
-
Synthesize a health object that represents a healthy application state.
I
- isEnabled() - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Check if the integration between Spring Boot Actuator health status and systemd watchdog is enabled.
- isReady() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Returns if the application as completed startup.
- isRunning() - Method in class com.github.jpmsilva.jsystemd.SystemdLifecycle
L
- logStatus() - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Logs information regarding the status of the integration with systemd.
P
- PendingHealthProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
HealthProvider
that suppresses/delays the unhealthy state of a delegate for a configurable period. - PendingHealthProvider(HealthProvider, long, TemporalUnit) - Constructor for class com.github.jpmsilva.jsystemd.PendingHealthProvider
-
Creates a new health provider that delegates the actual work to the
delegate
, and delays reporting unhealthy status. - postProcessAfterInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.SystemdApplicationContextStatusProvider
- postProcessBeforeInitialization(Object, String) - Method in class com.github.jpmsilva.jsystemd.SystemdApplicationContextStatusProvider
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.SystemdSpringApplicationRunListener
- READY - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application is ready.
- registerShutdownHook() - Static method in class com.github.jpmsilva.jsystemd.SystemdNotify
-
Registers a JVM shutdown hook that closes the system integration channel.
S
- setEnabled(boolean) - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Enable integration between Spring Boot Actuator health status and systemd watchdog.
- setHealthProvider(HealthProvider) - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Sets the current health provider, overrides any other previously set.
- setStatusProviders(List<SystemdStatusProvider>) - Method in class com.github.jpmsilva.jsystemd.Systemd
-
Sets the current providers, unregistering any other previously added.
- setUnhealthyPendingPeriodMs(Long) - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Set the delay reporting unhealthy status to systemd watchdog.
- setUnhealthyStatusCodes(List<String>) - Method in class com.github.jpmsilva.jsystemd.SystemdHealthProviderProperties
-
Set the status codes from
Status
to consider as unhealthy. - start() - Method in class com.github.jpmsilva.jsystemd.SystemdLifecycle
- started(ApplicationReadyEvent) - Method in class com.github.jpmsilva.jsystemd.SystemdAutoConfiguration
-
Event listener for the
ApplicationReadyEvent
event to report to systemd that the service is ready. - started(ConfigurableApplicationContext, Duration) - Method in class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
- STARTED - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application is started.
- starting(ConfigurableBootstrapContext) - Method in class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
- STARTING - Enum constant in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
The application is starting.
- state(SystemdApplicationRunStatusProvider.ApplicationState, Duration) - Method in class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider
-
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.SystemdActuatorHealthProvider
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdApplicationContextStatusProvider
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdClassLoaderStatusProvider
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdHeapStatusProvider
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdNonHeapStatusProvider
- status() - Method in interface com.github.jpmsilva.jsystemd.SystemdStatusProvider
-
Exposes status information to send to systemd.
- status() - Method in class com.github.jpmsilva.jsystemd.SystemdTomcatStatusProvider
- statusUpdate(long, TimeUnit) - Method in class com.github.jpmsilva.jsystemd.Systemd.Builder
-
Enables periodic status updates.
- stop() - Method in class com.github.jpmsilva.jsystemd.SystemdLifecycle
- 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.
- Systemd.Builder - Class in com.github.jpmsilva.jsystemd
-
Specialized build class of
Systemd
objects. - SystemdActuatorHealthProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
HealthProvider
that provides application health based on Spring Boot Actuator Health Indicators. - SystemdActuatorHealthProvider(List<HealthIndicator>, Set<Status>) - Constructor for class com.github.jpmsilva.jsystemd.SystemdActuatorHealthProvider
-
Creates a new instance using the provided
HealthIndicator
andStatus
. - SystemdApplicationContextStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding the bean creation progress of a bean factory. - SystemdApplicationRunStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding the Spring Boot application startup sequence state. - SystemdApplicationRunStatusProvider.ApplicationState - Enum Class in com.github.jpmsilva.jsystemd
-
Enumeration of supported application startup sequence state.
- SystemdAutoConfiguration - Class in com.github.jpmsilva.jsystemd
-
Autoconfiguration class for systemd integration.
- SystemdAutoConfiguration.SystemdAutoActuatorHealthConfiguration - Class in com.github.jpmsilva.jsystemd
-
Autoconfiguration class for systemd integration when using Spring Boot Actuator.
- SystemdAutoConfiguration.SystemdAutoTomcatConfiguration - Class in com.github.jpmsilva.jsystemd
-
Autoconfiguration class for systemd integration when running under Tomcat.
- SystemdClassLoaderStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding loaded classes. - SystemdClassLoaderStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.SystemdClassLoaderStatusProvider
-
Create a new SystemdClassLoaderStatusProvider.
- SystemdHealthProviderProperties - Class in com.github.jpmsilva.jsystemd
-
Properties class for systemd integration when using Spring Boot Actuator.
- SystemdHeapStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding the heap zone of the memory. - SystemdHeapStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.SystemdHeapStatusProvider
-
Create a new SystemdHeapStatusProvider.
- SystemdLifecycle - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SmartLifecycle
that logs systemd integration status on startup, and sends a stopping signal when the application is shutting down. - SystemdLifecycle(Systemd) - Constructor for class com.github.jpmsilva.jsystemd.SystemdLifecycle
-
Creates a new instance using the provided
Systemd
as the integration point. - SystemdNonHeapStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding the non-heap zone of the memory. - SystemdNonHeapStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.SystemdNonHeapStatusProvider
-
Create a new SystemdNonHeapStatusProvider.
- SystemdNotify - Class in com.github.jpmsilva.jsystemd
-
Low level API that interfaces with systemd through a
UnixDomainSocketAddress
. - SystemdNotify() - Constructor for class com.github.jpmsilva.jsystemd.SystemdNotify
- SystemdServletContextListener - Class in com.github.jpmsilva.jsystemd
-
Implementation of
ServletContextListener
that closes the systemd integration channel. - SystemdServletContextListener() - Constructor for class com.github.jpmsilva.jsystemd.SystemdServletContextListener
- SystemdSpringApplicationRunListener - Class in com.github.jpmsilva.jsystemd
-
A Spring Application Run Listener that sets up a
SystemdApplicationRunStatusProvider
to provide status updates of the current phase of the application life cycle. - SystemdSpringApplicationRunListener(SpringApplication, String[]) - Constructor for class com.github.jpmsilva.jsystemd.SystemdSpringApplicationRunListener
-
Mandatory constructor of SpringApplicationRunListener.
- SystemdStatusProvider - 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.
- SystemdTomcatStatusProvider - Class in com.github.jpmsilva.jsystemd
-
Implementation of
SystemdStatusProvider
that provides information regarding Tomcat thread pools. - SystemdTomcatStatusProvider() - Constructor for class com.github.jpmsilva.jsystemd.SystemdTomcatStatusProvider
-
Create a new SystemdTomcatStatusProvider.
T
- toString() - Method in class com.github.jpmsilva.jsystemd.HealthProvider.Health
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.SystemdApplicationRunStatusProvider.ApplicationState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.jpmsilva.jsystemd.SystemdApplicationRunStatusProvider.ApplicationState
-
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.
- watchdog(long, TimeUnit) - Method in class com.github.jpmsilva.jsystemd.Systemd.Builder
-
Enables periodic watchdog timestamp updates.
All Classes and Interfaces|All Packages