UndertowEmbeddedServletContainerFactory (spring-boot 1.3.0.RELEASE)

java.lang.Object
- org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer
- - org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory
  - - org.springframework.boot.context.embedded.undertow.UndertowEmbeddedServletContainerFactory

All Implemented Interfaces:

org.springframework.beans.factory.Aware, ConfigurableEmbeddedServletContainer, EmbeddedServletContainerFactory, org.springframework.context.ResourceLoaderAware
```
public class UndertowEmbeddedServletContainerFactory
extends AbstractEmbeddedServletContainerFactory
implements org.springframework.context.ResourceLoaderAware
```
EmbeddedServletContainerFactory that can be used to create UndertowEmbeddedServletContainers.
Unless explicitly configured otherwise, the factory will create containers that listen for HTTP requests on port 8080.

Since:

1.2.0

Author:

Ivan Sopov, Andy Wilkinson, Marcos Barbero

See Also:

UndertowEmbeddedServletContainer

Field Summary
- Fields inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory
  logger

Constructor Summary

Constructors
Constructor and Description
`UndertowEmbeddedServletContainerFactory()` Create a new `UndertowEmbeddedServletContainerFactory` instance.
`UndertowEmbeddedServletContainerFactory(int port)` Create a new `UndertowEmbeddedServletContainerFactory` that listens for requests using the specified port.
`UndertowEmbeddedServletContainerFactory(String contextPath, int port)` Create a new `UndertowEmbeddedServletContainerFactory` with the specified context path and port.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBuilderCustomizers(UndertowBuilderCustomizer... customizers)` Add `UndertowBuilderCustomizer`s that should be used to customize the Undertow `Undertow.Builder`.
`void`	`addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)` Add `UndertowDeploymentInfoCustomizer`s that should be used to customize the Undertow `DeploymentInfo`.
`Collection<UndertowBuilderCustomizer>`	`getBuilderCustomizers()` Returns a mutable collection of the `UndertowBuilderCustomizer`s that will be applied to the Undertow `Undertow.Builder` .
`Collection<UndertowDeploymentInfoCustomizer>`	`getDeploymentInfoCustomizers()` Returns a mutable collection of the `UndertowDeploymentInfoCustomizer`s that will be applied to the Undertow `DeploymentInfo` .
`EmbeddedServletContainer`	`getEmbeddedServletContainer(ServletContextInitializer... initializers)` Gets a new fully configured but paused `EmbeddedServletContainer` instance.
`protected UndertowEmbeddedServletContainer`	`getUndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder, io.undertow.servlet.api.DeploymentManager manager, int port)` Factory method called to create the `UndertowEmbeddedServletContainer`.
`boolean`	`isAccessLogEnabled()`
`void`	`setAccessLogDirectory(File accessLogDirectory)`
`void`	`setAccessLogEnabled(boolean accessLogEnabled)`
`void`	`setAccessLogPattern(String accessLogPattern)`
`void`	`setBufferSize(Integer bufferSize)`
`void`	`setBuffersPerRegion(Integer buffersPerRegion)`
`void`	`setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)` Set `UndertowBuilderCustomizer`s that should be applied to the Undertow `Undertow.Builder`.
`void`	`setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers)` Set `UndertowDeploymentInfoCustomizer`s that should be applied to the Undertow `DeploymentInfo`.
`void`	`setDirectBuffers(Boolean directBuffers)`
`void`	`setIoThreads(Integer ioThreads)`
`void`	`setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)`
`void`	`setUseForwardHeaders(boolean useForwardHeaders)` Set if x-forward-* headers should be processed.
`void`	`setWorkerThreads(Integer workerThreads)`

Methods inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory
createTempDir, getValidDocumentRoot, getValidSessionStoreDir, getValidSessionStoreDir

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

- Constructor Detail
  - UndertowEmbeddedServletContainerFactory
```
public UndertowEmbeddedServletContainerFactory()
```
    Create a new UndertowEmbeddedServletContainerFactory instance.
  - UndertowEmbeddedServletContainerFactory
```
public UndertowEmbeddedServletContainerFactory(int port)
```
    Create a new UndertowEmbeddedServletContainerFactory that listens for requests using the specified port.
    
    Parameters:
    
    port - the port to listen on
  - UndertowEmbeddedServletContainerFactory
```
public UndertowEmbeddedServletContainerFactory(String contextPath,
                                               int port)
