Package io.quarkus.runtime

Class ShutdownEvent

java.lang.Object

jakarta.enterprise.event.Shutdown

io.quarkus.runtime.ShutdownEvent

public class ShutdownEvent
extends jakarta.enterprise.event.Shutdown

Event that is fired before shutdown and can be inspected for shutdown cause. See isStandardShutdown() This event is observed as follows:

     void onStop(@Observes ShutdownEvent ev) {
         LOGGER.info("The application is stopping...");
     }
 

The annotated method can access other injected beans.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static enum	ShutdownEvent.ShutdownReason	An enum with values reflecting the reason for application shutdown.

Constructor Summary

Constructors

Constructor	Description
ShutdownEvent()
ShutdownEvent(ShutdownEvent.ShutdownReason shutdownReason)

Method Summary

Modifier and Type	Method	Description
boolean	isStandardShutdown()	Returns true if the application shutdown is considered standard; i.e.

Methods inherited from class java.lang.Object

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

Constructor Details

ShutdownEvent

public ShutdownEvent()

ShutdownEvent

public ShutdownEvent(ShutdownEvent.ShutdownReason shutdownReason)

Method Details

isStandardShutdown

public boolean isStandardShutdown()

Returns true if the application shutdown is considered standard; i.e. by exiting main() method or executing either Quarkus.asyncExit() or Quarkus.blockingExit().

All other cases are non-standard - SIGINT, SIGTERM, System.exit(n and so on. Sending CTRL + C to running app in terminal is also non-standard shutdown.

Returns:

true if the app shutdown was standard, false otherwise