NettyServerBootstrapConfiguration (Camel :: Netty (deprecated) 2.24.0 API)

java.lang.Object
- org.apache.camel.component.netty.NettyServerBootstrapConfiguration

All Implemented Interfaces:: Cloneable

Direct Known Subclasses:: NettyConfiguration

@UriParams
public class NettyServerBootstrapConfiguration
extends Object
implements Cloneable

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`backlog`
`protected int`	`bossCount`
`protected org.jboss.netty.channel.socket.nio.BossPool`	`bossPool`
`protected boolean`	`broadcast`
`protected org.jboss.netty.channel.group.ChannelGroup`	`channelGroup`
`protected long`	`connectTimeout`
`static String`	`DEFAULT_ENABLED_PROTOCOLS`
`protected String`	`enabledProtocols`
`protected String`	`host`
`protected boolean`	`keepAlive`
`protected File`	`keyStoreFile`
`protected String`	`keyStoreFormat`
`protected String`	`keyStoreResource`
`protected boolean`	`needClientAuth`
`protected NettyServerBootstrapFactory`	`nettyServerBootstrapFactory`
`protected String`	`networkInterface`
`protected Map<String,Object>`	`options`
`protected String`	`passphrase`
`protected int`	`port`
`protected String`	`protocol`
`protected long`	`receiveBufferSize`
`protected int`	`receiveBufferSizePredictor`
`protected boolean`	`reuseAddress`
`protected String`	`securityProvider`
`protected long`	`sendBufferSize`
`protected ServerPipelineFactory`	`serverPipelineFactory`
`protected boolean`	`ssl`
`protected boolean`	`sslClientCertHeaders`
`protected org.apache.camel.util.jsse.SSLContextParameters`	`sslContextParameters`
`protected org.jboss.netty.handler.ssl.SslHandler`	`sslHandler`
`protected boolean`	`tcpNoDelay`
`protected File`	`trustStoreFile`
`protected String`	`trustStoreResource`
`protected int`	`workerCount`
`protected org.jboss.netty.channel.socket.nio.WorkerPool`	`workerPool`

Constructor Summary

Constructors
Constructor and Description

NettyServerBootstrapConfiguration()

