org.springframework.boot.web.embedded.tomcat

Class TomcatWebServer

java.lang.Object

org.springframework.boot.web.embedded.tomcat.TomcatWebServer

All Implemented Interfaces:

WebServer

public class TomcatWebServer
extends Object
implements WebServer

WebServer that can be used to control a Tomcat web server. Usually this class should be created using the TomcatReactiveWebServerFactory of TomcatServletWebServerFactory, but not directly.

Since:

2.0.0

Author:

Brian Clozel, Kristine Jetzke

Constructor Summary

Constructors

Constructor and Description
TomcatWebServer(Tomcat tomcat) Create a new TomcatWebServer instance.
TomcatWebServer(Tomcat tomcat, boolean autoStart) Create a new TomcatWebServer instance.
TomcatWebServer(Tomcat tomcat, boolean autoStart, Duration shutdownGracePeriod) Create a new TomcatWebServer instance.

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port this server is listening on.
Tomcat	getTomcat() Returns access to the underlying Tomcat server.
boolean	shutDownGracefully() Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Constructor Detail

TomcatWebServer

public TomcatWebServer(Tomcat tomcat)

Create a new TomcatWebServer instance.

Parameters:

tomcat - the underlying Tomcat server

TomcatWebServer

public TomcatWebServer(Tomcat tomcat,
                       boolean autoStart)

Create a new TomcatWebServer instance.

Parameters:

tomcat - the underlying Tomcat server

autoStart - if the server should be started

TomcatWebServer

public TomcatWebServer(Tomcat tomcat,
                       boolean autoStart,
                       Duration shutdownGracePeriod)

Create a new TomcatWebServer instance.

Parameters:

tomcat - the underlying Tomcat server

autoStart - if the server should be started

shutdownGracePeriod - grace period to use when shutting down

Since:

2.3.0

Method Detail

start

public void start()
           throws WebServerException

Description copied from interface: WebServer

Starts the web server. Calling this method on an already started server has no effect.

Specified by:

start in interface WebServer

Throws:

WebServerException - if the server cannot be started

stop

public void stop()
          throws WebServerException

Description copied from interface: WebServer

Stops the web server. Calling this method on an already stopped server has no effect.

Specified by:

stop in interface WebServer

Throws:

WebServerException - if the server cannot be stopped

getPort

public int getPort()

Description copied from interface: WebServer

Return the port this server is listening on.

Specified by:

getPort in interface WebServer

Returns:

the port (or -1 if none)

getTomcat

public Tomcat getTomcat()

Returns access to the underlying Tomcat server.

Returns:

the Tomcat server

shutDownGracefully

public boolean shutDownGracefully()

Description copied from interface: WebServer

Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.

Specified by:

shutDownGracefully in interface WebServer

Returns:

true if graceful shutdown completed within the period, otherwise false