Netty Component
Available as of Camel 2.3
The netty component in Camel is a socket communication component, based on the
JBoss Netty community offering (available under an Apache 2.0 license). Netty is a
NIO client server framework which enables quick and easy development of network applications
such as protocol servers and clients. Netty greatly simplifies and streamlines network
programming such as TCP and UDP socket server.
This camel component supports both producer and consumer endpoints.
The netty component has several options and allows fine-grained control of a number of
TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates
both In-Only and In-Out communication on a Camel route.
Maven users will need to add the following dependency to their pom.xml
for this component:
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-netty</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
URI format
The URI scheme for a netty component is as follows
netty:tcp://localhost:99999[?options] netty:udp://remotehost:99999/[?options]
This component supports producer and consumer endpoints for both TCP and UDP.
You can append query options to the URI in the following format, ?option=value&option=value&...
Options
Name |
Default Value |
Description |
---|---|---|
|
|
Setting to ensure socket is not closed due to inactivity |
|
|
Setting to improve TCP protocol performance |
|
|
Setting to choose Multicast over UDP |
|
|
Time to wait for a socket connection to be available |
|
|
Time to wait for a response to be received on a connection |
|
|
Setting to facilitate socket multiplexing |
|
|
Setting to set endpoint as one-way or request-response |
|
|
Setting to specify whether SSL encryption is applied to this endpoint |
|
|
The TCP/UDP buffer sizes to be used during outbound communication |
|
|
The TCP/UDP buffer sizes to be used during inbound communication |
|
|
The number of allocated threads at component startup. Defaults to 10 |
|
|
The maximum number of threads that may be allocated to this endpoint. Defaults to 100 |
|
|
Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer. |
Registry based Options
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 |
---|---|
|
password setting to use in order to encrypt/decrypt payloads sent using SSH |
|
keystore format to be used for payload encryption. Defaults to "JKS" if not set |
|
Security provider to be used for payload encryption. Defaults to "SunX509" if not set. |
|
Client side certificate keystore to be used for encryption |
|
Server side certificate keystore to be used for encryption |
|
Reference to a class that could be used to return an SSL Handler |
|
A custom Handler class that can be used to perform special marshalling of outbound payloads. Must override |
|
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 Camel knows it should lookup. |
|
A custom Handler class that can be used to perform special marshalling of inbound payloads. Must override |
|
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 Camel knows it should lookup. |
|
A custom Handler class that can be used to perform custom processing of Netty events triggered |
Sending Messages to/from a Netty endpoint
Netty Producer
In Producer mode, the component provides the ability to send payloads to a socket endpoint
using either TCP or UDP protocols (with optional SSL support).
The producer mode supports both one-way and request-response based operations.
Netty Consumer
In Consumer mode, the component provides the ability to:
- listen on a specified socket using either TCP or UDP protocols (with optional SSL support),
- receive requests on the socket using text/xml, binary and serialized object based payloads and
- send them along on a route as message exchanges.
The consumer mode supports both one-way and request-response based operations.
Usage Samples
A UDP Netty endpoint using Request-Reply and serialized object payload
RouteBuilder builder = new RouteBuilder() { public void configure() { from("netty:udp://localhost:5155?sync=true") .process(new Processor() { public void process(Exchange exchange) throws Exception { Poetry poetry = (Poetry) exchange.getIn().getBody(); poetry.setPoet("Dr. Sarojini Naidu"); exchange.getOut().setBody(poetry); } } } };
A TCP based Netty consumer endpoint using One-way communication
RouteBuilder builder = new RouteBuilder() { public void configure() { from("netty:tcp://localhost:5150") .to("mock:result"); } };
An SSL/TCP based Netty consumer endpoint using Request-Reply communication
JndiRegistry registry = new JndiRegistry(createJndiContext()); registry.bind("password", "changeit"); registry.bind("ksf", new File("src/test/resources/keystore.jks")); registry.bind("tsf", new File("src/test/resources/keystore.jks")); context.createRegistry(registry); context.addRoutes(new RouteBuilder() { public void configure() { String netty_ssl_endpoint = "netty:tcp://localhost:5150sync=true&ssl=true&passphrase=#password" + "&keyStoreFile=#ksf&trustStoreFile=#tsf"; String return_string = "When You Go Home, Tell Them Of Us And Say," + "For Your Tomorrow, We Gave Our Today."; from(netty_ssl_endpoint) .process(new Processor() { public void process(Exchange exchange) throws Exception { exchange.getOut().setBody(return_string); } } } });
Using Multiple Codecs
In certain cases it may be necessary to add chains of encoders and decoders to the netty pipeline. To add multpile codecs to a camel 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 Camel's registry so they can be resolved when the endpoint is created.
Spring's native collections support can be used to specify the codec lists in an application context
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.