...
Remark : The ORM uses to persist the information is Hibernate but it can be changed to another existing like iBatis, Apache OpenJPA, ...
Code Block | ||||
---|---|---|---|---|
| ||||
<hibernate-mapping schema="REPORT"> <class name="org.apache.camel.example.reportincident.model.Incident" table="T_INCIDENT"> <meta attribute="extends">Abstract</meta> <id name="incidentId" column="INCIDENT_ID" type="long"> <generator class="native" /> </id> <property column="INCIDENT_REF" name="incidentRef" length="55" type="string" /> <property column="INCIDENT_DATE" lazy="false" length="8" name="incidentDate" type="timestamp" /> <property column="GIVEN_NAME" length="35" name="givenName" type="string" /> <property column="FAMILY_NAME" length="35" name="familyName" type="string" /> <property column="SUMMARY" length="35" name="summary" type="string" /> <property column="DETAILS" length="255" name="details" type="string" /> <property column="EMAIL" length="60" name="email" type="string" /> <property column="PHONE" length="35" name="phone" type="string" /> <property column="CREATION_DATE" generated="never" lazy="false" name="creationDate" type="timestamp" /> <property column="CREATION_USER" generated="never" lazy="false" name="creationUser" type="string" /> </class> </hibernate-mapping> |
...
Here is the content of the hibernate.cfg.xml that you must create in the folder src/config
of hibernate.db
Code Block | ||||
---|---|---|---|---|
| ||||
<!-- MySQL DB --> <hibernate-configuration> <session-factory name="reportincident"> <property name="hibernate.connection.driver_class">com.mysql.jdbc.Driver</property> <property name="hibernate.connection.url">jdbc:mysql:///report</property> <property name="hibernate.connection.username">root</property> <property name="hibernate.dialect">org.hibernate.dialect.MySQL5Dialect</property> <property name="hibernate.connection.password" /> <property name="hibernate.show_sql">true</property> <!-- mapping files --> <mapping resource="META-INF/org/apache/camel/example/reportincident/model/Incident.hbm.xml"/> </session-factory> </hibernate-configuration> |
The pom.xml file of your reportincident.db project must be modified like this :
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.apache.camel.example</groupId> <artifactId>reportincident.db</artifactId> <packaging>jar</packaging> <name>Report Incident DB </name> <version>1.0-SNAPSHOT</version> <dependencies> <dependency> (1) <groupId>org.apache.camel.example</groupId> <artifactId>reportincident.model</artifactId> <version>1.0-SNAPSHOT</version> </dependency> </dependencies> <build> <plugins> <!-- Hibernate plugin --> <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>hibernate3-maven-plugin</artifactId> <version>2.2</version> <configuration> <components> <component> <name>hbm2ddl</name> </component> </components> <componentProperties> <drop>true</drop> <create>true</create> <format>true</format> <configurationfile>/src/config/hibernate.cfg.xml</configurationfile> <outputfilename>db_reportincident_create_hsqldb.sql</outputfilename> </componentProperties> </configuration> <dependencies> <dependency> (2) <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.6</version> </dependency> </dependencies> <executions> <execution> <phase>process-classes</phase> <goals> <goal>hbm2ddl</goal> </goals> </execution> </executions> </plugin> </plugins> </build> </project> |
Remarks :
(1) - Dependency with reportincident.model project must be added because the plugin requires the file Incident.hbm.xml
to generate the script/db
(2) - If you prefer to use another DB instead of MySql, change the dependency in the pom.xml and hibernate.connection.driver_class and hibernate.connection.url in the cfg file
To create the table + SQL script, simply launch
...
The injection is defined in the file called spring-dao-beans.xml
that you will create in the folder src/main/resources/META-INF/spring
:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> <!-- DAO Declarations --> <bean id="incidentDAO" class="org.apache.camel.example.reportincident.dao.impl.IncidentDAOImpl"> <property name="sessionFactory"> <ref bean="sessionFactory" /> </property> </bean> </beans> |
...
So realize this goal, you will create the file spring-datasource-beans.xml
in the same folder directory with the following information :
Code Block | ||||
---|---|---|---|---|
| ||||
... <!-- Hibernate SessionFactory Definition --> <bean id="sessionFactory" class="org.springframework.orm.hibernate3.LocalSessionFactoryBean"> <property name="mappingLocations"> <list> <value>classpath*:META-INF/org/apache/camel/example/reportincident/model/*.hbm.xml</value> </list> </property> <property name="hibernateProperties"> <props> <prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop> <prop key="hibernate.show_sql">false</prop> <prop key="hibernate.format_sql">true</prop> <prop key="hibernate.cglib.use_reflection_optimizer">true</prop> <prop key="hibernate.jdbc.batch_size">10</prop> <prop key="hibernate.query.factory_class">org.hibernate.hql.classic.ClassicQueryTranslatorFactory</prop> </props> </property> <property name="dataSource"> <ref bean="dataSource" /> </property> ... <!-- DB connection and persistence layer --> <!-- DataSource Definition --> <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="${driverClassName}" /> <property name="url" value="${url}" /> <property name="username" value="${username}" /> <property name="password" value="${password}" /> </bean> |
...
The same remark as explained previously applies here concerning the DAO injection. So, you will create the following file spring-service-beans-dao.xml
in the folder src/main/resources/META-INF/spring
to inject the dependency of the DAO to our service.
Code Block | ||||
---|---|---|---|---|
| ||||
<bean id="incidentServiceTarget" class="org.apache.camel.example.reportincident.service.impl.IncidentServiceImpl"> <property name="incidentDAO"> ... </property> </bean> |
...
To generate the code that our application will use, we will work with following WSDL contract report_incident.wsdl
that you create in the directory src/main/resources/META-INF/wsdl
:
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?> <wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://reportincident.example.camel.apache.org" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://reportincident.example.camel.apache.org"> <!-- Type definitions for input- and output parameters for webservice --> <wsdl:types> <xs:schema targetNamespace="http://reportincident.example.camel.apache.org"> <xs:element name="inputReportIncident"> <xs:complexType name="inputReportIncident"> <xs:sequence> <xs:element type="xs:string" name="incidentId"/> <xs:element type="xs:string" name="incidentDate"/> <xs:element type="xs:string" name="givenName"/> <xs:element type="xs:string" name="familyName"/> <xs:element type="xs:string" name="summary"/> <xs:element type="xs:string" name="details"/> <xs:element type="xs:string" name="email"/> <xs:element type="xs:string" name="phone"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="outputReportIncident"> <xs:complexType name="outputReportIncident"> <xs:sequence> <xs:element type="xs:string" name="code"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> </wsdl:types> <!-- Message definitions for input and output --> <wsdl:message name="inputReportIncident"> <wsdl:part name="in" element="tns:inputReportIncident"/> </wsdl:message> <wsdl:message name="outputReportIncident"> <wsdl:part name="out" element="tns:outputReportIncident"/> </wsdl:message> <!-- Port (interface) definitions --> <wsdl:portType name="ReportIncidentEndpoint"> <wsdl:operation name="ReportIncident"> <wsdl:input message="tns:inputReportIncident"/> <wsdl:output message="tns:outputReportIncident"/> </wsdl:operation> </wsdl:portType> <!-- Port bindings to transports and encoding - HTTP, document literal encoding is used --> <wsdl:binding name="ReportIncidentBinding" type="tns:ReportIncidentEndpoint"> <soap:binding transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="ReportIncident"> <soap:operation soapAction="http://reportincident.example.camel.apache.org/ReportIncident" style="document"/> <wsdl:input> <soap:body parts="in" use="literal"/> </wsdl:input> <wsdl:output> <soap:body parts="out" use="literal"/> </wsdl:output> </wsdl:operation> </wsdl:binding> <!-- Service definition --> <wsdl:service name="ReportIncidentEndpointService"> <wsdl:port name="ReportIncidentPort" binding="tns:ReportIncidentBinding"> <soap:address location="http://localhost:8080/camel-example/incident"/> </wsdl:port> </wsdl:service> </wsdl:definitions> |
...
Add the following line in your pom.xml
of the project reportincident.webservice
Code Block | ||||
---|---|---|---|---|
| ||||
<!-- CXF wsdl2java generator, will plugin to the compile goal --> <plugin> <groupId>org.apache.cxf</groupId> <artifactId>cxf-codegen-plugin</artifactId> <version>${cxf-version}</version> <executions> <execution> <id>generate-sources</id> <phase>generate-sources</phase> <configuration> <sourceRoot>${basedir}/target/generated/src/main/java</sourceRoot> <wsdlOptions> <wsdlOption> <wsdl>${basedir}/src/main/resources/META-INF/wsdl/report_incident.wsdl</wsdl> </wsdlOption> </wsdlOptions> </configuration> <goals> <goal>wsdl2java</goal> </goals> </execution> </executions> </plugin> |
...
It is time now to have a break, to make some sport exercices, to drink a cup of good 'Java' coffee or to go outside of the building to take a walk with your favorite pets.
Links
Routing/Mediation service
The routing/mediation between services/bundles will be created using Camel Spring DSL language. We will describe its creation/genesis step by step.
First, create the file camel-context.xml
in the directory src/main/resources/META-INF/spring
and add the lines :
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:camel="http://camel.apache.org/schema/spring"
xmlns:osgi="http://www.springframework.org/schema/osgi"
xmlns:cxf="http://camel.apache.org/schema/cxf"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/osgi
http://www.springframework.org/schema/osgi/spring-osgi.xsd
http://camel.apache.org/schema/osgi
http://camel.apache.org/schema/osgi/camel-osgi.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd
http://camel.apache.org/schema/cxf
http://camel.apache.org/schema/cxf/camel-cxf.xsd">
</beans>
|
Compare to a simple camel project, the spring beans tag has been enriched with new namespaces :
- spring-osgi (http://www.springframework.org/schema/osgi
) which is used by OSGI blueprint services
- camel-osgi (http://camel.apache.org/schema/osgi
) who will allow to integrate camel with OSGI world
- cxf (http://camel.apache.org/schema/cxf
) to integrate CXF architecture with Camel
Now, that the schema/namespaces are declared, we can start to add addtional stuffs like import resources, beans reference, ... that our routing engine will use.
1) Webservice infrastructure : CXF
We will use the CXF framework to deploy the reportincident webservice and run it into the OSGI platform.
To work with it, resources (= spring beans) declared in CXF project must be imported using the statement import resource
.
Code Block | ||||
---|---|---|---|---|
| ||||
...
<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-http.xml" />
<import resource="classpath:META-INF/cxf/osgi/cxf-extension-osgi.xml" />
...
|
These imports will be used by spring at the bundle startup to instantiate the beans defined in these files. These beans are responsible in fact to deploy the architecture of the CXF bus top of the OSGI server and to provide a servlet that we will use to communicate with webservices engine of CXF.
Remark : for the purpose of this tutorial, we have packaged this configuration into the camel-spring file but it could be defined in a separate xml file with by example the component bean that Camel will use to communicate with CXF bus. This allows you to separate routing from parameters to be provided to configure endpoints.
The camel CXF endpoint is configurated like this :
Code Block | ||||
---|---|---|---|---|
| ||||
...
<!-- webservice endpoint -->
<cxf:cxfEndpoint id="reportIncident"
address="/camel-example/incident" (1)
serviceClass="org.apache.camel.example.reportincident.ReportIncidentEndpoint" (2)
xmlns:s="http://reportincident.example.camel.apache.org"> (3)
</cxf:cxfEndpoint>
...
|
Remarks :
(1) - the address corresponds to the URI address of the web services,
(2) - the serviceClass is the name of the class used work with the webservices and deployed in the bundle reportincident.webservice
(3) - xmlns:s is the namespace of the reportincident webservice (see reportincident.webservice)
2) Queuing engine
No matter if the incidents come from a webservice or a files but before to process and save them in the database, we will put
our messages in a queue. The queue manager used here is ActiveMQ.
Like CXF, we will use spring xml file to deploy ActiveMq into the server and configure it. This will be done in two steps
a) ActiveMQ
Like CXF, ActiveMq can be installed in the infrastructure using a spring.xml configuration file. So, create the file activemq-broker.xml
in the directory src/main/resources/META-INF/spring
and add the following lines.
Code Block | ||||
---|---|---|---|---|
| ||||
<beans
xmlns="http://www.springframework.org/schema/beans"
xmlns:amq="http://activemq.apache.org/schema/core"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:osgi="http://www.springframework.org/schema/osgi"
xsi:schemaLocation="
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://activemq.apache.org/schema/core
http://activemq.apache.org/schema/core/activemq-core.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd
http://www.springframework.org/schema/osgi
http://www.springframework.org/schema/osgi/spring-osgi.xsd">
<!-- Allows us to use system properties as variables in this configuration file -->
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/>
<broker xmlns="http://activemq.apache.org/schema/core" brokerName="default" dataDirectory="${servicemix.base}/data/activemq/default" useShutdownHook="false">
<!-- Destination specific policies using destination names or wildcards -->
<destinationPolicy>
<policyMap>
<policyEntries>
<policyEntry queue=">" memoryLimit="5mb"/>
<policyEntry topic=">" memoryLimit="5mb">
<subscriptionRecoveryPolicy>
<lastImageSubscriptionRecoveryPolicy/>
</subscriptionRecoveryPolicy>
</policyEntry>
</policyEntries>
</policyMap>
</destinationPolicy>
<!-- Use the following to configure how ActiveMQ is exposed in JMX -->
<managementContext>
<managementContext createConnector="false"/>
</managementContext>
<!-- The store and forward broker networks ActiveMQ will listen to -->
<networkConnectors>
<!-- by default just auto discover the other brokers -->
<networkConnector name="default-nc" uri="multicast://default"/>
<!-- Example of a static configuration:
<networkConnector name="host1 and host2" uri="static://(tcp://host1:61616,tcp://host2:61616)"/>
-->
</networkConnectors>
<persistenceAdapter>
<amqPersistenceAdapter syncOnWrite="false" directory="${servicemix.base}/data/activemq/default" maxFileLength="20 mb"/>
</persistenceAdapter>
<!-- Use the following if you wish to configure the journal with JDBC -->
<!--
<persistenceAdapter>
<journaledJDBC dataDirectory="${activemq.base}/data" dataSource="#postgres-ds"/>
</persistenceAdapter>
-->
<!-- Or if you want to use pure JDBC without a journal -->
<!--
<persistenceAdapter>
<jdbcPersistenceAdapter dataSource="#postgres-ds"/>
</persistenceAdapter>
-->
<!-- The maximum about of space the broker will use before slowing down producers -->
<systemUsage>
<systemUsage>
<memoryUsage>
<memoryUsage limit="20 mb"/>
</memoryUsage>
<storeUsage>
<storeUsage limit="1 gb" name="foo"/>
</storeUsage>
<tempUsage>
<tempUsage limit="100 mb"/>
</tempUsage>
</systemUsage>
</systemUsage>
<!-- The transport connectors ActiveMQ will listen to -->
<transportConnectors>
<transportConnector name="openwire" uri="tcp://localhost:61616" discoveryUri="multicast://default"/>
<transportConnector name="stomp" uri="stomp://localhost:61613"/>
</transportConnectors>
</broker>
<bean id="activemqConnectionFactory" class="org.apache.activemq.ActiveMQConnectionFactory">
<property name="brokerURL" value="tcp://localhost:61616" />
</bean>
<bean id="pooledConnectionFactory" class="org.apache.activemq.pool.PooledConnectionFactoryBean">
<property name="maxConnections" value="8" />
<property name="maximumActive" value="500" />
<property name="transactionManager" ref="transactionManager" />
<property name="connectionFactory" ref="activemqConnectionFactory" />
<property name="resourceName" value="activemq.default" />
</bean>
<bean id="resourceManager" class="org.apache.activemq.pool.ActiveMQResourceManager" init-method="recoverResource">
<property name="transactionManager" ref="transactionManager" />
<property name="connectionFactory" ref="activemqConnectionFactory" />
<property name="resourceName" value="activemq.default" />
</bean>
<osgi:reference id="transactionManager" interface="javax.transaction.TransactionManager" />
<osgi:service ref="pooledConnectionFactory">
<osgi:interfaces>
<value>javax.jms.ConnectionFactory</value>
</osgi:interfaces>
<osgi:service-properties>
<entry key="name" value="default"/>
</osgi:service-properties>
</osgi:service>
</beans>
|
At the bundle startup, Spring will instantiate the beans declared and in consequence start the queuing engine. We haven't changed the content of the file corresponding to what is proposed in the ServiceMix distribution but you can use here the same technique described for the Datasource and add properties that you configure through by example a org.apache.activemq.config.etc
file.
Code Block | ||||
---|---|---|---|---|
| ||||
...
<transportConnectors>
<transportConnector name="${name}" uri="${uri}" discoveryUri="${discoveryUri}"/>
</transportConnectors>
<!-- here is the list of values defined as default but can be overidded in the file org.apache.activemq.config.etc -->
<osgix:cm-properties id="confs" persistent-id="org.apache.activemq.config.etc">
<prop key="name">openwire</prop>
<prop key="uri">tcp://localhost:61616</prop>
<prop key="discoveryUri">multicast://default</prop>
</osgix:cm-properties>
...
|
Tip |
---|
The activeMq broker can also be integrated differently because the ServiceMix4 distribution (and not ServiceMix Kernel) proposes it in standard with additional commands that you can use from the console to : Available commands in activemq: |
The pom.xml file must be modified to add properties required by Spring blueprint. So add the following lines :
Code Block | ||||
---|---|---|---|---|
| ||||
...
<instructions>
<Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName>
<DynamicImport-Package>*</DynamicImport-Package>
<Include-Resource>src/main/resources</Include-Resource> (1)
<Spring-Context>*;publish-context:=false;create-asynchronously:=true</Spring-Context> (2)
<Private-Package></Private-Package>
<Import-Package> (3)
javax.transaction,
org.apache.activemq,
org.apache.activemq.pool,
org.springframework.beans.factory.config,
*
</Import-Package>
</instructions>
...
|
Remarks :
(1) - Include-Resource will allow to add to the jar generated the spring files of the directory src/main/resources/META-INF/spring
(2) - The Spring-Context tag allows to provide specific information used by Spring blueprint service to load the application context and how to load it. The asterisk means that all the spring xml files will be processed
(3) - The list of classes to be used is dependent of the queue engine use as implementation. This list must be reviewed when switching from ActiveMq to IBM WebSphere MQ, Tibco, ...
b) Camel ActiveMq component
To makes Camel independent of the JMS queue engine deployed in the OSGI server, we will implement a proxy using blueprint service between Camel component and the queuing engine used (Apache ActiveMq, IBM Websphere MQ, Oracle Advance Queue, TIBCO, ...)
First, create a spring DSL file osgi-queuingservice.xml
in the directory {{src/main/resources/META-INF-spring}}directory containing the following information :
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:osgi="http://www.springframework.org/schema/osgi"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/osgi
http://www.springframework.org/schema/osgi/spring-osgi.xsd
http://camel.apache.org/schema/spring
http://camel.apache.org/schema/spring/camel-spring.xsd">
<bean id="active-mq" class="org.apache.activemq.camel.component.ActiveMQComponent" /> (1)
<osgi:service id="osgiqueuingservice" ref="active-mq" interface="org.apache.camel.Component"/> (2)
</beans>
|
Remarks:
(1) Spring will instantiate the ActiveMqComponent to work with the ActiveMq server. If you would like to use another JMS component, then switch this class to org.apache.camel.component.jms.JmsComponent
(2) Our camel component will be exposed on the OSGI registry as an org.apache.camel.Component
and has a reference to the ActiveMQComponent, JMSComponent
Next adapt the POM.xml file like this to instruct the felix plugin how to generate the MANIFEST.MF file
Code Block | ||||
---|---|---|---|---|
| ||||
...
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<version>${felix-version}</version>
<configuration>
<manifestLocation>META-INF</manifestLocation>
<instructions>
<Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName>
<Import-Package>
org.apache.activemq.camel.component,
org.apache.camel,
*</Import-Package>
<Include-Resource>src/main/resources</Include-Resource>
<Spring-Context>*;publish-context:=false;create-asynchronously:=true</Spring-Context>
<Private-Package></Private-Package>
</instructions>
</configuration>
</plugin>
...
|
Remark that we import here the org.apache.activemq.camel.component
class and not the ActiveMQComponent
java class.
All the infrastructure is in place, so we can start to describe the beans that we will use
3) Beans reference
5 beans will be used by our application :
- BindyCsvDataFormat : to generate the model, marshall (= parse a CSV file in to incidents objects) or unmarshall (= create a CSV file from incidents objects)
- IncidentSaver : proxy service who will extract from the body of the message the Incidents objects and call the reportinicident.Service bundle to save in the DB the incidents
- WebService : service who will receive messages from WebServices, extract them from the body message and transform them into Incident objects
- Feedback : simple class who will send a message back to the webservice
So, adapt the camel-context.xml
file :
Code Block | ||||
---|---|---|---|---|
| ||||
<bean id="bindyDataformat" class="org.apache.camel.dataformat.bindy.csv.BindyCsvDataFormat">
<constructor-arg type="java.lang.String" value="org.apache.camel.example.reportincident.model" /> (1)
</bean>
<bean id="incidentSaver" class="org.apache.camel.example.reportincident.internal.IncidentSaver">
<property name="incidentService">
<osgi:reference interface="org.apache.camel.example.reportincident.service.IncidentService"/> (2)
</property>
</bean>
<bean id="webservice" class="org.apache.camel.example.reportincident.internal.WebService" />
<bean id="feedback" class="org.apache.camel.example.reportincident.internal.Feedback" />
<osgi:reference id="queuingservice" interface="org.apache.camel.Component" /> (3)
|
Remarks :
(1) - The name of the package containing the class of the model must be provided as parameter
(2) - We inject into our proxy service using OSGI service reference, the interface IncidentService
(3) - We need also an OSGI service reference to the queue engine using the interface org.apache.camel.Component
We will quickly review the three classes that we will created for our project in the directory org.apache.camel.example.reportincident.internal
:
a) IncidentSaver
Code Block |
---|
package org.apache.camel.example.reportincident.internal;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.camel.Exchange;
import org.apache.camel.example.reportincident.model.Incident;
import org.apache.camel.example.reportincident.service.IncidentService;
public class IncidentSaver {
private static final transient Log LOG = LogFactory.getLog(IncidentSaver.class);
private IncidentService incidentService = null;
public void process(Exchange exchange) throws ParseException {
int count = 0;
List<Map<String, Object>> models = new ArrayList<Map<String, Object>>(); (1)
Map<String, Object> model = new HashMap<String, Object>();
// Get models from message
models = (List<Map<String, Object>>) exchange.getIn().getBody(); (2)
// Get Header origin from message
String origin = (String) exchange.getIn().getHeader("origin"); (3)
LOG.debug("Header origin : " + origin);
Iterator<Map<String, Object>> it = models.iterator();
// Specify current Date
DateFormat format = new SimpleDateFormat( "dd/MM/yyyy HH:mm:ss" );
String currentDate = format.format( new Date() );
Date creationDate = format.parse( currentDate );
while (it.hasNext()) {
model = it.next();
LOG.debug("Model retrieved");
for (String key : model.keySet()) {
LOG.debug("Object retrieved : " + model.get(key).toString());
// Retrieve incident from model
Incident incident = (Incident) model.get(key); (4)
incident.setCreationDate(creationDate);
incident.setCreationUser(origin);
LOG.debug("Count : " + count + ", " + incident.toString());
// Save Incident
incidentService.saveIncident(incident); (5)
LOG.debug("Incident saved");
}
count++;
}
LOG.debug("Nber of CSV records received by the csv bean : " + count);
}
// Property used to inject service implementation (6)
public void setIncidentService(IncidentService incidentService) {
this.incidentService = incidentService;
}
}
|
Remarks :
(1) - We instantiate List and Map classes that we will use to extract objects of our incident model
(2) - Using the method exchange.getIn().getBody()
, we extract the objects from the message and put them in a List
(3) - We get the Header field ('Origin') to check the origin of the messages (file). This info will be persisted in the DB
(4) - The object incident is retrieved from the Map model. In our case, the key is unique because we have only created one model class
(5) - The incident is saved in the database by calling the OSGI service IncidentService.saveIncident
(6) - The field setIncidentService
is used by Spring to inject dependency with OSGI service
b) WebService
Code Block |
---|
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.example.reportincident.internal;
import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.camel.Exchange;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.camel.example.reportincident.InputReportIncident;
import org.apache.camel.example.reportincident.model.Incident;
public class WebService {
private static final transient Log LOG = LogFactory.getLog(WebService.class);
public void process(Exchange exchange) throws ParseException {
InputReportIncident webincident = (InputReportIncident)exchange.getIn().getBody(); (1)
LOG.debug("Incident received from : " + webincident.getFamilyName() + ", " + webincident.getGivenName());
LOG.debug("Incident info : " + webincident.getIncidentId() + ", at : " + webincident.getIncidentDate());
LOG.debug("Incident details : " + webincident.getDetails() + ", summary : " + webincident.getSummary());
List<Map<String, Incident>> models = new ArrayList<Map<String, Incident>>();
Map<String, Incident> model = new HashMap<String, Incident>();
// Convert the InputReportIncident into an Incident
Incident incident = new Incident(); (2)
DateFormat format = new SimpleDateFormat( "dd-mm-yyyy" );
incident.setIncidentDate(format.parse(webincident.getIncidentDate()));
incident.setDetails(webincident.getDetails());
incident.setEmail(webincident.getEmail());
incident.setFamilyName(webincident.getFamilyName());
incident.setGivenName(webincident.getGivenName());
incident.setIncidentRef(webincident.getIncidentId());
incident.setPhone(webincident.getPhone());
incident.setSummary(webincident.getSummary());
// Get Header origin from message
String origin = (String) exchange.getIn().getHeader("origin"); (3)
// Specify current Date
format = new SimpleDateFormat( "dd/MM/yyyy HH:mm:ss" );
String currentDate = format.format( new Date() );
Date creationDate = format.parse( currentDate );
incident.setCreationDate(creationDate);
incident.setCreationUser(origin);
LOG.debug("Incident created from web service : " + incident.toString());
// and place it in a model (cfr camel-bindy)
model.put(Incident.class.getName(), incident); (4)
models.add(model);
// replace with our input
exchange.getOut().setBody(models); (5)
// propagate the header
exchange.getOut().setHeader("origin", origin); (6)
}
}
|
Remarks :
(1) - The message coming from the WebService and copied in the InputReportIncident
class is retrieved from the body using the method exchange.getIn().getBody()
(2) - We create using the model a class Incident where we will put webservice's InputReportIncident
(3) - We get the Header field ('Origin') to check the origin of the messages (webservice). This info will be persisted in the DB
(4) - The model incident is added to the Map and List objects required by Camel Bindy
(5) - The model is added to the body object of the message that we send it OUT
(6) - Thbe header parameter is also propagated for the next endpoint
c) Feedback
Code Block |
---|
package org.apache.camel.example.reportincident.internal;
import org.apache.camel.example.reportincident.OutputReportIncident;
public class Feedback {
public OutputReportIncident setOk() { (3)
OutputReportIncident outputReportIncident = new OutputReportIncident(); (1)
outputReportIncident.setCode("0"); (2)
return outputReportIncident;
}
}
|
Remarks :
(1) - An OutputReportIncident object is created because it will be used to send the message back to the webservice
(2) - The field/property setCode is setted with the value ("OK")
(3) - The method setOk() will be called by Camel routing
4) Routing
Now that evverything is in place, we can create the three routes that we need to implement the architecture that we have presented in the introduction of this tutorial
From File(s) to queue
Code Block | ||||
---|---|---|---|---|
| ||||
<camelContext trace="true" xmlns="http://camel.apache.org/schema/osgi"> (1)
<camel:route>
<camel:from uri="file://d:/temp/data/?move=d:/temp/done/${file:name}" /> (2)
<camel:setHeader headerName="origin"> (3)
<camel:constant>file</camel:constant>
</camel:setHeader>
<camel:unmarshal ref="bindyDataformat" /> (4)
<camel:to uri="queuingservice:queue:in" /> (5)
</camel:route>
...
|
Remarks :
(1) -
(2) -
(3) -
(4) -
(5) -
From Webservices to queue
Code Block | ||||
---|---|---|---|---|
| ||||
...
<camel:route>
<camel:from uri="cxf:bean:reportIncident" />
<camel:setHeader headerName="origin">
<camel:constant>webservice</camel:constant>
</camel:setHeader>
<camel:convertBodyTo type="org.apache.camel.example.reportincident.InputReportIncident" />
<camel:to uri="bean:webservice" />
<camel:inOnly uri="queuingservice:queue:in" />
<camel:transform>
<camel:method bean="feedback" method="setOk" />
</camel:transform>
</camel:route>
...
|
Remarks :
(1) -
(2) -
(3) -
(4) -
(5) -
From queue to DB
Code Block | ||||
---|---|---|---|---|
| ||||
...
<camel:route>
<camel:from uri="queuingservice:queue:in" />
<camel:to uri="bean:incidentSaver?method=process" />
</camel:route>
</camelContext>
|
Remarks :
(1) -
(2) -
(3) -
(4) -
(5) -
Once that you have finished to configure camel, created your classes, the pom.xml file must be modified :
Code Block | ||||
---|---|---|---|---|
| ||||
...
<instructions>
<Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName>
<Import-Package> (1)
META-INF.cxf,
META-INF.cxf.osgi,
META-INF.wsdl,
org.apache.commons.logging,
org.apache.camel,
org.apache.camel.component,
org.apache.camel.component.cxf,
org.apache.camel.component.cxf.converter,
org.apache.camel.component.jms,
org.apache.camel.converter,
org.apache.camel.converter.jaxp,
org.apache.camel.converter.stream,
org.apache.camel.dataformat.bindy,
org.apache.camel.dataformat.bindy.csv,
org.apache.camel.example.reportincident,
org.apache.camel.example.reportincident.model,
org.apache.camel.example.reportincident.service,
org.apache.camel.processor,
org.apache.activemq.camel.component;${activemq.osgi.version},
org.apache.activemq.camel.converter;${activemq.osgi.version},
org.apache.activemq.pool,
org.apache.cxf,
org.apache.cxf.binding,
org.apache.cxf.binding.corba,
org.apache.cxf.binding.soap,
org.apache.cxf.binding.soap.spring,
org.apache.cxf.bus,
org.apache.cxf.bus.resource,
org.apache.cxf.bus.spring,
org.apache.cxf.buslifecycle,
org.apache.cxf.catalog,
org.apache.cxf.configuration,
org.apache.cxf.configuration.spring,
org.apache.cxf.endpoint,
org.apache.cxf.headers,
org.apache.cxf.management,
org.apache.cxf.management.jmx,
org.apache.cxf.phase,
org.apache.cxf.resource,
org.apache.cxf.transport,
org.apache.cxf.transport.http,
org.apache.cxf.transport.http.policy,
org.apache.cxf.transport.http_jetty,
org.apache.cxf.transport.jms,
org.apache.cxf.transports.http,
org.apache.cxf.workqueue,
org.apache.cxf.wsdl,
org.apache.cxf.wsdl11,
org.apache.servicemix.cxf.transport.http_osgi,
org.springframework.beans.factory.config,
*
</Import-Package>
<Private-Package>org.apache.camel.example.reportincident.internal</Private-Package> (2)
</instructions>
...
|
Remarks :
(1) - Classes required by Camel, CXF muste be imported.
(2) - Our internal classes are declared as private to avoid that they become available for another bundles of the OSGI server
Conclusion
TODO
Links
- Part 1 : simple example
- Part 2a : real example, architecture, project setup, database creation
- Part 2b : transform projects in bundles
- Part 2c : add infrastructure and routing
- Part 2d :
- Part 1 : simple example
- Part 2a : real example, architecture, project setup, database creation
- Part 2b : transform projects in bundles
- Part 2c : add routing, web and deployment
#Resources
Attachments patterns .*part2.zip