Page History

keepAlive

true

Setting to ensure socket is not closed due to inactivity

tcpNoDelay

true

Setting to improve TCP protocol performance

backlog

Camel

2.9.6/2.10.4/2.11:

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.

broadcast

false

Setting to choose Multicast over UDP

connectTimeout

10000

Time to wait for a socket connection to be available. Value is in millis.

reuseAddress

true

Setting to facilitate socket multiplexing

sync

true

Setting to set endpoint as one-way or request-response

synchronous

false

Camel 2.10: Whether Asynchronous Routing Engine is not in use. false then the Asynchronous Routing Engine is used, true to force processing synchronous.

ssl

false

Setting to specify whether SSL encryption is applied to this endpoint

sslClientCertHeaders

false

Camel 2.12: 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.

sendBufferSize

65536 bytes

The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.

receiveBufferSize

65536 bytes

The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.

option.XXX

null

Camel 2.11/2.10.4:

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.

corePoolSize

10

The number of allocated threads at component startup. Defaults to 10. Note: This option is removed from Camel 2.9.2

onwards.

As

we

rely

on

Nettys

default

settings.

maxPoolSize

100

The maximum number of threads that may be allocated to this endpoint. Defaults to 100. Note: This option is removed from Camel 2.9.2

onwards.

As

we

rely

on

Nettys

default

settings.

disconnect

false

Whether or not to disconnect(close)

from

Netty

Channel

right

after

use.

Can

be

used

for

both

consumer

and

producer.

lazyChannelCreation

true

Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.

transferExchange

false

Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.

disconnectOnNoReply

true

If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.

noReplyLogLevel

WARN

If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back. Values are: FATAL, ERROR, INFO, DEBUG, OFF.

serverExceptionCaughtLogLevel

WARN

Camel 2.11.1: If the server (NettyConsumer) catches an exception then its logged using this logging level.

serverClosedChannelExceptionCaughtLogLevel

DEBUG

Camel 2.11.1: If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flod of closed exceptions in the Netty server.

allowDefaultCodec

true

Camel 2.4: The netty component installs a default codec if both, encoder/deocder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain.

textline

false

Camel 2.4: Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP.

delimiter

LINE

Camel 2.4: The delimiter to use for the textline codec. Possible values are LINE and NULL.

decoderMaxLineLength

1024

Camel 2.4: The max line length to use for the textline codec.

autoAppendDelimiter

true

Camel 2.4: Whether or not to auto append missing end delimiter when sending using the textline codec.

encoding

null

Camel 2.4: The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset.

workerCount

null

Camel 2.9: 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

sslContextParameters

null

Camel 2.9: SSL configuration using an org.apache.camel.util.jsse.SSLContextParameters

instance.

See

Using

the

JSSE

Configuration

Utility

.

receiveBufferSizePredictor

null

Camel 2.9:

Configures

the

buffer

size

predictor.

See

details

at

Jetty

documentation

and

this

mail thread.

requestTimeout

0

Camel 2.11.1:

Allows

to

use

a

timeout

for

the

Netty

producer

when

calling

a

remote

server.

By

default

no

timeout

is

in

use.

The

value

is

in

milli

seconds,

so

eg

30000

is

30

seconds.

needClientAuth

false

Camel 2.11:

Configures

whether

the

server

needs

client

authentication

when

using

SSL.

orderedThreadPoolExecutor

true

Camel 2.10.2:

Whether

to

use

ordered

thread

pool,

to

ensure

events

are

processed

orderly

on

the

same

channel.

See

details

at

the

netty

javadoc

of

org.jboss.netty.handler.execution.OrderedMemoryAwareThreadPoolExecutor

for

more

details.

maximumPoolSize

16

Camel 2.10.2:

The

core

pool

size

for

the

ordered

thread

pool,

if

its

in

use.

producerPoolEnabled

true

Camel 2.10.4/Camel

2.11:

Producer

only.

Whether

producer

pool

is

enabled

or

not.

Important:

Do

not

turn

this

off,

as

the

pooling

is

needed

for

handling

concurrency

and

reliable

request/reply.

producerPoolMaxActive

-1

Camel 2.10.3:

Producer

only.

Sets

the

cap

on

the

number

of

objects

that

can

be

allocated

by

the

pool

(checked

out

to

clients,

or

idle

awaiting

checkout)

at

a

given

time.

Use

a

negative

value

for

no

limit.

producerPoolMinIdle

0

Camel 2.10.3:

Producer

only.

Sets

the

minimum

number

of

instances

allowed

in

the

producer

pool

before

the

evictor

thread

(if

active)

spawns

new

objects.

producerPoolMaxIdle

100

Camel 2.10.3:

Producer

only.

Sets

the

cap

on

the

number

of

"idle"

instances

in

the

pool.

producerPoolMinEvictableIdle

30000

Camel 2.10.3:

Producer

only.

Sets

the

minimum

amount

of

time

(value

in

millis)

an

object

may

sit

idle

in

the

pool

before

it

is

eligible

for

eviction

by

the

idle

object

evictor.

bootstrapConfiguration

null

Camel 2.12:

Consumer

only.

Allows

to

configure

the

Netty

ServerBootstrap

options

using

a

org.apache.camel.component.netty.NettyServerBootstrapConfiguration

instance.

This

can

be

used

to

reuse

the

same

configuration

for

multiple

consumers,

to

align

their

configuration

more

easily.

bossPoll

null

Camel 2.12:

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.

workerPool

null

Camel 2.12:

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.

networkInterface

null

Camel 2.12:

Consumer

only.

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.

passphrase

password setting to use in order to encrypt/decrypt payloads sent using SSH

keyStoreFormat

keystore format to be used for payload encryption. Defaults to "JKS" if not set

securityProvider

Security provider to be used for payload encryption. Defaults to "SunX509" if not set.

keyStoreFile

deprecated: Client side certificate keystore to be used for encryption

trustStoreFile

deprecated: Server side certificate keystore to be used for encryption

keyStoreResource

Camel

2.11.1:

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.

trustStoreResource

Camel 2.11.1:

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.

sslHandler

Reference to a class that could be used to return an SSL Handler

encoder

A custom ChannelHandler class that can be used to perform special marshalling of outbound payloads. Must override org.jboss.netty.channel.ChannelDownStreamHandler

.

encorders

A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.

decoder

A custom ChannelHandler class that can be used to perform special marshalling of inbound payloads. Must override org.jboss.netty.channel.ChannelUpStreamHandler

.

decoders

A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.