org.springframework.boot.context.embedded

Interface EmbeddedServletContainer

All Known Implementing Classes:

JettyEmbeddedServletContainer, TomcatEmbeddedServletContainer, UndertowEmbeddedServletContainer

public interface EmbeddedServletContainer

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

Instances of this class are usually obtained via a EmbeddedServletContainerFactory.

Author:

Phillip Webb, Dave Syer

See Also:

EmbeddedServletContainerFactory

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port this server is listening on.
void	start() Starts the embedded servlet container.
void	stop() Stops the embedded servlet container.

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 - if the container cannot be started

stop

void stop()
   throws EmbeddedServletContainerException

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

Throws:

EmbeddedServletContainerException - if the container cannot be stopped

getPort

int getPort()

Return the port this server is listening on.

Returns:

the port (or -1 if none)