NettyHttpServerEngine (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.transport.http.netty.server.NettyHttpServerEngine

All Implemented Interfaces:

ServerEngine

Direct Known Subclasses:

NettyHttpServerEngineBeanDefinitionParser.SpringNettyHttpServerEngine
```
public class NettyHttpServerEngine
extends Object
implements ServerEngine
```

Constructor Summary

Constructors
Constructor and Description

NettyHttpServerEngine()

NettyHttpServerEngine(String host, int port)

Constructors
Constructor and Description
`NettyHttpServerEngine()`
`NettyHttpServerEngine(String host, int port)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addServant(URL url, NettyHttpHandler handler)`
`protected void`	`checkRegistedContext(URL url)`
`void`	`finalizeConfig()`
`String`	`getHost()`
`int`	`getMaxChunkContentSize()`
`int`	`getPort()`
`String`	`getProtocol()`
`int`	`getReadIdleTime()`
`NettyHttpHandler`	`getServant(URL url)` Get a previously registered servant.
`ThreadingParameters`	`getThreadingParameters()`
`TLSServerParameters`	`getTlsServerParameters()` This method returns the programmatically set TLSServerParameters, not the TLSServerParametersType, which is the JAXB generated type used in SpringConfiguration.
`int`	`getWriteIdleTime()`
`boolean`	`isSessionSupport()`
`void`	`removeServant(URL url)` Remove a previously registered servant.
`void`	`setHost(String host)`
`void`	`setMaxChunkContentSize(int maxChunkContentSize)`
`void`	`setPort(int port)`
`void`	`setProtocol(String protocol)`
`void`	`setReadIdleTime(int readIdleTime)`
`void`	`setSessionSupport(boolean session)`
`void`	`setThreadingParameters(ThreadingParameters params)`
`void`	`setTlsServerParameters(TLSServerParameters params)` This method is used to programmatically set the TLSServerParameters.
`void`	`setWriteIdleTime(int writeIdleTime)`
`void`	`shutdown()`
`protected io.netty.channel.Channel`	`startServer()`

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

Constructor Detail

NettyHttpServerEngine
```
public NettyHttpServerEngine()
```

NettyHttpServerEngine

public NettyHttpServerEngine(String host,
                     int port)

Method Detail

getProtocol
```
public String getProtocol()
```

setProtocol

public void setProtocol(String protocol)

finalizeConfig

@PostConstruct
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.

getTlsServerParameters
```
public TLSServerParameters getTlsServerParameters()
```
This method returns the programmatically set TLSServerParameters, not the TLSServerParametersType, which is the JAXB generated type used in SpringConfiguration.

Returns:

setThreadingParameters

public void setThreadingParameters(ThreadingParameters params)

getThreadingParameters

public ThreadingParameters getThreadingParameters()

startServer

protected io.netty.channel.Channel startServer()

checkRegistedContext

protected void checkRegistedContext(URL url)

addServant

public void addServant(URL url,
              NettyHttpHandler handler)

Specified by:: addServant in interface ServerEngine

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 NettyHttpHandler 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

shutdown
```
public void shutdown()
```

getReadIdleTime
```
public int getReadIdleTime()
```

setReadIdleTime

public void setReadIdleTime(int readIdleTime)

getWriteIdleTime
```
public int getWriteIdleTime()
```

setWriteIdleTime

public void setWriteIdleTime(int writeIdleTime)

isSessionSupport
```
public boolean isSessionSupport()
```

setSessionSupport

public void setSessionSupport(boolean session)

getMaxChunkContentSize
```
public int getMaxChunkContentSize()
```

setMaxChunkContentSize

public void setMaxChunkContentSize(int maxChunkContentSize)

getPort
```
public int getPort()
```

setPort
```
public void setPort(int port)
```

setHost
```
public void setHost(String host)
```

getHost
```
public String getHost()
```

Class NettyHttpServerEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NettyHttpServerEngine

NettyHttpServerEngine

Method Detail

getProtocol

setProtocol

finalizeConfig

setTlsServerParameters

getTlsServerParameters

setThreadingParameters

getThreadingParameters

startServer

checkRegistedContext

addServant

removeServant

getServant

shutdown

getReadIdleTime

setReadIdleTime

getWriteIdleTime

setWriteIdleTime

isSessionSupport

setSessionSupport

getMaxChunkContentSize

setMaxChunkContentSize

getPort

setPort

setHost

getHost