```
    Create a new UndertowEmbeddedServletContainerFactory with the specified context path and port.
    
    Parameters:
    
    contextPath - root the context path
    
    port - the port to listen on
- Method Detail
  - setBuilderCustomizers
```
public void setBuilderCustomizers(Collection<? extends UndertowBuilderCustomizer> customizers)
```
    Set UndertowBuilderCustomizers that should be applied to the Undertow Undertow.Builder. Calling this method will replace any existing customizers.
    
    Parameters:
    
    customizers - the customizers to set
  - getBuilderCustomizers
```
public Collection<UndertowBuilderCustomizer> getBuilderCustomizers()
```
    Returns a mutable collection of the UndertowBuilderCustomizers that will be applied to the Undertow Undertow.Builder .
    
    Returns:
    
    the customizers that will be applied
  - addBuilderCustomizers
```
public void addBuilderCustomizers(UndertowBuilderCustomizer... customizers)
```
    Add UndertowBuilderCustomizers that should be used to customize the Undertow Undertow.Builder.
    
    Parameters:
    
    customizers - the customizers to add
  - setDeploymentInfoCustomizers
```
public void setDeploymentInfoCustomizers(Collection<? extends UndertowDeploymentInfoCustomizer> customizers)
```
    Set UndertowDeploymentInfoCustomizers that should be applied to the Undertow DeploymentInfo. Calling this method will replace any existing customizers.
    
    Parameters:
    
    customizers - the customizers to set
  - getDeploymentInfoCustomizers
```
public Collection<UndertowDeploymentInfoCustomizer> getDeploymentInfoCustomizers()
```
    Returns a mutable collection of the UndertowDeploymentInfoCustomizers that will be applied to the Undertow DeploymentInfo .
    
    Returns:
    
    the customizers that will be applied
  - addDeploymentInfoCustomizers
```
public void addDeploymentInfoCustomizers(UndertowDeploymentInfoCustomizer... customizers)
```
    Add UndertowDeploymentInfoCustomizers that should be used to customize the Undertow DeploymentInfo.
    
    Parameters:
    
    customizers - the customizers to add
  - getEmbeddedServletContainer
```
public EmbeddedServletContainer getEmbeddedServletContainer(ServletContextInitializer... initializers)
```
    Description copied from interface: EmbeddedServletContainerFactory
    
    Gets a new fully configured but paused EmbeddedServletContainer instance. Clients should not be able to connect to the returned server until EmbeddedServletContainer.start() is called (which happens when the ApplicationContext has been fully refreshed).
    
    Specified by:
    
    getEmbeddedServletContainer in interface EmbeddedServletContainerFactory
    
    Parameters:
    
    initializers - ServletContextInitializers that should be applied as the container starts
    
    Returns:
    
    a fully configured and started EmbeddedServletContainer
    
    See Also:
    
    EmbeddedServletContainer.stop()
  - getUndertowEmbeddedServletContainer
```
protected UndertowEmbeddedServletContainer getUndertowEmbeddedServletContainer(io.undertow.Undertow.Builder builder,
                                                                               io.undertow.servlet.api.DeploymentManager manager,
                                                                               int port)
```
    Factory method called to create the UndertowEmbeddedServletContainer. Subclasses can override this method to return a different UndertowEmbeddedServletContainer or apply additional processing to the Undertow.Builder and DeploymentManager used to bootstrap Undertow
    
    Parameters:
    
    builder - the builder
    
    manager - the deployment manager
    
    port - the port that Undertow should listen on
    
    Returns:
    
    a new UndertowEmbeddedServletContainer instance
  - setResourceLoader
```
public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
```
    Specified by:
    
    setResourceLoader in interface org.springframework.context.ResourceLoaderAware
  - setBufferSize
```
public void setBufferSize(Integer bufferSize)
```
  - setBuffersPerRegion
```
public void setBuffersPerRegion(Integer buffersPerRegion)
```
  - setIoThreads
```
public void setIoThreads(Integer ioThreads)
```
  - setWorkerThreads
```
public void setWorkerThreads(Integer workerThreads)
```
  - setDirectBuffers
```
public void setDirectBuffers(Boolean directBuffers)
```
  - setAccessLogDirectory
```
public void setAccessLogDirectory(File accessLogDirectory)
```
  - setAccessLogPattern
```
public void setAccessLogPattern(String accessLogPattern)
```
  - setAccessLogEnabled
```
public void setAccessLogEnabled(boolean accessLogEnabled)
```
  - isAccessLogEnabled
```
public boolean isAccessLogEnabled()
```
  - setUseForwardHeaders
```
public void setUseForwardHeaders(boolean useForwardHeaders)
```
    Set if x-forward-* headers should be processed.
    
    Parameters:
    
    useForwardHeaders - if x-forward headers should be used
    
    Since:
    
    1.3.0

Class UndertowEmbeddedServletContainerFactory

Field Summary

Fields inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

Constructor Summary

Method Summary

Methods inherited from class org.springframework.boot.context.embedded.AbstractEmbeddedServletContainerFactory

Methods inherited from class org.springframework.boot.context.embedded.AbstractConfigurableEmbeddedServletContainer

Methods inherited from class java.lang.Object

Constructor Detail

UndertowEmbeddedServletContainerFactory

UndertowEmbeddedServletContainerFactory

UndertowEmbeddedServletContainerFactory

Method Detail

setBuilderCustomizers

getBuilderCustomizers

addBuilderCustomizers

setDeploymentInfoCustomizers

getDeploymentInfoCustomizers

addDeploymentInfoCustomizers

getEmbeddedServletContainer

getUndertowEmbeddedServletContainer

setResourceLoader

setBufferSize

setBuffersPerRegion

setIoThreads

setWorkerThreads

setDirectBuffers

setAccessLogDirectory

setAccessLogPattern

setAccessLogEnabled

isAccessLogEnabled

setUseForwardHeaders