JettyReactiveWebServerFactory (Spring Boot Docs 2.0.5.RELEASE API)

java.lang.Object
- org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
- - org.springframework.boot.web.reactive.server.AbstractReactiveWebServerFactory
  - - org.springframework.boot.web.embedded.jetty.JettyReactiveWebServerFactory

All Implemented Interfaces:

ConfigurableJettyWebServerFactory, ConfigurableReactiveWebServerFactory, ReactiveWebServerFactory, ConfigurableWebServerFactory, ErrorPageRegistry, WebServerFactory
```
public class JettyReactiveWebServerFactory
extends AbstractReactiveWebServerFactory
implements ConfigurableJettyWebServerFactory
```
ReactiveWebServerFactory that can be used to create JettyWebServers.

Since:

2.0.0

Author:

Brian Clozel

Constructor Summary

Constructors
Constructor and Description
`JettyReactiveWebServerFactory()` Create a new `JettyServletWebServerFactory` instance.
`JettyReactiveWebServerFactory(int port)` Create a new `JettyServletWebServerFactory` that listens for requests using the specified port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addServerCustomizers(JettyServerCustomizer... customizers)` Add `JettyServerCustomizer`s that will be applied to the `Server` before it is started.
`protected Server`	`createJettyServer(JettyHttpHandlerAdapter servlet)`
`Collection<JettyServerCustomizer>`	`getServerCustomizers()` Returns a mutable collection of Jetty `JettyServerCustomizer`s that will be applied to the `Server` before it is created.
`ThreadPool`	`getThreadPool()` Returns a Jetty `ThreadPool` that should be used by the `Server`.
`WebServer`	`getWebServer(HttpHandler httpHandler)` Gets a new fully configured but paused `WebServer` instance.
`void`	`setAcceptors(int acceptors)` Set the number of acceptor threads to use.
`void`	`setSelectors(int selectors)` Set the number of selector threads to use.
`void`	`setServerCustomizers(Collection<? extends JettyServerCustomizer> customizers)` Sets `JettyServerCustomizer`s that will be applied to the `Server` before it is started.
`void`	`setThreadPool(ThreadPool threadPool)` Set a Jetty `ThreadPool` that should be used by the `Server`.
`void`	`setUseForwardHeaders(boolean useForwardHeaders)` Set if x-forward-* headers should be processed.

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory
addErrorPages, createTempDir, getAddress, getCompression, getErrorPages, getHttp2, getPort, getServerHeader, getSsl, getSslStoreProvider, setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslStoreProvider

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory
setAddress, setCompression, setErrorPages, setHttp2, setPort, setServerHeader, setSsl, setSslStoreProvider

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry
addErrorPages

- Constructor Detail
  - JettyReactiveWebServerFactory
```
public JettyReactiveWebServerFactory()
```
    Create a new JettyServletWebServerFactory instance.
  - JettyReactiveWebServerFactory
```
public JettyReactiveWebServerFactory(int port)
```
    Create a new JettyServletWebServerFactory that listens for requests using the specified port.
    
    Parameters:
    
    port - the port to listen on
- Method Detail
  - setUseForwardHeaders
```
public void setUseForwardHeaders(boolean useForwardHeaders)
```
    Description copied from interface: ConfigurableJettyWebServerFactory
    
    Set if x-forward-* headers should be processed.
    
    Specified by:
    
    setUseForwardHeaders in interface ConfigurableJettyWebServerFactory
    
    Parameters:
    
    useForwardHeaders - if x-forward headers should be used
  - setAcceptors
```
public void setAcceptors(int acceptors)
```
    Description copied from interface: ConfigurableJettyWebServerFactory
    
    Set the number of acceptor threads to use.
    
    Specified by:
    
    setAcceptors in interface ConfigurableJettyWebServerFactory
    
    Parameters:
    
    acceptors - the number of acceptor threads to use
  - getWebServer
```
public WebServer getWebServer(HttpHandler httpHandler)
```
    Description copied from interface: ReactiveWebServerFactory
    
    Gets a new fully configured but paused WebServer instance. Clients should not be able to connect to the returned server until WebServer.start() is called (which happens when the ApplicationContext has been fully refreshed).
    
    Specified by:
    
    getWebServer in interface ReactiveWebServerFactory
    
    Parameters:
    
    httpHandler - the HTTP handler in charge of processing requests
    
    Returns:
    
    a fully configured and started WebServer
    
    See Also:
    
    WebServer.stop()
  - addServerCustomizers
```
public void addServerCustomizers(JettyServerCustomizer... customizers)
```
    Description copied from interface: ConfigurableJettyWebServerFactory
    
    Add JettyServerCustomizers that will be applied to the Server before it is started.
    
    Specified by:
    
    addServerCustomizers in interface ConfigurableJettyWebServerFactory
    
    Parameters:
    
    customizers - the customizers to add
  - setServerCustomizers
```
public void setServerCustomizers(Collection<? extends JettyServerCustomizer> customizers)
```
    Sets JettyServerCustomizers that will be applied to the Server before it is started. Calling this method will replace any existing customizers.
    
    Parameters:
    
    customizers - the Jetty customizers to apply
  - getServerCustomizers
```
public Collection<JettyServerCustomizer> getServerCustomizers()
```
    Returns a mutable collection of Jetty JettyServerCustomizers that will be applied to the Server before it is created.
    
    Returns:
    
    the Jetty customizers
  - setSelectors
```
public void setSelectors(int selectors)
```
    Description copied from interface: ConfigurableJettyWebServerFactory
    
    Set the number of selector threads to use.
    
    Specified by:
    
    setSelectors in interface ConfigurableJettyWebServerFactory
    
    Parameters:
    
    selectors - the number of selector threads to use
  - createJettyServer
```
protected Server createJettyServer(JettyHttpHandlerAdapter servlet)
```
  - getThreadPool
```
public ThreadPool getThreadPool()
```
    Returns a Jetty ThreadPool that should be used by the Server.
    
    Returns:
    
    a Jetty ThreadPool or null
  - setThreadPool
```
public void setThreadPool(ThreadPool threadPool)
```
    Set a Jetty ThreadPool that should be used by the Server. If set to null (default), the Server creates a ThreadPool implicitly.
    
    Parameters:
    
    threadPool - a Jetty ThreadPool to be used

Class JettyReactiveWebServerFactory

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.web.server.AbstractConfigurableWebServerFactory

Methods inherited from class java.lang.Object

Methods inherited from interface org.springframework.boot.web.server.ConfigurableWebServerFactory

Methods inherited from interface org.springframework.boot.web.server.ErrorPageRegistry

Constructor Detail

JettyReactiveWebServerFactory

JettyReactiveWebServerFactory

Method Detail

setUseForwardHeaders

setAcceptors

getWebServer

addServerCustomizers

setServerCustomizers

getServerCustomizers

setSelectors

createJettyServer

getThreadPool

setThreadPool