SOAP
The SOAP component in SwitchYard provides SOAP-based web service binding support for services and references in SwitchYard.
Binding Services with SOAP
Composite-level services can be exposed as a SOAP-based web service using the <binding.soap> binding definition. The following configuration options are available for binding.soap when binding services:
-
wsdl : location of the WSDL used to describe the web service endpoint. A relative path can be used if the WSDL is included in the deployed application. If the WSDL is located outside the application, then a file: or http: URL can be used.
-
socketAddr : the IP Socket Address to be used. The value can be in the form hostName/ipAddress:portNumber or hostName/ipAddress or :portNumber.
-
wsdlPort : port name in the WSDL to use. If unspecified, the first port definition in the WSDL is used for the service endpoint
-
contextPath : additional context path for the SOAP endpoint. Default is none.
In AS7 by default the JBossWS-CXF stack is enabled now and hence the socketAddr parameter will be ignored. However this parameter can be used for standalone usage under JDK's JAXWS-RI.
Here's an example of what a SOAP service binding looks like:
<sca:composite name="orders" targetNamespace="urn:switchyard-quickstart-demo:orders:0.1.0">
<sca:service name="OrderService" promote="OrderService">
<soap:binding.soap>
<soap:wsdl>wsdl/OrderService.wsdl</soap:wsdl>
<soap:socketAddr>:9000</soap:socketAddr>
</soap:binding.soap>
</sca:service>
</sca:composite>
Binding References with SOAP
Binding a reference with SOAP can be used to make SOAP-based web services available to SwitchYard services. The following configuration options are available for binding.soap when binding references:
-
wsdl : location of the WSDL used to describe the web service endpoint. A relative path can be used if the WSDL is included in the deployed application. If the WSDL is located outside the application, then a file: or http: URL can be used.
-
wsdlPort : port name in the WSDL to use. If unspecified, the first port definition in the WSDL is used for the service endpoint.
-
endpointAddress : the SOAP endpoint address to override from that specified in the WSDL. Optional property, if not specified will use the one specified in the WSDL.
<sca:composite name="orders" targetNamespace="urn:switchyard-quickstart-demo:orders:0.1.0">
<sca:reference name="WarehouseService" promote="OrderComponent/WarehouseService" multiplicity="1..1">
<soap:binding.soap>
<soap:wsdl>wsdl/OrderService.wsdl</soap:wsdl>
<soap:endpointAddress>http://www.change.com/toanewendpointurl</soap:endpointAddress>
</soap:binding.soap>
</sca:reference>
</sca:composite>
Security
UsernameToken Support
To enable WS-Security within your application, a few steps are required:
-
Define a Policy within your WSDL, and reference with with a PolicyReference inside your binding.
-
Configure your <soap.binding> with a <securityAction so JBossWS-CXF knows which tokens to respect within incoming SOAP requests.
-
Include a WEB-INF/jboss-web.xml in your application with a <security-domain> specified, so JBossWS-CXF (who, in the case of WS-Security, is doing the JAAS login "at the front door") knows which modules to use for authentication and roles mapping.
SwitchYard provides a policy-security-wss-username Quickstart as an example. Here are the pertinent sections:
META-INF/WorkService.wsdl
<binding name="WorkServiceBinding" type="tns:WorkService">
<wsp:PolicyReference URI="#WorkServicePolicy"/>
...
</binding>
<wsp:Policy wsu:Id="WorkServicePolicy">
<wsp:ExactlyOne>
<wsp:All>
<sp:SupportingTokens xmlns:sp="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702">
<wsp:Policy>
<sp:UsernameToken sp:IncludeToken="http://docs.oasis-open.org/ws-sx/ws-securitypolicy/200702/IncludeToken/AlwaysToRecipient">
<wsp:Policy>
<sp:WssUsernameToken10/>
</wsp:Policy>
</sp:UsernameToken>
</wsp:Policy>
</sp:SupportingTokens>
</wsp:All>
</wsp:ExactlyOne>
</wsp:Policy>
META-INF/switchyard.xml
<binding.soap xmlns="urn:switchyard-component-soap:config:1.0">
<wsdl>META-INF/WorkService.wsdl</wsdl>
<contextPath>policy-security-wss-username</contextPath>
<securityAction>UsernameToken</securityAction>
</binding.soap>
WEB-INF/jboss-web.xml
<jboss-web>
<security-domain>java:/jaas/other</security-domain>
</jboss-web>
With the above pieces in place, JBossWS-CXF will intercept incoming SOAP requests, extract the UsernameToken, attempt to authenticate it against the LoginModule(s) configured in the application server's "other" security domain, and provide any authorized roles. If successful, the request will be handed over to SwitchYard, who can do further processing, including enforcing our own policies. In the case of WS-Security, SwitchYard will not attempt a second clientAuthentication, but instead will respect the outcome from JBossWS-CXF. Note that if the original clientAuthentication fails, it is a "fail-fast" scenario, and the request will not be channeled into SwitchYard.
Signature and Encryption Support
In the current release, support for WS-Security Signature and Encryption requires additional, manual steps. The next release will streamline the process significantly.
-
The Policy in your WSDL needs to reflect the added requirements. An example of this can be found in the JBossWS documentation here: Signature and Encryption.
-
Manual addition of a CXF InInterceptor which sets certain CXF security properties is currently required.
Accomplishing that last point can be done like this:
META-INF/switchyard.xml
<binding.soap xmlns="urn:switchyard-component-soap:config:1.0">
<wsdl>META-INF/WorkService.wsdl</wsdl>
<contextPath>policy-security-wss-username</contextPath>
<inInterceptors>
<interceptor class="com.example.MyInterceptor"/>
</inInterceptors>
</binding.soap>
com/example/MyInterceptor.java
public class MyInterceptor extends WSS4JInterceptor {
private static final PROPS;
static {
Map<String,String> props = new HashMap<String,String>();
props.put("action", "Signature Encryption");
props.put("signaturePropFile", "META-INF/bob.properties");
props.put("decryptionPropFile", "META-INF/bob.properties");
props.put("passwordCallbackClass", "com.example.MyCallbackHandler");
PROPS = props;
}
public MyInterceptor() {
super(PROPS);
}
}
META-INF/bob.properties
org.apache.ws.security.crypto.provider=org.apache.ws.security.components.crypto.Merlin
org.apache.ws.security.crypto.merlin.keystore.type=jks
org.apache.ws.security.crypto.merlin.keystore.password=password
org.apache.ws.security.crypto.merlin.keystore.alias=bob
org.apache.ws.security.crypto.merlin.file=META-INF/bob.jks
HTTP
The HTTP component in SwitchYard provides HTTP-based binding support for services and references in SwitchYard.
Binding Services with HTTP
Composite-level services can be exposed as a HTTP-based service using the <binding.http> binding definition. The following configuration options are available for binding.rest when binding services:
Here's an example of what a HTTP service binding looks like:
<sca:service name="QuoteService" promote="StockService/QuoteService">
<http:binding.http>
<selector:operationSelector operationName="getPrice"/>
<http:contextPath>http-binding/quote</http:contextPath>
</http:binding.http>
</sca:service>
Binding References with HTTP
Binding a reference with HTTP can be used to make HTTP-based services available to SwitchYard services. The following configuration options are available for binding.http when binding references:
-
address : A URL that points to the HTTP endpoint. It is optional and if not specified will default to http://127.0.0.1:8080/.
-
method : The HTTP method used for invoking the endpoint. Default is GET.
-
contentType : The HTTP Content-Type header that needs to be set on the request.
Here's an example of what a REST reference binding looks like:
<sca:reference name="Symbol" promote="StockService/SymbolService" multiplicity="1..1">
<http:binding.http>
<http:address>http://localhost:8080/http-binding/symbol</http:address>
<http:method>POST</http:method>
<http:contentType>text/plain</http:contentType>
</http:binding.http>
</sca:reference>
RESTEasy
The RESTEasy component in SwitchYard provides REST-based binding support for services and references in SwitchYard.
Binding Services with RESTEasy
Composite-level services can be exposed as a REST-based service using the <binding.rest> binding definition. The following configuration options are available for binding.rest when binding services:
Here's an example of what a REST service binding looks like:
<sca:service name="OrderService" promote="OrderService/OrderService">
<rest:binding.rest>
<rest:interfaces>org.switchyard.quickstarts.rest.binding.OrderResource,org.switchyard.quickstarts.rest.binding.TestResource</rest:interfaces>
<rest:contextPath>rest-binding</rest:contextPath>
</rest:binding.rest>
</sca:service>
Binding References with RESTEasy
Binding a reference with REST can be used to make REST-based services available to SwitchYard services. The following configuration options are available for binding.rest when binding references:
-
interfaces : A comma seperated list of interfaces or abstract/empty classes with JAX-RS annotations.
-
address : A URL that points to the root path of resources. This is only applicable for Reference bindings. It is optional and if not specified will default to http://127.0.0.1:8080/.
-
contextPath : Additional context path for the REST endpoint. Default is none.
Here's an example of what a REST reference binding looks like:
<sca:reference name="Warehouse" promote="OrderService/Warehouse" multiplicity="1..1">
<rest:binding.rest>
<rest:interfaces>org.switchyard.quickstarts.rest.binding.WarehouseResource</rest:interfaces>
<rest:address>http://localhost:8080</rest:address>
<rest:contextPath>rest-binding</rest:contextPath>
</rest:binding.rest>
</sca:reference>
In this example above the resource URLs will start from http://localhost:8080/rest-binding.
JCA
The JCA gateway allows you to send and receive messages to/from EIS via JCA ResourceAdapter.
Binding Services with JCA message inflow
Composite-level services can be bound to a EIS with JCA message inflow using the <binding.jca> binding definition. The following configuration options are required for binding.jca:
Here's an example of what a JCA service binding looks like. This example binds a service to the HornetQ JMS:
<sca:composite name="JCAInflowExample" targetNamespace="urn:userguide:jca-example-service:0.1.0">
<sca:service name="JCAService" promote="SomeService">
<jca:binding.jca>
<selector:operationSelector operationName="onMessage"/>
<jca:inboundConnection>
<jca:resourceAdapter name="hornetq-ra.rar"/>
<jca:activationSpec>
<jca:property name="destinationType" value="javax.jms.Queue"/>
<jca:property name="destination" value="ServiceQueue"/>
</jca:activationSpec>
</jca:inboundConnection>
<jca:inboundInteraction>
<jca:listener>javax.jms.MessageListener</jca:listener>
<jca:endpoint type="org.switchyard.component.jca.endpoint.JMSEndpoint"/>
<jca:transacted>true</jca:transacted>
<jca:batchCommit batchSize="10" batchTimeout="5000"/>
</jca:inboundInteraction>
</jca:binding.jca>
</service>
<!-- sca:component definition omitted -->
</sca:composite>
Binding References with JCA outbound
Composite-level references can be bound to a EIS with JCA outbound using the <binding.jca> binding definition. The following configuration options are required for binding.jca:
-
outboundConnection
-
resourceAdapter
-
connection
-
outboundInteraction
-
connectionSpec : Configuration for javax.resource.cci.ConnectionSpec. Note that JMSProcessor doesn't use this option.
-
interactionSpec : Configuration for _javax.resource.cci.InteractionSpec. _Note that JMSProcessor doesn't use this option.
-
processor
-
@type : FQN of the class which processes outbound delivery. There are 2 build-in processor, org.switchyard.component.jca.processor.JMSProcessor and org.switchyard.component.jca.processor.CCIProcessor. If neither JMSProcessor nor CCIProcessor is applicable for the EIS you're supposed to bind to, then you need to implement its own processor class according to the ResourceAdapter implementation. Note that this class should be a subclass of org.switchyard.component.jca.processor.AbstractOutboundProcessor.
-
property : Properties to be injected into processor instance. JMSProcessor needs destination property to specify target destination. CCIProcessor needs recordClassName property to specify record type to be used to interact with EIS. If you use CCIProcessor with the record type other than MappedRecord and IndexedRecord, you need to implement corresponding RecordHandler. Please refer to org.switchyard.component.jca.processor.cci.IndexedRecordHandler and org.switchyard.component.jca.processor.cci.MappedRecordHandler.
Here's an example of what a JCA reference binding looks like. This example binds a reference to the HornetQ JMS:
<sca:composite name="JCAReferenceExample" targetNamespace="urn:userguide:jca-example-reference:0.1.0">
<sca:reference name="JCAReference" promote="SomeComponent/SomeReference" multiplicity="1..1">
<jca:binding.jca>
<jca:outboundConnection>
<jca:resourceAdapter name="hornetq-ra.rar"/>
<jca:connection jndiName="java:/JmsXA"/>
</jca:outboundConnection>
<jca:outboundInteraction>
<jca:processor type="org.switchyard.component.jca.processor.JMSProcessor">
<jca:property name="destination" value="ReferenceQueue"/>
</jca:processor>
</jca:outboundInteraction>
</jca:binding.jca>
</sca:reference>
</sca:composite>
JMS
The JMS binding in SwitchYard provides support for asynchronous communication with messaging providers. It supports both sides - service and reference. The JMS binding is built on top of camel-jms and supports most of options for this endpoint. Please reffer camel documentation for detailed description of them.
Known Limitation
https://issues.jboss.org/browse/SWITCHYARD-1285 - Declarative transaction management by the Transaction Policy doesn't work with camel-jms properly. We are investigating how can we solve it, but you may want to use JCA gateway instead for now.
Generic options
Following options can be apile to <binding.jms> definition:
Binding Services with JMS
Here's an example of what a jms service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.jms>
<camel:queue>INCOMING_GREETS</camel:queue>
<camel:connectionFactory>#connectionFactory</camel:connectionFactory>
<camel:username>esb</camel:username>
<camel:password>rox</camel:password>
<camel:selector>RECEIVER='ESB' AND SENDER='ERP'<camel:selector>
</camel:binding.jms>
</sca:service>
</sca:composite>
Binding References with JMS
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingService" promote="camel-binding/GreetingService" multiplicity="1..1">
<camel:binding.jms>
<camel:topic>GREETINGS_NOTIFICATION</camel:topic>
<camel:connectionFactory>#connectionFactory</camel:connectionFactory>
<camel:priority>8</camel:priority>
<camel:binding.jms>
</sca:reference>
</sca:composite>
File
The file binding in SwitchYard provides filesystem level support for services and references in SwitchYard.
The file binding is built on top of camel-file and supports most of options for this endpoint. Please refer camel documentation for detailed description of them.
Generic options
Following options can be apiled to <binding.file> definition:
-
directory : directory to consume/produce files to
-
autoCreate : automatically create directory if doesn't exist
-
bufferSize : write buffer size
-
fileName : file name filter for consumer or file name pattern for producer
-
flatten : skip path and just use file name
-
charset : charset used for reading/wrinting file
Binding Services with Files
Supported options are:
Here's an example of what a file service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.file>
<camel:directory>target/input</camel:directory>
<camel:fileName>test.txt</camel:fileName>
<camel:consume>
<camel:initialDelay>50</camel:initialDelay>
<camel:delete>true</camel:delete>
</camel:consume>
</camel:binding.file>
</sca:service>
</sca:composite>
Binding References with File
Binding a reference with file can be used to store outcome of service on disk. The following configuration options are available for binding.file when binding references:
-
fileExist
-
tempPrefix
-
tempFileName
-
keepLastModified
-
eagerDeleteTargetFile
-
doneFileName
For detailed description of these parameters please refer camel-file documentation
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingService" promote="camel-binding/GreetingService" multiplicity="1..1">
<camel:binding.file>
<camel:directory>target/output</camel:directory>
<camel:autoCreate>false</camel:autoCreate>
<camel:produce>
<camel:fileExist>Override</camel:fileExist>
</camel:produce>
<camel:binding.file>
</sca:reference>
</sca:composite>
FTP FTPS SFTP
SwitchYard provides support for remote file systems on both sides service and reference.
The ftp binding is built on top of camel-ftp and supports most of options for this endpoint. Please refer camel documentation for detailed description of them.
Generic options
Following options can be apiled to <binding.ftp> <binding.ftps> and <binding.sftp> definition:
FTP specific options
-
passiveMode
-
timeout
-
soTimeout
-
siteCommand
SFTP specific options
-
knownHostsFile
-
privateKeyFile
-
privateKeyFilePassphrase
Binding Services with Files
Supported options are same as for File.
Here's an example of what a file service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.ftp>
<camel:directory>target/input</camel:directory>
<camel:host>localhost</camel:host>
<camel:port>22</camel:port>
<camel:username>camel</camel:username>
<camel:password>secret</camel:password>
<camel:consume>
<camel:initialDelay>50</camel:initialDelay>
<camel:delete>true</camel:delete>
</camel:consume>
</camel:binding.file>
</sca:service>
</sca:composite>
Binding References with File
Binding a reference with file can be used to store outcome of service on remote server. All File referene properties are supported.
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingService" promote="camel-binding/GreetingService" multiplicity="1..1">
<camel:binding.ftp>
<camel:directory>target/output</camel:directory>
<camel:autoCreate>false</camel:autoCreate>
<camel:host>localhost</camel:host>
<camel:port>22</camel:port>
<camel:username>camel</camel:username>
<camel:password>secret</camel:password>
<camel:produce>
<camel:fileExist>Override</camel:fileExist>
</camel:produce>
<camel:binding.ftp>
</sca:reference>
</sca:composite>
TCP UDP
SwitchYard provides support for network level integration with TCP and UPD protocols.
The TCP and UDP binding is built on top of camel-netty and supports most of options for this endpoint. Please refer camel documentation for detailed description of them.
Generic options
Following options can be apiled to <binding.tcp> and <binding.udp definition:
-
host
-
port
-
receiveBufferSize
-
sendBufferSize
-
reuseAddress
-
encoders
-
decoders
-
allowDefaultCodec
-
workerCount
-
sync
-
disconnect
TCP specific options
-
textline
-
tcpNoDelay
-
keepAlive
SSL Options
This endpoint supports SSL. Following parameters may be used to configure it:
-
ssl - turn on SSL
-
sslHandler - custom SSL Handler to use
-
passphrase - bean reference to String instance used to open KeyStore
-
securityProvider - name of Java security provider
-
keyStoreFormat
-
keyStoreFile - reference to File instance which is used loaded into java KeyStore
-
trustStoreFile - reference to File instance
-
sslContextParametersRef - if this parameter is specified it must be an bean reference to an instance of org.apache.camel.util.jsse.SSLContextParameters where you may specify all necessary parameters at once.
Binding Services with tcp/udp
Here's an example of what a file service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.tcp>
<camel:host>localhost</camel:host>
<camel:port>3939</camel:port>
<camel:allowDefaultCodec>false</camel:allowDefaultCodec>
<camel:sync>false</camel:sync>
</camel:binding.tcp>
<camel:binding.udp>
<camel:host>localhost</camel:host>
<camel:port>3940</camel:port>
<camel:allowDefaultCodec>false</camel:allowDefaultCodec>
<camel:sync>false</camel:sync>
</camel:binding.udp>
</sca:service>
</sca:composite>
JPA
The jpa binding in SwitchYard provides support for consuming and storing JPA entities. It supports both sides - service binding for entity consumption and reference for entity storing.
The JPA binding is built on top of camel-jpa and supports most of options for this endpoint. Please reffer camel documentation for detailed description of them.
Generic options
Following options can be apiled to <binding.jpa> definition:
-
entityClassName
-
persistenceUnit
-
transactionManager
Binding Services with JPA
Supported options are:
-
consumeDelete
-
consumeLockEntity
-
maximumResults
-
consumer.query
-
consumer.namedQuery
-
consumer.nativeQuery
-
consumer.resultClass
-
consumer.transacted
The consumeLockEntity option causes problems with transaction management.
Here's an example of what a mail service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.jpa>
<camel:entityClassName>org.switchyard.quickstarts.camel.jpa.binding.domain.Greet</camel:entityClassName>
<camel:persistenceUnit>JpaEvents</camel:persistenceUnit>
<camel:transactionManager>#jtaTransactionManager</camel:transactionManager>
<camel:consume>
<camel:consumeLockEntity>false</camel:consumeLockEntity>
<camel:consumer.transacted>true</camel:consumer.transacted>
</camel:consume>
</camel:binding.jpa>
</sca:service>
</sca:composite>
Binding References with JPA
Binding a reference with jpa can be used to store entity. The following configuration options are available for binding.jpa when binding references:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingService" promote="camel-binding/GreetingService" multiplicity="1..1">
<camel:binding.jpa>
<camel:entityClassName>org.switchyard.quickstarts.camel.jpa.binding.domain.Greet</camel:entityClassName>
<camel:persistenceUnit>JpaEvents</camel:persistenceUnit>
<camel:produce>
<camel:flushOnSend>false</camel:flushOnSend>
</camel:produce>
</camel:binding.jpa>
</sca:reference>
</sca:composite>
SQL
The sql binding in SwitchYard provides database read/write support for references in SwitchYard.
The file binding is built on top of camel-sql.
SQL Binding options
Following options can be apiled to <binding.sql> definition:
-
query : SQL query to execute
-
dataSourceRef : data source name
-
batch : turn on JDBC batching
-
placeholder : a placeholder sign used to replace parameters in query
For detailed description of these parameters please visit camel-sql site.
Binding Services with database
Two additional attributes may be specified for binding.sql element when used with service reference:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.sql period="10s">
<camel:query>SELECT * FROM greetings</camel:query>
<camel:dataSourceRef>java:jboss/datasources/GreetDS</camel:dataSourceRef>
</camel:binding.sql>
</sca:service>
</sca:composite>
Binding References with database
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingDatabaseStore" promote="camel-binding/GreetingDatabaseStore" multiplicity="1..1">
<camel:binding.sql>
<camel:query>INSERT INTO greetings (name) VALUES (#)</camel:query>
<camel:dataSourceRef>java:jboss/datasources/GreetDS</camel:dataSourceRef>
<camel:binding.sql>
</sca:reference>
</sca:composite>
Mail
The mail binding in SwitchYard provides support for consuming and sending mail messages. It supports both sides - service binding for mail consumption and reference for message sending.
The Mail binding is built on top of camel-mail and supports most of options for this endpoint. Please reffer camel documentation for detailed description of them.
Generic options
Following options can be apiled to <binding.mail> definition:
Binding Services with Mail
Supported options are:
Here's an example of what a mail service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.mail>
<camel:host>localhost</camel:host>
<camel:username>camel</camel:username>
<camel:consume accountType="pop3">
<camel:copyTo>after-processing</camel:copyTo>
</camel:consume>
</camel:binding.mail>
</sca:service>
</sca:composite>
Binding References with Mail
Binding a reference with mail can be used to send outgoing message. The following configuration options are available for binding.mail when binding references:
-
subject
-
from
-
to
-
CC
-
BCC
-
replyTo
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:reference name="GreetingService" promote="camel-binding/GreetingService" multiplicity="1..1">
<camel:binding.mail>
<camel:host>localhost</camel:host>
<camel:username>camel</camel:username>
<camel:produce>
<camel:subject>Forwarded message</camel:subject>
<camel:from>camel@localhost</camel:from>
<camel:to>rider@camel</camel:to>
</camel:produce>
</camel:binding.mail>
</sca:reference>
</sca:composite>
Quartz
The quartz binding in SwitchYard provides support for triggering services with given cron expression.
The quartz binding is built on top of camel-quartz.
Generic options
Following options can be apile to <binding.quartz> definition:
Binding Services with Quartz
Here's an example of what a quartz service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.quartz>
<camel:name>GreetingJob</camel:name>
<camel:cron>0 0/5 * * * ?</camel:cron>
</camel:binding.quartz>
</sca:service>
</sca:composite>
Timer
The timer binding in SwitchYard provides support for triggering services with fixed timer. It's lightweight alternative for Quartz.
The file binding is built on top of camel-timer. Please refer camel documentation for detailed description of options.
Generic options
Following options can be apiled to <binding.timer> definition:
-
name : name of timer
-
time
-
pattern
-
period
-
delay
-
fixedRate
-
daemon
Binding Services with Timer
Here's an example of what a timer service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.timer>
<camel:name>GreetingTimer</camel:name>
<camel:time>2012-01-01T12:00:00</camel:time>
<camel:pattern>yyyy-MM-dd'T'HH:mm:ss</camel:pattern>
<camel:delay>1000</camel:delay>
<camel:fixedRate>true</camel:fixedRate>
</camel:binding.timer>
</sca:service>
</sca:composite>
SEDA
The SEDA binding in SwitchYard provides asynchronous service binding between camel route and SwitchYard service.
SEDA queue is not persistent.
This binding is built on top of camel-seda. Please refer camel documentation for detailed description of options.
Generic options
Following options can be apiled to <binding.seda> definition:
Binding Services with SEDA
Here's an example of what a SEDA service binding looks like:
<sca:composite name="camel-binding" targetNamespace="urn:switchyard-quickstart:camel-binding:0.1.0">
<sca:service name="GreetingService" promote="GreetingService">
<camel:binding.seda>
<camel:name>GreetingQueue</camel:name>
<camel:size>6</camel:size>
<camel:concurrentConsumers>2</camel:concurrentConsumers>
</camel:binding.seda>
</sca:service>
</sca:composite>
Camel URI
Camel binding support in SwitchYard allows Camel components to be used as gateway bindings for services and references within an application.
Binding Services with Camel
Every camel component binding supported by SwitchYard has it's own configuration namespace. However, there is asmall exception. Bindings for direct, seda, timer and mock share same namespace urn:switchyard-component-camel-core:config:1.0.
Composite-level services can be bound to a Camel component using the <binding.uri> binding definition. The following configuration options are available for binding.uri:
-
configURI : contains the Camel endpoint URI used to configure a Camel component instance
-
operationSelector : specification of the operation to use for the message exchange. See Operation Selector for more details. This setting is not used for cxfrs configurations.
binding.uri is not linked with any specific component. It allows usage of 3rd party camel components which are not part of distribution.
Before SwitchYard 0.7 binding.camel element was used instead of binding.uri
Here's an example of what a service binding looks like using a Camel component.
<sca:composite name="SimpleCamelService" targetNamespace="urn:userguide:simple-camel-service:0.1.0">
<sca:service name="SimpleCamelService" promote="SimpleComponent/SimpleCamelService">
<camel:binding.uri configURI="file://target/input?fileName=test.txt&initialDelay=50&delete=true">
<selector:operationSelector operationName="print"/>
</camel:binding.uri>
</sca:service>
<!-- sca:component definition omitted -->
</sca:composite>
Binding References with Camel
Binding a reference with Camel is very similar to binding a service. The only significant difference is that specification of the operationSelector is not required on reference bindings. Logically reference elements points to outgoing communication eg. service called by Switchyard.
<sca:composite name="orders" targetNamespace="urn:switchyard-quickstart-demo:orders:0.1.0">
<sca:reference name="WarehouseService" promote="OrderComponent/WarehouseService" multiplicity="1..1">
<camel:binding.uri configURI="file://target/output"/>
</sca:reference>
</sca:composite>