TomcatWebServer (spring-boot 2.2.13.RELEASE)

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(org.apache.catalina.startup.Tomcat tomcat)` Create a new `TomcatWebServer` instance.
`TomcatWebServer(org.apache.catalina.startup.Tomcat tomcat, boolean autoStart)` Create a new `TomcatWebServer` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getPort()` Return the port this server is listening on.
`org.apache.catalina.startup.Tomcat`	`getTomcat()` Returns access to the underlying Tomcat server.
`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(org.apache.catalina.startup.Tomcat tomcat)
```
    Create a new TomcatWebServer instance.
    
    Parameters:
    
    tomcat - the underlying Tomcat server
  - TomcatWebServer
```
public TomcatWebServer(org.apache.catalina.startup.Tomcat tomcat,
                       boolean autoStart)
```
    Create a new TomcatWebServer instance.
    
    Parameters:
    
    tomcat - the underlying Tomcat server
    
    autoStart - if the server should be started
- 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 org.apache.catalina.startup.Tomcat getTomcat()
```
    Returns access to the underlying Tomcat server.
    
    Returns:
    
    the Tomcat server

Class TomcatWebServer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TomcatWebServer

TomcatWebServer

Method Detail

start

stop

getPort

getTomcat