Class WebServerGracefulShutdownLifecycle

java.lang.Object

org.springframework.boot.web.context.WebServerGracefulShutdownLifecycle

All Implemented Interfaces:

Lifecycle, Phased, SmartLifecycle

public final class WebServerGracefulShutdownLifecycle
extends Object
implements SmartLifecycle

SmartLifecycle to trigger WebServer graceful shutdown.

Since:

2.5.0

Author:

Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field	Description
static final int	SMART_LIFECYCLE_PHASE	Deprecated, for removal: This API element is subject to removal in a future version. as of 4.0.0 in favor of WebServerApplicationContext.GRACEFUL_SHUTDOWN_PHASE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
WebServerGracefulShutdownLifecycle(WebServer webServer)	Creates a new WebServerGracefulShutdownLifecycle that will gracefully shut down the given webServer.

Method Summary

Modifier and Type	Method	Description
int	getPhase()
boolean	isRunning()
void	start()
void	stop()
void	stop(Runnable callback)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.SmartLifecycle

isAutoStartup

Field Details

SMART_LIFECYCLE_PHASE

@Deprecated(since="4.0.0",
            forRemoval=true)
public static final int SMART_LIFECYCLE_PHASE

Deprecated, for removal: This API element is subject to removal in a future version.

as of 4.0.0 in favor of WebServerApplicationContext.GRACEFUL_SHUTDOWN_PHASE

SmartLifecycle phase in which graceful shutdown of the web server is performed.

See Also:

• Constant Field Values

Constructor Details

WebServerGracefulShutdownLifecycle

public WebServerGracefulShutdownLifecycle(WebServer webServer)

Creates a new WebServerGracefulShutdownLifecycle that will gracefully shut down the given webServer.

Parameters:

webServer - web server to shut down gracefully

Method Details

start

public void start()

Specified by:

start in interface Lifecycle

stop

public void stop()

Specified by:

stop in interface Lifecycle

stop

public void stop(Runnable callback)

Specified by:

stop in interface SmartLifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface Phased

Specified by:

getPhase in interface SmartLifecycle