java.lang.Object
- org.apache.cxf.transport.http_undertow.UndertowHTTPServerEngine

All Implemented Interfaces:

ServerEngine, HttpServerEngineSupport

Direct Known Subclasses:

UndertowHTTPServerEngineBeanDefinitionParser.SpringUndertowHTTPServerEngine
```
public class UndertowHTTPServerEngine
extends Object
implements ServerEngine, HttpServerEngineSupport
```

Field Summary

Fields
Modifier and Type Field Description

static String DO_NOT_CHECK_URL_PROP

static String ENABLE_HTTP2_PROP
Deprecated.

static String ENABLE_RECORD_REQUEST_START_TIME_PROP
- Fields inherited from interface org.apache.cxf.transport.http.HttpServerEngineSupport
  ENABLE_HTTP2

Constructor Summary

Constructors
Constructor Description

UndertowHTTPServerEngine()

UndertowHTTPServerEngine(String host, int port)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addServant(URL url, UndertowHTTPHandler handler)`
`protected void`	`checkRegistedContext(URL url)`
`protected SSLContext`	`createSSLContext()`
`io.undertow.Undertow.Builder`	`decorateUndertowSocketConnection(io.undertow.Undertow.Builder builder)`
`void`	`finalizeConfig()`
`boolean`	`getContinuationsEnabled()`
`List<CXFUndertowHttpHandler>`	`getHandlers()`
`String`	`getHost()`	Returns the host for which this server engine was configured.
`protected KeyManager[]`	`getKeyManagersWithCertAlias(KeyManager[] keyManagers)`
`int`	`getMaxIdleTime()`
`int`	`getPort()`	Returns the port number for which this server engine was configured.
`String`	`getProtocol()`	Returns the protocol "http" or "https" for which this engine was configured.
`UndertowHTTPHandler`	`getServant(URL url)`	Get a previously registered servant.
`ThreadingParameters`	`getThreadingParameters()`	This method returns the threading parameters that have been set.
`TLSServerParameters`	`getTlsServerParameters()`	This method returns the programmatically set TLSServerParameters, not the TLSServerParametersType, which is the JAXB generated type used in SpringConfiguration.
`boolean`	`isHttp2Enabled(Bus bus)`	Check if Http2 is enabled on the Bus or system property Default if not configured otherwise is true
`boolean`	`isSetThreadingParameters()`	This method returns whether the threading parameters are set.
`void`	`removeServant(URL url)`	Remove a previously registered servant.
`void`	`setContinuationsEnabled(boolean enabled)`
`void`	`setHandlers(List<CXFUndertowHttpHandler> h)`	set the Undertow server's handlers
`void`	`setHost(String host)`
`void`	`setMaxIdleTime(int maxIdleTime)`
`void`	`setPort(int p)`
`void`	`setThreadingParameters(ThreadingParameters params)`	This method sets the threading parameters for this particular server engine.
`void`	`setTlsServerParameters(TLSServerParameters params)`	This method is used to programmatically set the TLSServerParameters.
`void`	`shutdown()`	This method will shut down the server engine and remove it from the factory's cache.
`void`	`stop()`

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

Methods inherited from interface org.apache.cxf.transport.http.HttpServerEngineSupport
isHttp2Required

- Field Detail
  - DO_NOT_CHECK_URL_PROP
```
public static final String DO_NOT_CHECK_URL_PROP
```
    See Also:
    
    Constant Field Values
  - ENABLE_HTTP2_PROP
```
@Deprecated
public static final String ENABLE_HTTP2_PROP
```
    Deprecated.
    
    Please use HttpServerEngineSupport.ENABLE_HTTP2 instead.
    
    See Also:
    
    Constant Field Values
  - ENABLE_RECORD_REQUEST_START_TIME_PROP
```
public static final String ENABLE_RECORD_REQUEST_START_TIME_PROP
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UndertowHTTPServerEngine
```
public UndertowHTTPServerEngine(String host,
                                int port)
```
  - UndertowHTTPServerEngine
```
public UndertowHTTPServerEngine()
```
- Method Detail
  - addServant
```
public void addServant(URL url,
                       UndertowHTTPHandler handler)
```
    Specified by:
    
    addServant in interface ServerEngine
  - isHttp2Enabled
```
public boolean isHttp2Enabled(Bus bus)
```
    Description copied from interface: HttpServerEngineSupport
    
    Check if Http2 is enabled on the Bus or system property Default if not configured otherwise is true
    
    Specified by:
    
    isHttp2Enabled in interface HttpServerEngineSupport
    
    Returns:
  - decorateUndertowSocketConnection