Constructors
Constructor and Description
`NettyServerBootstrapConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`compatible(NettyServerBootstrapConfiguration other)` Checks if the other `NettyServerBootstrapConfiguration` is compatible with this, as a Netty listener bound on port X shares the same common `NettyServerBootstrapConfiguration`, which must be identical.
`String`	`getAddress()`
`int`	`getBacklog()`
`int`	`getBossCount()`
`org.jboss.netty.channel.socket.nio.BossPool`	`getBossPool()`
`org.jboss.netty.channel.group.ChannelGroup`	`getChannelGroup()`
`long`	`getConnectTimeout()`
`String`	`getEnabledProtocols()`
`String`	`getHost()`
`File`	`getKeyStoreFile()` Deprecated.
`String`	`getKeyStoreFormat()`
`String`	`getKeyStoreResource()`
`NettyServerBootstrapFactory`	`getNettyServerBootstrapFactory()`
`String`	`getNetworkInterface()`
`Map<String,Object>`	`getOptions()`
`String`	`getPassphrase()`
`int`	`getPort()`
`String`	`getProtocol()`
`long`	`getReceiveBufferSize()`
`int`	`getReceiveBufferSizePredictor()`
`String`	`getSecurityProvider()`
`long`	`getSendBufferSize()`
`ServerPipelineFactory`	`getServerPipelineFactory()`
`org.apache.camel.util.jsse.SSLContextParameters`	`getSslContextParameters()`
`org.jboss.netty.handler.ssl.SslHandler`	`getSslHandler()`
`File`	`getTrustStoreFile()` Deprecated.
`String`	`getTrustStoreResource()`
`int`	`getWorkerCount()`
`org.jboss.netty.channel.socket.nio.WorkerPool`	`getWorkerPool()`
`boolean`	`isBroadcast()`
`boolean`	`isKeepAlive()`
`boolean`	`isNeedClientAuth()`
`boolean`	`isReuseAddress()`
`boolean`	`isSsl()`
`boolean`	`isSslClientCertHeaders()`
`boolean`	`isTcp()`
`boolean`	`isTcpNoDelay()`
`void`	`setBacklog(int backlog)` Allows to configure a backlog for netty consumer (server).
`void`	`setBossCount(int bossCount)` When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1.
`void`	`setBossPool(org.jboss.netty.channel.socket.nio.BossPool bossPool)` To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool.
`void`	`setBroadcast(boolean broadcast)` Setting to choose Multicast over UDP
`void`	`setChannelGroup(org.jboss.netty.channel.group.ChannelGroup channelGroup)` To use a explicit ChannelGroup.
`void`	`setConnectTimeout(long connectTimeout)` Time to wait for a socket connection to be available.
`void`	`setEnabledProtocols(String enabledProtocols)` Which protocols to enable when using SSL
`void`	`setHost(String host)` The hostname.
`void`	`setKeepAlive(boolean keepAlive)` Setting to ensure socket is not closed due to inactivity
`void`	`setKeyStoreFile(File keyStoreFile)` Deprecated.
`void`	`setKeyStoreFormat(String keyStoreFormat)` Keystore format to be used for payload encryption.
`void`	`setKeyStoreResource(String keyStoreResource)` Client side certificate keystore to be used for encryption.
`void`	`setNeedClientAuth(boolean needClientAuth)` Configures whether the server needs client authentication when using SSL.
`void`	`setNettyServerBootstrapFactory(NettyServerBootstrapFactory nettyServerBootstrapFactory)` To use a custom NettyServerBootstrapFactory
`void`	`setNetworkInterface(String networkInterface)` When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group.
`void`	`setOptions(Map<String,Object> options)` Allows to configure additional netty options using "option." as prefix.
`void`	`setPassphrase(String passphrase)` Password setting to use in order to encrypt/decrypt payloads sent using SSH
`void`	`setPort(int port)` The host port number
`void`	`setProtocol(String protocol)` The protocol to use which can be tcp or udp.
`void`	`setReceiveBufferSize(long receiveBufferSize)` The TCP/UDP buffer sizes to be used during inbound communication.
`void`	`setReceiveBufferSizePredictor(int receiveBufferSizePredictor)` Configures the buffer size predictor.
`void`	`setReuseAddress(boolean reuseAddress)` Setting to facilitate socket multiplexing
`void`	`setSecurityProvider(String securityProvider)` Security provider to be used for payload encryption.
`void`	`setSendBufferSize(long sendBufferSize)` The TCP/UDP buffer sizes to be used during outbound communication.
`void`	`setServerPipelineFactory(ServerPipelineFactory serverPipelineFactory)` To use a custom ServerPipelineFactory
`void`	`setSsl(boolean ssl)` Setting to specify whether SSL encryption is applied to this endpoint
`void`	`setSslClientCertHeaders(boolean sslClientCertHeaders)` When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.
`void`	`setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)` To configure security using SSLContextParameters
`void`	`setSslHandler(org.jboss.netty.handler.ssl.SslHandler sslHandler)` Reference to a class that could be used to return an SSL Handler
`void`	`setTcpNoDelay(boolean tcpNoDelay)` Setting to improve TCP protocol performance
`void`	`setTrustStoreFile(File trustStoreFile)` Deprecated.
`void`	`setTrustStoreResource(String trustStoreResource)` Server side certificate keystore to be used for encryption.
`void`	`setWorkerCount(int workerCount)` When netty works on nio mode, it uses default workerCount parameter from Netty, which is cpu_core_threads*2.
`void`	`setWorkerPool(org.jboss.netty.channel.socket.nio.WorkerPool workerPool)` To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool.
`String`	`toStringBootstrapConfiguration()`

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

Field Detail

DEFAULT_ENABLED_PROTOCOLS

public static final String DEFAULT_ENABLED_PROTOCOLS

See Also:: Constant Field Values

protocol

@UriPath(enums="tcp,udp")
 @Metadata(required="true")
protected String protocol

host

@UriPath
 @Metadata(required="true")
protected String host

port

@UriPath
 @Metadata(required="true")
protected int port

broadcast

@UriParam(label="consumer")
protected boolean broadcast

sendBufferSize

@UriParam(label="advanced",
          defaultValue="65536")
protected long sendBufferSize

receiveBufferSize

@UriParam(label="advanced",
          defaultValue="65536")
protected long receiveBufferSize

receiveBufferSizePredictor

@UriParam(label="advanced")
protected int receiveBufferSizePredictor

bossCount

@UriParam(label="consumer,advanced",
          defaultValue="1")
protected int bossCount

workerCount

@UriParam(label="consumer,advanced")
protected int workerCount

keepAlive

@UriParam(defaultValue="true")
protected boolean keepAlive

tcpNoDelay

@UriParam(defaultValue="true")
protected boolean tcpNoDelay

reuseAddress

@UriParam(defaultValue="true")
protected boolean reuseAddress

connectTimeout

@UriParam(label="producer",
          defaultValue="10000")
protected long connectTimeout

backlog

@UriParam(label="consumer,advanced")
protected int backlog

serverPipelineFactory

@UriParam(label="consumer,advanced")
protected ServerPipelineFactory serverPipelineFactory

nettyServerBootstrapFactory

@UriParam(label="consumer,advanced")
protected NettyServerBootstrapFactory nettyServerBootstrapFactory

options

@UriParam(label="advanced",
          prefix="option.",
          multiValue=true)
protected Map<String,Object> options

ssl

@UriParam(label="security")
protected boolean ssl

sslClientCertHeaders

@UriParam(label="security")
protected boolean sslClientCertHeaders

sslHandler

@UriParam(label="security")
protected org.jboss.netty.handler.ssl.SslHandler sslHandler

sslContextParameters

@UriParam(label="security")
protected org.apache.camel.util.jsse.SSLContextParameters sslContextParameters

needClientAuth

@UriParam(label="consumer,security")
protected boolean needClientAuth

keyStoreFile

@UriParam(label="security")
protected File keyStoreFile

trustStoreFile

@UriParam(label="security")
protected File trustStoreFile

keyStoreResource

@UriParam(label="security")
protected String keyStoreResource

trustStoreResource

@UriParam(label="security")
protected String trustStoreResource

keyStoreFormat

@UriParam(defaultValue="JKS",
          label="security")
protected String keyStoreFormat

securityProvider

@UriParam(defaultValue="SunX509",
          label="security")
protected String securityProvider

enabledProtocols

@UriParam(defaultValue="TLSv1,TLSv1.1,TLSv1.2",
          label="security")
protected String enabledProtocols

passphrase

@UriParam(label="security",
          secret=true)
protected String passphrase

bossPool

@UriParam(label="consumer,advanced")
protected org.jboss.netty.channel.socket.nio.BossPool bossPool

workerPool

@UriParam(label="consumer,advanced")
protected org.jboss.netty.channel.socket.nio.WorkerPool workerPool

channelGroup

@UriParam(label="consumer,advanced")
protected org.jboss.netty.channel.group.ChannelGroup channelGroup

networkInterface

@UriParam(label="consumer,advanced")
protected String networkInterface

Constructor Detail
- NettyServerBootstrapConfiguration
```
public NettyServerBootstrapConfiguration()
```

Method Detail
- getAddress
```
public String getAddress()
```
- isTcp
```
public boolean isTcp()
```
- getProtocol
```
public String getProtocol()
```
- setProtocol
```
public void setProtocol(String protocol)
```
  The protocol to use which can be tcp or udp.
- getHost
```
public String getHost()
```
- setHost
```
public void setHost(String host)
```
  The hostname.
  For the consumer the hostname is localhost or 0.0.0.0 For the producer the hostname is the remote host to connect to
- getPort
```
public int getPort()
```
- setPort
```
public void setPort(int port)
```
  The host port number
- isBroadcast
```
public boolean isBroadcast()
```
- setBroadcast
```
public void setBroadcast(boolean broadcast)
```
  Setting to choose Multicast over UDP
- getSendBufferSize
```
public long getSendBufferSize()
```
- setSendBufferSize
```
public void setSendBufferSize(long sendBufferSize)
```
  The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
- getReceiveBufferSize
```
public long getReceiveBufferSize()
```
- setReceiveBufferSize
```
public void setReceiveBufferSize(long receiveBufferSize)
```
  The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
- getReceiveBufferSizePredictor
```
public int getReceiveBufferSizePredictor()
```
- setReceiveBufferSizePredictor
```
public void setReceiveBufferSizePredictor(int receiveBufferSizePredictor)
```
  Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
- getWorkerCount
```
public int getWorkerCount()
```
- setWorkerCount
```
public void setWorkerCount(int workerCount)
```
  When netty works on nio mode, it uses default workerCount parameter from Netty, which is cpu_core_threads*2. User can use this operation to override the default workerCount from Netty
- getBossCount
```
public int getBossCount()
```
- setBossCount
```
public void setBossCount(int bossCount)
```
  When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this operation to override the default bossCount from Netty
- isKeepAlive
```
public boolean isKeepAlive()
```
- setKeepAlive
```
public void setKeepAlive(boolean keepAlive)
```
  Setting to ensure socket is not closed due to inactivity
- isTcpNoDelay
```
public boolean isTcpNoDelay()
```
- setTcpNoDelay
```
public void setTcpNoDelay(boolean tcpNoDelay)
```
  Setting to improve TCP protocol performance
- isReuseAddress
```
public boolean isReuseAddress()
```
- setReuseAddress
```
public void setReuseAddress(boolean reuseAddress)
```
  Setting to facilitate socket multiplexing
- getConnectTimeout
```
public long getConnectTimeout()
```
- setConnectTimeout
```
public void setConnectTimeout(long connectTimeout)
```
  Time to wait for a socket connection to be available. Value is in millis.
- getBacklog
```
public int getBacklog()
```
- setBacklog
```
public void setBacklog(int backlog)
```
  Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the "accept" queue can be If this option is not configured, then the backlog depends on OS setting.
- isSsl
```
public boolean isSsl()
```
- setSsl
```
public void setSsl(boolean ssl)
```
  Setting to specify whether SSL encryption is applied to this endpoint
- isSslClientCertHeaders
```
public boolean isSslClientCertHeaders()
```
- setSslClientCertHeaders
```
public void setSslClientCertHeaders(boolean sslClientCertHeaders)
```
  When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.
- getSslHandler
```
public org.jboss.netty.handler.ssl.SslHandler getSslHandler()
```
- setSslHandler
```
public void setSslHandler(org.jboss.netty.handler.ssl.SslHandler sslHandler)
```
  Reference to a class that could be used to return an SSL Handler
- getSslContextParameters
```
public org.apache.camel.util.jsse.SSLContextParameters getSslContextParameters()
```
- setSslContextParameters
```
public void setSslContextParameters(org.apache.camel.util.jsse.SSLContextParameters sslContextParameters)
```
  To configure security using SSLContextParameters
- isNeedClientAuth
```
public boolean isNeedClientAuth()
```
- setNeedClientAuth
```
public void setNeedClientAuth(boolean needClientAuth)
```
  Configures whether the server needs client authentication when using SSL.
- getKeyStoreFile
```
@Deprecated
public File getKeyStoreFile()
```
  Deprecated.
- setKeyStoreFile
```
@Deprecated
public void setKeyStoreFile(File keyStoreFile)
```
  Deprecated.
  
  Client side certificate keystore to be used for encryption
- getTrustStoreFile
```
@Deprecated
public File getTrustStoreFile()
```
  Deprecated.
- setTrustStoreFile
```
@Deprecated
public void setTrustStoreFile(File trustStoreFile)
```
  Deprecated.
  
  Server side certificate keystore to be used for encryption
- getKeyStoreResource
```
public String getKeyStoreResource()
```
- setKeyStoreResource
```
public void setKeyStoreResource(String keyStoreResource)
```
  Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with "classpath:", "file:", or "http:" to load the resource from different systems.
- getTrustStoreResource
```
public String getTrustStoreResource()
```
- setTrustStoreResource
```
public void setTrustStoreResource(String trustStoreResource)
```
  Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with "classpath:", "file:", or "http:" to load the resource from different systems.
- getKeyStoreFormat
```
public String getKeyStoreFormat()
```
- setKeyStoreFormat
```
public void setKeyStoreFormat(String keyStoreFormat)
```
  Keystore format to be used for payload encryption. Defaults to "JKS" if not set
- getSecurityProvider
```
public String getSecurityProvider()
```
- setSecurityProvider
```
public void setSecurityProvider(String securityProvider)
```
  Security provider to be used for payload encryption. Defaults to "SunX509" if not set.
- getPassphrase
```
public String getPassphrase()
```
- setPassphrase
```
public void setPassphrase(String passphrase)
```
  Password setting to use in order to encrypt/decrypt payloads sent using SSH
- getServerPipelineFactory
```
public ServerPipelineFactory getServerPipelineFactory()
```
- setServerPipelineFactory
```
public void setServerPipelineFactory(ServerPipelineFactory serverPipelineFactory)
```
  To use a custom ServerPipelineFactory
- getNettyServerBootstrapFactory
```
public NettyServerBootstrapFactory getNettyServerBootstrapFactory()
```
- setNettyServerBootstrapFactory
```
public void setNettyServerBootstrapFactory(NettyServerBootstrapFactory nettyServerBootstrapFactory)
```
  To use a custom NettyServerBootstrapFactory
- getOptions
```
public Map<String,Object> getOptions()
```
- setOptions
```
public void setOptions(Map<String,Object> options)
```
  Allows to configure additional netty options using "option." as prefix. For example "option.child.keepAlive=false" to set the netty option "child.keepAlive=false". See the Netty documentation for possible options that can be used.
- getBossPool
```
public org.jboss.netty.channel.socket.nio.BossPool getBossPool()
```
- setBossPool
```
public void setBossPool(org.jboss.netty.channel.socket.nio.BossPool bossPool)
```
  To use a explicit org.jboss.netty.channel.socket.nio.BossPool as the boss thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own boss pool with 1 core thread.
- getWorkerPool
```
public org.jboss.netty.channel.socket.nio.WorkerPool getWorkerPool()
```
- setWorkerPool
```
public void setWorkerPool(org.jboss.netty.channel.socket.nio.WorkerPool workerPool)
```
  To use a explicit org.jboss.netty.channel.socket.nio.WorkerPool as the worker thread pool. For example to share a thread pool with multiple consumers. By default each consumer has their own worker pool with 2 x cpu count core threads.
- getChannelGroup
```
public org.jboss.netty.channel.group.ChannelGroup getChannelGroup()
```
- setChannelGroup
```
public void setChannelGroup(org.jboss.netty.channel.group.ChannelGroup channelGroup)
```
  To use a explicit ChannelGroup.
- getNetworkInterface
```
public String getNetworkInterface()
```
- setNetworkInterface
```
public void setNetworkInterface(String networkInterface)
```
  When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group.
- getEnabledProtocols
```
public String getEnabledProtocols()
```
- setEnabledProtocols
```
public void setEnabledProtocols(String enabledProtocols)
```
  Which protocols to enable when using SSL
- compatible
```
public boolean compatible(NettyServerBootstrapConfiguration other)
```
  Checks if the other NettyServerBootstrapConfiguration is compatible with this, as a Netty listener bound on port X shares the same common NettyServerBootstrapConfiguration, which must be identical.
- toStringBootstrapConfiguration
```
public String toStringBootstrapConfiguration()
```

Class NettyServerBootstrapConfiguration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ENABLED_PROTOCOLS

protocol

host

port

broadcast

sendBufferSize

receiveBufferSize

receiveBufferSizePredictor

bossCount

workerCount

keepAlive

tcpNoDelay

reuseAddress

connectTimeout

backlog

serverPipelineFactory

nettyServerBootstrapFactory

options

ssl

sslClientCertHeaders

sslHandler

sslContextParameters

needClientAuth

keyStoreFile

trustStoreFile

keyStoreResource

trustStoreResource

keyStoreFormat

securityProvider

enabledProtocols

passphrase

bossPool

workerPool

channelGroup

networkInterface

Constructor Detail

NettyServerBootstrapConfiguration

Method Detail

getAddress

isTcp

getProtocol

setProtocol

getHost

setHost

getPort

setPort

isBroadcast

setBroadcast

getSendBufferSize

setSendBufferSize

getReceiveBufferSize

setReceiveBufferSize

getReceiveBufferSizePredictor

setReceiveBufferSizePredictor

getWorkerCount

setWorkerCount

getBossCount

setBossCount

isKeepAlive

setKeepAlive

isTcpNoDelay

setTcpNoDelay

isReuseAddress

setReuseAddress

getConnectTimeout

setConnectTimeout

getBacklog

setBacklog

isSsl

setSsl

isSslClientCertHeaders

setSslClientCertHeaders

getSslHandler

setSslHandler