LibraryToggle FramesPrintFeedback

Name Default Value Description
keepAlive true Setting to ensure socket is not closed due to inactivity
tcpNoDelay true Setting to improve TCP protocol performance
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
ssl false Setting to specify whether SSL encryption is applied to this endpoint
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.
corePoolSize 10 The number of allocated threads at component startup. Defaults to 10
maxPoolSize 100 The maximum number of threads that may be allocated to this endpoint. Defaults to 100
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 Fuse Mediation Router 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. Fuse Mediation Router 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.
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.

Codec Handlers and SSL Keystores can be enlisted in the Registry, such as in the Spring XML file. The values that could be passed in, are the following:

Name Description
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 Client side certificate keystore to be used for encryption
trustStoreFile Server side certificate keystore to be used for encryption
sslHandler Reference to a class that could be used to return an SSL Handler
encoder A custom Handler class that can be used to perform special marshalling of outbound payloads. Must override
encorders A list of encoder 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 Fuse Mediation Router knows it should lookup.
decoder A custom Handler class that can be used to perform special marshalling of inbound payloads. Must override
decoders A list of decorder 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 Fuse Mediation Router knows it should lookup.

In certain cases it may be necessary to add chains of encoders and decoders to the netty pipeline. To add multpile codecs to a Fuse Mediation Router netty endpoint the 'encoders' and 'decoders' uri parameters should be used. Like the 'encoder' and 'decoder' parameters they are used to supply references (to lists of ChannelUpstreamHandlers and ChannelDownstreamHandlers) that should be added to the pipeline. Note that if encoders is specified then the encoder param will be ignored, similarly for decoders and the decoder param.

The lists of codecs need to be added to the Fuse Mediation Router's registry so they can be resolved when the endpoint is created.

LengthFieldBasedFrameDecoder lengthDecoder = new LengthFieldBasedFrameDecoder(1048576, 0, 4, 0, 4);
StringDecoder stringDecoder = new StringDecoder();
registry.bind("length-decoder", lengthDecoder);
registry.bind("string-decoder", stringDecoder);

LengthFieldPrepender lengthEncoder = new LengthFieldPrepender(4);
StringEncoder stringEncoder = new StringEncoder();
registry.bind("length-encoder", lengthEncoder);
registry.bind("string-encoder", stringEncoder);

List<ChannelUpstreamHandler> decoders = new ArrayList<ChannelUpstreamHandler>();

List<ChannelDownstreamHandler> encoders = new ArrayList<ChannelDownstreamHandler>();

registry.bind("encoders", encoders);
registry.bind("decoders", decoders);

Spring's native collections support can be used to specify the codec lists in an application context

    <util:list id="decoders" list-class="java.util.LinkedList">
        <bean class="org.jboss.netty.handler.codec.frame.LengthFieldBasedFrameDecoder">
            <constructor-arg value="1048576"/>
            <constructor-arg value="0"/>
            <constructor-arg value="4"/>
            <constructor-arg value="0"/>
            <constructor-arg value="4"/>
        <bean class="org.jboss.netty.handler.codec.string.StringDecoder"/>

    <util:list id="encoders" list-class="java.util.LinkedList">
        <bean class="org.jboss.netty.handler.codec.frame.LengthFieldPrepender">
            <constructor-arg value="4"/>
        <bean class="org.jboss.netty.handler.codec.string.StringEncoder"/>

    <bean id="length-encoder" class="org.jboss.netty.handler.codec.frame.LengthFieldPrepender">
        <constructor-arg value="4"/>
    <bean id="string-encoder" class="org.jboss.netty.handler.codec.string.StringEncoder"/>

    <bean id="length-decoder" class="org.jboss.netty.handler.codec.frame.LengthFieldBasedFrameDecoder">
        <constructor-arg value="1048576"/>
        <constructor-arg value="0"/>
        <constructor-arg value="4"/>
        <constructor-arg value="0"/>
        <constructor-arg value="4"/>
    <bean id="string-decoder" class="org.jboss.netty.handler.codec.string.StringDecoder"/>


The bean names can then be used in netty endpoint definitions either as a comma separated list or contained in a List e.g.


or via spring.

<camelContext id="multiple-netty-codecs-context" xmlns="">
        <from uri="direct:multiple-codec"/>
        <to uri="netty:tcp://localhost:5150?encoders=#encoders&ync=false"/>
        <from uri="netty:tcp://localhost:5150?decoders=#length-decoder,#string-decoder&ync=false"/>
        <to uri="mock:multiple-codec"/>

Available as of Camel 2.5

Custom channel pipelines provide complete control to the user over the handler/interceptor chain by inserting custom handler(s), encoder(s) and decoders without having to specify them in the Netty Endpoint URL in a very simple way.

In order to add a custom pipeline, a custom channel pipeline factory must be created and registered with the context through the context registry (JNDIRegistry,or the Spring ApplicationContextRegistry etc).

A custom pipeline factory must be constructed as follows

The example below shows how ServerChannel Pipeline factory may be created

public class SampleServerChannelPipelineFactory extends ServerPipelineFactory {
    private int maxLineSize = 1024;
    private boolean invoked;

    public ChannelPipeline getPipeline() throws Exception {
        invoked = true;
        ChannelPipeline channelPipeline = Channels.pipeline();
        channelPipeline.addLast("encoder-SD", new StringEncoder(CharsetUtil.UTF_8));
        channelPipeline.addLast("decoder-DELIM", new DelimiterBasedFrameDecoder(maxLineSize, true, Delimiters.lineDelimiter()));
        channelPipeline.addLast("decoder-SD", new StringDecoder(CharsetUtil.UTF_8));
        channelPipeline.addLast("handler", new ServerChannelHandler(consumer));

        return channelPipeline;
    public boolean isfactoryInvoked() {
        return invoked;

The custom channel pipeline factory can then be added to the registry and instantiated/utilized on a camel route as follows:

Registry registry = camelContext.getRegistry();
serverPipelineFactory = new TestServerChannelPipelineFactory();
registry.bind("spf", serverPipelineFactory);
context.addRoutes(new RouteBuilder() {
    public void configure() {
        String netty_ssl_endpoint =
        String return_string =
          "When You Go Home, Tell Them Of Us And Say,"
          + "For Your Tomorrow, We Gave Our Today.";
          .process(new Processor() {
            public void process(Exchange exchange) throws Exception {
Comments powered by Disqus