org.springframework.boot.context.embedded.tomcat

Class TomcatEmbeddedServletContainer

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(Tomcat tomcat) Create a new TomcatEmbeddedServletContainer instance.
TomcatEmbeddedServletContainer(Tomcat tomcat, boolean autoStart) Create a new TomcatEmbeddedServletContainer 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.
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(Tomcat tomcat)

Create a new TomcatEmbeddedServletContainer instance.

Parameters:

tomcat - the underlying Tomcat server

TomcatEmbeddedServletContainer

public TomcatEmbeddedServletContainer(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 Tomcat getTomcat()

Returns access to the underlying Tomcat server.

Returns:

the Tomcat server