```
public io.undertow.Undertow.Builder decorateUndertowSocketConnection(io.undertow.Undertow.Builder builder)
```
  - checkRegistedContext
```
protected void checkRegistedContext(URL url)
```
  - removeServant
```
public void removeServant(URL url)
```
    Description copied from interface: ServerEngine
    
    Remove a previously registered servant.
    
    Specified by:
    
    removeServant in interface ServerEngine
    
    Parameters:
    
    url - the URL the servant was registered against.
  - getServant
```
public UndertowHTTPHandler getServant(URL url)
```
    Description copied from interface: ServerEngine
    
    Get a previously registered servant.
    
    Specified by:
    
    getServant in interface ServerEngine
    
    Parameters:
    
    url - the associated URL
    
    Returns:
    
    the HttpHandler if registered
  - getProtocol
```
public String getProtocol()
```
    Returns the protocol "http" or "https" for which this engine was configured.
  - getPort
```
public int getPort()
```
    Returns the port number for which this server engine was configured.
    
    Returns:
  - getHost
```
public String getHost()
```
    Returns the host for which this server engine was configured.
    
    Returns:
  - setPort
```
public void setPort(int p)
```
  - setHost
```
public void setHost(String host)
```
  - finalizeConfig
```
public void finalizeConfig()
```
  - setTlsServerParameters
```
public void setTlsServerParameters(TLSServerParameters params)
```
    This method is used to programmatically set the TLSServerParameters. This method may only be called by the factory.
    
    Throws:
    
    IOException
  - getTlsServerParameters
```
public TLSServerParameters getTlsServerParameters()
```
    This method returns the programmatically set TLSServerParameters, not the TLSServerParametersType, which is the JAXB generated type used in SpringConfiguration.
    
    Returns:
  - stop
```
public void stop()
```
  - shutdown
```
public void shutdown()
```
    This method will shut down the server engine and remove it from the factory's cache.
  - createSSLContext
```
protected SSLContext createSSLContext()
                               throws Exception
```
    Throws:
    
    Exception
  - getKeyManagersWithCertAlias
```
protected KeyManager[] getKeyManagersWithCertAlias(KeyManager[] keyManagers)
                                            throws Exception
```
    Throws:
    
    Exception
  - setThreadingParameters
```
public void setThreadingParameters(ThreadingParameters params)
```
    This method sets the threading parameters for this particular server engine. This method may only be called by the factory.
  - isSetThreadingParameters
```
public boolean isSetThreadingParameters()
```
    This method returns whether the threading parameters are set.
  - getThreadingParameters
```
public ThreadingParameters getThreadingParameters()
```
    This method returns the threading parameters that have been set. This method may return null, if the threading parameters have not been set.
  - setContinuationsEnabled
```
public void setContinuationsEnabled(boolean enabled)
```
  - getContinuationsEnabled
```
public boolean getContinuationsEnabled()
```
  - getMaxIdleTime
```
public int getMaxIdleTime()
```
  - setMaxIdleTime
```
public void setMaxIdleTime(int maxIdleTime)
```
  - setHandlers
```
public void setHandlers(List<CXFUndertowHttpHandler> h)
```
    set the Undertow server's handlers
    
    Parameters:
    
    h -
  - getHandlers
```
public List<CXFUndertowHttpHandler> getHandlers()
```

Modifier and Type	Field	Description
`static String`	`DO_NOT_CHECK_URL_PROP`
`static String`	`ENABLE_HTTP2_PROP`	Deprecated.
`static String`	`ENABLE_RECORD_REQUEST_START_TIME_PROP`

Constructor	Description
`UndertowHTTPServerEngine()`
`UndertowHTTPServerEngine(String host, int port)`

Class UndertowHTTPServerEngine

Field Summary

Fields inherited from interface org.apache.cxf.transport.http.HttpServerEngineSupport

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.cxf.transport.http.HttpServerEngineSupport

Field Detail

DO_NOT_CHECK_URL_PROP

ENABLE_HTTP2_PROP

ENABLE_RECORD_REQUEST_START_TIME_PROP

Constructor Detail

UndertowHTTPServerEngine

UndertowHTTPServerEngine

Method Detail

addServant

isHttp2Enabled

decorateUndertowSocketConnection

checkRegistedContext

removeServant

getServant

getProtocol

getPort

getHost

setPort

setHost

finalizeConfig

setTlsServerParameters

getTlsServerParameters

stop

shutdown

createSSLContext

getKeyManagersWithCertAlias

setThreadingParameters

isSetThreadingParameters

getThreadingParameters

setContinuationsEnabled

getContinuationsEnabled

getMaxIdleTime

setMaxIdleTime

setHandlers

getHandlers