LibraryToggle FramesPrintFeedback

List of Components

Table of components

The following components are available for use with Apache Camel.

Table 1. Apache Camel Components

ComponentEndpoint URIArtifact IDDescription
ActiveMQactivemq:[queue:|topic:]DestinationNameactivemq-coreFor JMS Messaging with Apache ActiveMQ.
ActiveMQ Journalactivemq.journal:DirectoryName[?Options]activemq-coreUses ActiveMQ's fast disk journaling implementation to store message bodies in a rolling log file.
AHCahc:http[s]://Hostname[:Port][/ResourceUri]camel-ahcTo call external HTTP services using Async Http Client
AMQPamqp:[queue:|topic:]DestinationName[?Options]]camel-amqpFor messaging with the AMQP protocol.
APNS
apns:notify[?Options]
apns:consumer[?Options]
camel-apnsFor sending notifications to Apple iOS devices.
Atomatom://AtomUri[?Options]camel-atomWorking with Apache Abdera for atom integration, such as consuming an atom feed.
Avroavro:http://Hostname[:Port][?Options]camel-avroWorking with Apache Avro for data serialization.
AWS-DDBaws-ddb://TableName[?Options]camel-awsFor working with Amazon's DynamoDB (DDB).
AWS-SDBaws-sdb://DomainName[?Options]camel-awsFor working with Amazon's SimpleDB (SDB).
AWS-SESaws-ses://From[?Options]camel-awsFor working with Amazon's Simple Email Service (SES).
AWS-S3aws-s3://BucketName[?Options]camel-awsFor working with Amazon's Simple Storage Service (S3).
AWS-SNSaws-sns://TopicName[?Options]camel-awsFor Messaging with Amazon's Simple Notification Service (SNS).
AWS-SQSaws-sqs://QueueName[?Options]camel-awsFor Messaging with Amazon's Simple Queue Service (SQS).
Beanbean:BeanID[?methodName=Method]camel-coreUses the Bean Binding to bind message exchanges to beans in the Registry. Is also used for exposing and invoking POJO (Plain Old Java Objects).
Bean Validation
bean-validator:Something[?Options]
camel-bean-validatorValidates the payload of a message using the Java Validation API (JSR 303 and JAXP Validation) and its reference implementation Hibernate Validator.
Browsebrowse:Name camel-coreProvdes a simple BrowsableEndpoint which can be useful for testing, visualisation tools or debugging. The exchanges sent to the endpoint are all available to be browsed.
Cachecache://CacheName[?Options]camel-cacheThe cache component enables you to perform caching operations using EHCache as the Cache Implementation.
Classclass:ClassName[?method=MethodName]camel-coreUses the Bean binding to bind message exchanges to beans in the registry. Is also used for exposing and invoking POJOs (Plain Old Java Objects).
CMIScmis:CmisServerUrl[?Options]camel-cmisUses the Apache Chemistry client API to interface with CMIS supporting CMS.
Cometdcometd://Hostname[:Port]/ChannelName[?Options]camel-cometdA transport for working with the jetty implementation of the cometd/bayeux protocol.
Contextcontext:CamelContextId:LocalEndpointNamecamel-contextRefers to an endpoint in a different CamelContext.
ControlBuscontrolbus:Command[?Options]camel-coreControlBus Enterprise Integration Pattern that allows you to send messages to endpoints for managing and monitoring your Camel applications.
CouchDBcouchdb:http://Hostname[:Port]/Database[?Options]://Name[?Options]camel-couchdbAllows you to treat CouchDB instances as a producer or consumer of messages.
Crypto
crypto:sign:Name[?Options]
crypto:verify:Name[?Options]
camel-cryptoSign and verify exchanges using the Signature Service of the Java Cryptographic Extension.
CXFcxf://Address[?Options]camel-cxfWorking with Apache CXF for web services integration.
CXF Beancxf:BeanNamecamel-cxfProceess the exchange using a JAX WS or JAX RS annotated bean from the registry.
CXFRScxfrs:bean:RsEndpoint[?Options]camel-cxfProvides integration with Apache CXF for connecting to JAX-RS services hosted in CXF.
DataSetdataset:Name[?Options]camel-coreFor load & soak testing the DataSet provides a way to create huge numbers of messages for sending to Components or asserting that they are consumed correctly.
Db4odb4o:ClassNamecamel-db4oTo use a db4o datastore as a queue, through the db4o library.
Directdirect:EndpointID[?Options]camel-coreSynchronous call (single-threaded) to another endpoint from same CamelContext.
Direct-VMdirect-vm:EndpointID[?Options]camel-coreSynchronous call (single-threaded) to another endpoint in another CamelContext running in the same JVM.
DNSdns:Operationcamel-dnsLook up domain information and run DNS queries using DNSJava
EJBejb:EjbName[?method=MethodName]camel-ejbUses the Bean binding to bind message exchanges to EJBs. It works like the Bean component, but just for accessing EJBs. Supports EJB 3.0 onwards.
ElasticSearchelasticsearch:ClusterNamecamel-elasticsearchFor interfacing with an ElasticSearch server.
Esperesper:namecamel-esperWorking with the Esper Library for Event Stream Processing.
Eventevent://dummycamel-springWorking with Spring ApplicationEvents.
EventAdmineventadmin:topiccamel-eventadmin 
Execexec://Executable[?Options]camel-execExecute system command.
Fabricfabric:ClusterID[:PublishedURI][?Options]fabric-camelLook up or publish a fabric endpoint.
File2file://DirectoryName[?Options]camel-coreSending messages to a file or polling a file or directory.
Flatpackflatpack:[fixed|delim]:ConfigFilecamel-flatpackProcessing fixed width or delimited files or messages using the FlatPack library
FOPfop:OutputFormatcamel-fopRenders the message into different output formats using Apache FOP.
Freemarkerfreemarker:TemplateResource camel-freemarkerGenerates a response using a Freemarker template.
FTP2ftp://[Username@]Hostname[:Port]/Directoryname[?Options]camel-ftpSending and receiving files over FTP.
GAuthgauth://Name[?Options]camel-gaeUsed by web applications to implement a Google-specific OAuth consumer
GHTTP
ghttp:///Path[?Options]
ghttp://Hostname[:Port]/Path[?Options]
ghttps://Hostname[:Port]/Path[?Options]
camel-gaeProvides connectivity to the GAE URL fetch service and can also be used to receive messages from servlets.
GLoginglogin://Hostname[:Port][?Options]camel-gaeUsed by Camel applications outside Google App Engine (GAE) for programmatic login to GAE applications.
GMail
gmail://Username@gmail.com[?Options]
gmail://Username@googlemail.com[?Options]
camel-gaeSupports sending of emails via the GAE mail service.
Guava EventBusguava-eventbus:BusName[?EventClass=ClassName]camel-guava-eventbusThe Google Guava EventBus allows publish-subscribe-style communication between components without requiring the components to explicitly register with one another (and thus be aware of each other). This component provides integration bridge between Camel and Google Guava EventBus infrastructure.
GTaskgtask://QueueNamecamel-gaeSupports asynchronous message processing on GAE using the task queueing service as a message queue.
Hazelcasthazelcast://StoreType:CacheName[?Options]camel-hazelcastHazelcast is a data grid entirely implemented in Java (single JAR). This component supports map, multimap, seda, queue, set, atomic number and simple cluster.
HBasehbase://Table[?Options]camel-hbaseFor reading/writing from/to an HBase store (Hadoop database).
HDFShdfs://Path[?Options]camel-hdfsFor reading/writing from/to an HDFS filesystem.
Hibernatehibernate://EntityName camel-hibernate (Camel Extra)For using a database as a queue via the Hibernate library.
HL7mina:tcp://Host[:Port]camel-hl7For working with the HL7 MLLP protocol and the HL7 model using the HAPI library.
HTTPhttp://Hostname[:Port][/ResourceUri]camel-httpFor calling out to external HTTP servers, using Apache HTTP Client 3.x.
HTTP4http://Hostname[:Port][/ResourceUri]camel-http4For calling out to external HTTP servers, using Apache HTTP Client 4.x.
iBATISibatis:OperationName[?Options]camel-ibatisPerforms a query, poll, insert, update or delete in a relational database using Apache iBATIS.
IMapimap://[UserName@]Host[:Port][?Options]camel-mailReceiving email using IMap.
IRCirc:Host[:Port]/#Roomcamel-ircFor IRC communication.
JavaSpacejavaspace:jini://Host[?Options]camel-javaspaceSending and receiving messages through JavaSpace.
JBI
jbi:service:serviceNamespace[sep]serviceName
jbi:endpoint:serviceNamespace[sep]serviceName[sep]endpointName
jbi:name:endpointName
camel-jbiFor JBI integration such as working with Apache ServiceMix.
JCloudsjclouds:[Blobstore|ComputService]:Providercamel-jcloudsFor interacting with cloud compute & blobstore service via JClouds.
JCRjcr://UserName:Password@Repository/path/to/nodecamel-jcrStoring a message in a JCR (JSR-170) compliant repository like Apache Jackrabbit.
JDBCjdbc:DataSourceName[?Options]camel-jdbcFor performing JDBC queries and operations.
Jettyjetty:http://Host[:Port][/ResourceUri]camel-jettyFor exposing services over HTTP.
JGroupsjgroups://ClusterNamecamel-jgroupsThe JGroups component provides exchange of messages between Camel infrastructure and JGroups clusters.
Jing
rng:LocalOrRemoteResource
rnc:LocalOrRemoteResource
camel-jingValidates the payload of a message using RelaxNG or RelaxNG compact syntax.
JMSjms:[temp:][queue:|topic:]DestinationName[?Options]camel-jmsWorking with JMS providers.
JMXjmx://Platform[?Options]camel-jmxFor working with JMX notification listeners.
JPAjpa:[EntityClassName][?Options]camel-jpaFor using a database as a queue via the JPA specification for working with OpenJPA, Hibernate or TopLink.
Jschscp://Hostname/Destinationcamel-jschSupport for the scp protocol.
JT400jt400://User:Pwd@System/PathToDTAQcamel-jt400For integrating with data queues on an AS/400 (aka System i, IBM i, i5, ...) system.
Kestrelkestrel://[AddressList/]Queuename[?Options]camel-kestrelFor producing to or consuming from Kestrel queues.
Kratikrati://[PathToDatastore/][?Options]camel-kratiFor producing to or consuming to Krati datastores.
Languagelanguage://LanguageName[:Script][?Options]camel-coreExecutes language scripts.
LDAPldap:Host[:Port]?base=...[&scope=Scope]camel-ldapPerforming searches on LDAP servers (Scope must be one of object|onelevel|subtree).
Listlist:ListIDcamel-coreProvides a simple BrowsableEndpoint which can be useful for testing, visualisation tools or debugging. The exchanges sent to the endpoint are all available to be browsed.
Loglog:LoggingCategory[?level=LoggingLevel]camel-coreUses Jakarta Commons Logging to log the message exchange to some underlying logging system like log4j.
Lucene
lucene:SearcherName:insert[?analyzer=Analyzer]
lucene:SearcherName:query[?analyzer=Analyzer]
camel-luceneUses Apache Lucene to perform Java-based indexing and full text based searches using advanced analysis/tokenization capabilities.
MasterREVISIT  
MINA
mina:tcp://Hostname[:Port][?Options]
mina:udp://Hostname[:Port][?Options]
mina:multicast://Hostname[:Port][?Options]
mina:vm://Hostname[:Port][?Options]
camel-minaWorking with Apache MINA.
Mockmock:EndpointIDcamel-coreFor testing routes and mediation rules using mocks.
MongoDBmongodb:Connection[?Options]camel-mongodbInteracts with MongoDB databases and collections. Offers producer endpoints to perform CRUD-style operations and more against databases and collections, as well as consumer endpoints to listen on collections and dispatch objects to Camel routes.
MQTTmqtt:Namecamel-mqttComponent for communicating with MQTT M2M message brokers
MSVmsv:LocalOrRemoteResourcecamel-msvValidates the payload of a message using the MSV Library.
MyBatismybatis:StatementNamecamel-mybatisPerforms a query, poll, insert, update or delete in a relational database using MyBatis.
Nagiosnagios://Host[:Port][?Options]camel-nagiosSending passive checks to Nagios using JSendNSCA.
Netty
netty:tcp://localhost:99999[?Options]
netty:udp://Remotehost:99999/[?Options]
camel-nettyWorking with TCP and UDP protocols using Java NIO based capabilities offered by the JBoss Netty community project.
NMRnmr:serviceMixURIservicemix-camelFor OSGi integration when working with Fuse ESB Enterprise. Enables you to specify the URI of a ServiceMix endpoint.
Pax-Loggingpaxlogging:Appendercamel-paxlogging 
POPpop3://[UserName@]Host[:Port][?Options]camel-mailReceiving email using POP3 and JavaMail.
Printer
lpr://localhost[:Port]/default[?Options]
lpr://RemoteHost[:Port]/path/to/printer[?Options]
camel-printerProvides a way to direct payloads on a route to a printer.
Propertiesproperties://Key[?Options] camel-propertiesFacilitates using property placeholders directly in endpoint URI definitions.
Quartz
quartz://[GroupName/]TimerName[?Options]
quartz://GroupName/TimerName/CronExpression
camel-quartzProvides a scheduled delivery of messages using the Quartz scheduler.
Quickfix
quickfix-server:ConfigFile
quickfix-client:ConfigFile
camel-quickfixImplementation of the QuickFix for Java engine which allow to send/receive FIX messages.
Refref:EndpointIDcamel-coreComponent for lookup of existing endpoints bound in the Registry.
Restletrestlet:RestletUrl[?Options]camel-restletComponent for consuming and producing Restful resources using Restlet.
RMIrmi://RmiRegistryHost:RmiRegistryPort/RegistryPathcamel-rmiWorking with RMI.
Routeboxroutebox:routeboxName[?Options] camel-routebox 
RSSrss:Uricamel-rssWorking with ROME for RSS integration, such as consuming an RSS feed.
RNCrnc:LocalOrRemoteResourcecamel-jingValidates the payload of a message using RelaxNG Compact Syntax.
RNGrng:LocalOrRemoteResourcecamel-jingValidates the payload of a message using RelaxNG.
Scalatescalate:TemplateName[?Options]org.fusesource.scalate/scalate-camelUses the given Scalate template to transform the message.
SEDAseda:EndpointIDcamel-coreUsed to deliver messages to a java.util.concurrent.BlockingQueue, useful when creating SEDA style processing pipelines within the same CamelContext.
SERVLETservlet://RelativePath[?Options]camel-servletProvides HTTP based endpoints for consuming HTTP requests that arrive at a HTTP endpoint and this endpoint is bound to a published Servlet.
SFTPsftp://[Username@]Hostname[:Port]/Directoryname[?Options]camel-ftpSending and receiving files over SFTP.
Sip
sip://User@Hostname[:Port][?Options]
sips://User@Hostname[:Port][?Options]
camel-sipPublish/subscribe communication capability using the telecom SIP protocol. RFC3903 - Session Initiation Protocol (SIP) Extension for Event
Smooks  For working with EDI parsing using the Smooks library.
SMPPsmpp://UserInfo@Host[:Port][?Options]camel-smppTo send and receive SMS using Short Messaging Service Center using the JSMPP library.
SMTPsmtp://[UserName@]Host[:Port][?Options]camel-mailSending email using SMTP and JavaMail.
SNMPsnmp://Hostname[:Port][?Options]camel-snmpGives you the ability to poll SNMP capable devices or receive traps.
Solrsolr://Hostname[:Port]/Solr[?Options]camel-solrUses the Solrj client API to interface with an Apache Lucene Solr server.
SpringBatchspring-batch:Job[?Options]camel-spring-batchTo bridge Camel and Spring Batch.
Spring Integrationspring-integration:DefaultChannelName[?Options]camel-spring-integrationThe bridge component of Camel and Spring Integration.
Spring Web Servicesspring-ws:[MappingType:]Address[?Options]camel-spring-wsClient-side support for accessing web services, and server-side support for creating your own contract-first web services using Spring Web Services.
SQLsql:SqlQueryString[?Options]camel-sqlPerforming SQL queries using JDBC.
SSHssh:[Username[:Password]@]Host[:Port][?Options]camel-sshFor sending commands to a SSH server.
StAXstax:ContentHandlerClassNamecamel-staxProcess messages through a SAX ContentHandler.
Streamstream:[in|out|err|header][?Options]camel-streamRead or write to an input/output/error/file stream rather like Unix pipes.
String Templatestring-template:TemplateURI[?Options]camel-stringtemplateGenerates a response using a String Template.
Stubstub:SomeOtherCamelUricamel-coreAllows you to stub out some physical middleware endpoint for easier testing or debugging.
Testtest:RouterEndpointUricamel-springCreates a Mock endpoint which expects to receive all the message bodies that could be polled from the given underlying endpoint.
Timertimer:EndpointID[?Options]camel-coreA timer endpoint.
Twittertwitter://[Endpoint][?Options]camel-twitterA Twitter endpoint.
Validationvalidator:LocalOrRemoteResourcecamel-springValidates the payload of a message using XML Schema and JAXP Validation.
Velocityvelocity:TemplateURI[?Options]camel-velocityGenerates a response using an Apache Velocity template.
VMvm:EndpointIDcamel-coreUsed to deliver messages to a java.util.concurrent.BlockingQueue, useful when creating SEDA style processing pipelines within the same JVM.
Websocketwebsocket://Hostname[:Port]/Pathcamel-websocketCommunicating with Websocket clients.
XMPPxmpp:Hostname[:Port][/Room]camel-xmppWorking with XMPP and Jabber.
XQueryxquery:TemplateURIcamel-saxonGenerates a response using an XQuery template.
XSLTxslt:TemplateURI[?Options]camel-springxquery:someXQueryResource.
Zookeeperzookeeper://Hostname[:Port]/Path camel-zookeeperWorking with ZooKeeper cluster(s).

Comments powered by Disqus