org.springframework.boot.context.embedded

Interface EmbeddedServletContainer

All Known Implementing Classes:

JettyEmbeddedServletContainer, TomcatEmbeddedServletContainer

public interface EmbeddedServletContainer

Simple interface that represents a fully configured embedded servlet container (for example Tomcat or Jetty). Allows the container to be stopped.

Instances of this class are usually obtained via a EmbeddedServletContainerFactory.

Author:

Phillip Webb, Dave Syer

See Also:

EmbeddedServletContainerFactory

Field Summary

Fields

Modifier and Type	Field and Description
static EmbeddedServletContainer	NONE An empty EmbeddedServletContainer that does nothing.

Method Summary

Methods

Modifier and Type	Method and Description
int	getPort()
void	start() Starts the embedded servlet container.
void	stop() Stops the embedded servlet container.

Field Detail

NONE

static final EmbeddedServletContainer NONE

An empty EmbeddedServletContainer that does nothing.

Method Detail

start

void start()
           throws EmbeddedServletContainerException

Starts the embedded servlet container. Calling this method on an already started container has no effect.

Throws:

EmbeddedServletContainerException - of the container cannot be stopped

stop

void stop()
          throws EmbeddedServletContainerException

Stops the embedded servlet container. Calling this method on an already stopped container has no effect.

Throws:

EmbeddedServletContainerException - of the container cannot be stopped

getPort

int getPort()

Returns:

the port this server is listening on (or -1 if none)