Package io.micronaut.runtime.graceful

Class GracefulShutdownConfiguration

java.lang.Object

io.micronaut.runtime.graceful.GracefulShutdownConfiguration

All Implemented Interfaces:

Toggleable

@ConfigurationProperties("micronaut.lifecycle.graceful-shutdown")
@Requires(property="micronaut.lifecycle.graceful-shutdown.enabled",
          value="true",
          defaultValue="false")
public final class GracefulShutdownConfiguration
extends Object
implements Toggleable

Configuration for graceful shutdown.

Since:

4.9.0

Author:

Jonas Konrad

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
GracefulShutdownConfiguration()

Method Summary

Modifier and Type	Method	Description
@NonNull Duration	getGracePeriod()	Duration to wait until forcing a shutdown.
boolean	isEnabled()	Whether to enable graceful shutdown on normal shutdown.
void	setEnabled(boolean enabled)	Whether to enable graceful shutdown on normal shutdown.
void	setGracePeriod(@NonNull Duration gracePeriod)	Duration to wait until forcing a shutdown.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

ENABLED

public static final String ENABLED

See Also:

• Constant Field Values

Constructor Details

GracefulShutdownConfiguration

public GracefulShutdownConfiguration()

Method Details

isEnabled

@Bindable(defaultValue="false")
public boolean isEnabled()

Whether to enable graceful shutdown on normal shutdown. Off by default.

Specified by:

isEnabled in interface Toggleable

Returns:

true to enable graceful shutdown

setEnabled

public void setEnabled(boolean enabled)

Whether to enable graceful shutdown on normal shutdown. Off by default.

Parameters:

enabled - true to enable graceful shutdown

getGracePeriod

@NonNull
public @NonNull Duration getGracePeriod()

Duration to wait until forcing a shutdown.

Returns:

The maximum graceful shutdown duration

setGracePeriod

public void setGracePeriod(@NonNull
 @NonNull Duration gracePeriod)

Duration to wait until forcing a shutdown.

Parameters:

gracePeriod - The maximum graceful shutdown duration