TomcatEmbeddedServletContainer (spring-boot 1.5.13.RELEASE)

java.lang.Object
- org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer

All Implemented Interfaces:

EmbeddedServletContainer
```
public class TomcatEmbeddedServletContainer
extends Object
implements EmbeddedServletContainer
```
EmbeddedServletContainer that can be used to control an embedded Tomcat server. Usually this class should be created using the TomcatEmbeddedServletContainerFactory and not directly.

Author:

Phillip Webb, Dave Syer

See Also:

TomcatEmbeddedServletContainerFactory

Constructor Summary

Constructors
Constructor and Description
`TomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat)` Create a new `TomcatEmbeddedServletContainer` instance.
`TomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat, boolean autoStart)` Create a new `TomcatEmbeddedServletContainer` 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 embedded servlet container.
`void`	`stop()` Stops the embedded servlet container.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TomcatEmbeddedServletContainer
```
public TomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat)
```
    Create a new TomcatEmbeddedServletContainer instance.
    
    Parameters:
    
    tomcat - the underlying Tomcat server
  - TomcatEmbeddedServletContainer
```
public TomcatEmbeddedServletContainer(org.apache.catalina.startup.Tomcat tomcat,
                                      boolean autoStart)
```
    Create a new TomcatEmbeddedServletContainer instance.
    
    Parameters:
    
    tomcat - the underlying Tomcat server
    
    autoStart - if the server should be started
- Method Detail
  - start
```
public void start()
           throws EmbeddedServletContainerException
```
    Description copied from interface: EmbeddedServletContainer
    
    Starts the embedded servlet container. Calling this method on an already started container has no effect.
    
    Specified by:
    
    start in interface EmbeddedServletContainer
    
    Throws:
    
    EmbeddedServletContainerException - if the container cannot be started
  - stop
```
public void stop()
          throws EmbeddedServletContainerException
```
    Description copied from interface: EmbeddedServletContainer
    
    Stops the embedded servlet container. Calling this method on an already stopped container has no effect.
    
    Specified by:
    
    stop in interface EmbeddedServletContainer
    
    Throws:
    
    EmbeddedServletContainerException - if the container cannot be stopped
  - getPort
```
public int getPort()
```
    Description copied from interface: EmbeddedServletContainer
    
    Return the port this server is listening on.
    
    Specified by:
    
    getPort in interface EmbeddedServletContainer
    
    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 TomcatEmbeddedServletContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TomcatEmbeddedServletContainer

TomcatEmbeddedServletContainer

Method Detail

start

stop

getPort

getTomcat