org.springframework.boot.web.embedded.jetty

Class JettyWebServer

java.lang.Object

org.springframework.boot.web.embedded.jetty.JettyWebServer

All Implemented Interfaces:

WebServer

public class JettyWebServer
extends Object
implements WebServer

WebServer that can be used to control a Jetty web server.

Since:

2.0.0

Author:

Phillip Webb, Dave Syer, David Liu, Eddú Meléndez, Brian Clozel, Kristine Jetzke

See Also:

JettyReactiveWebServerFactory

Constructor Summary

Constructors

Constructor and Description
JettyWebServer(org.eclipse.jetty.server.Server server) Create a new JettyWebServer instance.
JettyWebServer(org.eclipse.jetty.server.Server server, boolean autoStart) Create a new JettyWebServer instance.
JettyWebServer(org.eclipse.jetty.server.Server server, boolean autoStart, Duration shutdownGracePeriod) Create a new JettyWebServer instance.

Method Summary

Modifier and Type	Method and Description
int	getPort() Return the port this server is listening on.
org.eclipse.jetty.server.Server	getServer() Returns access to the underlying Jetty Server.
boolean	shutDownGracefully() Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.
void	start() Starts the web server.
void	stop() Stops the web server.

Methods inherited from class java.lang.Object

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

Constructor Detail

JettyWebServer

public JettyWebServer(org.eclipse.jetty.server.Server server)

Create a new JettyWebServer instance.

Parameters:

server - the underlying Jetty server

JettyWebServer

public JettyWebServer(org.eclipse.jetty.server.Server server,
                      boolean autoStart)

Create a new JettyWebServer instance.

Parameters:

server - the underlying Jetty server

autoStart - if auto-starting the server

JettyWebServer

public JettyWebServer(org.eclipse.jetty.server.Server server,
                      boolean autoStart,
                      Duration shutdownGracePeriod)

Create a new JettyWebServer instance.

Parameters:

server - the underlying Jetty server

autoStart - if auto-starting the server

shutdownGracePeriod - grace period to use when shutting down

Since:

2.3.0

Method Detail

start

public void start()
           throws WebServerException

Description copied from interface: WebServer

Starts the web server. Calling this method on an already started server has no effect.

Specified by:

start in interface WebServer

Throws:

WebServerException - if the server cannot be started

stop

public void stop()

Description copied from interface: WebServer

Stops the web server. Calling this method on an already stopped server has no effect.

Specified by:

stop in interface WebServer

getPort

public int getPort()

Description copied from interface: WebServer

Return the port this server is listening on.

Specified by:

getPort in interface WebServer

Returns:

the port (or -1 if none)

shutDownGracefully

public boolean shutDownGracefully()

Description copied from interface: WebServer

Gracefully shuts down the web server by preventing the handling of new requests and waiting for a configurable period for there to be no active requests.

Specified by:

shutDownGracefully in interface WebServer

Returns:

true if graceful shutdown completed within the period, otherwise false

getServer

public org.eclipse.jetty.server.Server getServer()

Returns access to the underlying Jetty Server.

Returns:

the Jetty server