org.springframework.boot.context.embedded.undertow

Class UndertowEmbeddedServletContainer

java.lang.Object

org.springframework.boot.context.embedded.undertow.UndertowEmbeddedServletContainer

All Implemented Interfaces:

EmbeddedServletContainer

public class UndertowEmbeddedServletContainer
extends Object
implements EmbeddedServletContainer

EmbeddedServletContainer that can be used to control an embedded Undertow server. Typically this class should be created using UndertowEmbeddedServletContainerFactory and not directly.

Since:

1.2.0

Author:

Ivan Sopov, Andy Wilkinson, Eddú Meléndez

See Also:

UndertowEmbeddedServletContainerFactory

Constructor Summary

Constructors

Constructor and Description
UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, int port, boolean useForwardHeaders, boolean autoStart, Compression compression)
UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, int port, boolean useForwardHeaders, boolean autoStart, Compression compression, String serverHeader)
UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, String contextPath, int port, boolean autoStart, Compression compression)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UndertowEmbeddedServletContainer

public UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder,
                                        io.undertow.servlet.api.DeploymentManager manager,
                                        String contextPath,
                                        int port,
                                        boolean autoStart,
                                        Compression compression)

UndertowEmbeddedServletContainer

public UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder,
                                        io.undertow.servlet.api.DeploymentManager manager,
                                        String contextPath,
                                        int port,
                                        boolean useForwardHeaders,
                                        boolean autoStart,
                                        Compression compression)

UndertowEmbeddedServletContainer

public UndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder,
                                        io.undertow.servlet.api.DeploymentManager manager,
                                        String contextPath,
                                        int port,
                                        boolean useForwardHeaders,
                                        boolean autoStart,
                                        Compression compression,
                                        String serverHeader)

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)