Class JettyWebServer

java.lang.Object

org.springframework.boot.jetty.JettyWebServer

All Implemented Interfaces:

WebServer

Direct Known Subclasses:

JettyServletWebServer

public class JettyWebServer
extends Object
implements WebServer

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

Since:

4.0.0

Author:

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

See Also:

• JettyReactiveWebServerFactory

Constructor Summary

Constructors

Constructor	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.

Method Summary

Modifier and Type	Method	Description
void	destroy()	Destroys the web server such that it cannot be started again.
int	getPort()	Return the port this server is listening on.
org.eclipse.jetty.server.Server	getServer()	Returns access to the underlying Jetty Server.
protected void	handleDeferredInitialize(org.eclipse.jetty.server.Server server)	Performs any necessary handling of deferred initialization.
void	shutDownGracefully(GracefulShutdownCallback callback)	Initiates a graceful shutdown of the Jetty web server.
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 Details

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

Method Details

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

handleDeferredInitialize

protected void handleDeferredInitialize(org.eclipse.jetty.server.Server server)
                                 throws Exception

Performs any necessary handling of deferred initialization.

Parameters:

server - the server that has been started

Throws:

Exception - if a failure occurs during the deferred initialization

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

destroy

public void destroy()

Description copied from interface: WebServer

Destroys the web server such that it cannot be started again.

Specified by:

destroy 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 void shutDownGracefully(GracefulShutdownCallback callback)

Initiates a graceful shutdown of the Jetty web server. Handling of new requests is prevented and the given callback is invoked at the end of the attempt. The attempt can be explicitly ended by invoking stop().

Once shutdown has been initiated Jetty will reject any new connections. Requests on existing connections will be accepted, however, a Connection: close header will be returned in the response.

Specified by:

shutDownGracefully in interface WebServer

Parameters:

callback - the callback to invoke when the graceful shutdown completes

getServer

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

Returns access to the underlying Jetty Server.

Returns:

the Jetty server