Page History

...

Designing a Service Oriented Architecture seems very obvious for most of us but implies that different parameters are taken into account :

• Identification of the layers of the application,
• Definition of the services,
• Granularity (what are the boundaries of a service, ...),
• Dependency with libraries,
• Testing and debugging strategies,
• Deployment procedure,
• Infrastructure

Some of the points mentioned are particular to SOA world like granularity and definition of service boundaries but others are mostly found in all IT projects. This is really important to keep them in your head because they will impact the project life cycle, quality of the deliverable, efficiency of the team and project duration/cost.

In this second part of the tutorial we will investigate some of the points mentioned and applied them to a real application. The application will be designed around different components (= bundles in the OSGI jargon) and deployed into Apache Felix Karaf (now part of Apache ServiceMix 4).

Apache Felix Karaf is a small OSGi based runtime which provides a lightweight container onto which various components and applications can be deployed.

...

Prerequisites

This tutorial uses:

• Maven 2.0.9 to setup the projects,
• Eclipse Ganymede 3.4.x,
• Maven eclipse plugin,
• Apache Felix Karaf 1.4.0,
• Dependencies (= jars) used by the tutorial will be downloaded (if not available locally) by Maven

Note: The sample project can be downloaded, see the resources section.

...

Different way exist to create maven project. For the basic project like db, we have used the archetype 'simple' with the command followed by mvn eclipse:eclipse in the folder created :

 
mvn archetype:creategenerate -DartifactIdDinteractiveMode=simplefalse -DgroupId=org.apache.camel.example -DartifactId=reportincident.model -Dversion=1.0-SNAPSHOT
cd reportincident.db
mvn  -Dgoals=eclipse:eclipse

For the OSGI bundles, different approaches are available depending on the tools that you prefer to use :

• Spring archetype
• Spring bundlor
• PAX maven plugin

But for the purpose of this tutorial, we have used the PAX maven plugin. Why this choice, simply because PAX maven plugin offers a lot of advantages regarding to the one of Spring :

• pom.xml file generated is very simple to use and to understand,
• project can be designed with several modules,
• project can be tested with PAX Exam and launched using PAX runner
• generate all the folders required including also the META-INF,
• manifest file is generated automatically,
• can be imported easily in Eclipse

To create the tutorial projects, you can follow the procedure described here

...

Repeat this procedure for the projects :

• reportincident.activemq
• reportincident.camelqueueservice
• reportincident.persistence
• reportincident.routing
• reportincident.service
• reportincident.web
• reportincident.webservice

otherwise import the content of the unzipped file in your workspace. You will gain time.

...

It is time now to begin serious things. One of the most important part of a project (if not the most important) concerns the design of the model.
The reportincident model is really simple because it only contains one class that we will use :

• to map information with the database, CSV file,
• to transport information to web screens.

Here is the definition of the incident class that you can create in the reportincident.model project directory src/main/java/org/apache/camel/example/reportincident/model or use the code imported

...

import org.apache.camel.dataformat.bindy.annotation.CsvRecord;
import org.apache.camel.dataformat.bindy.annotation.DataField;

@CsvRecord(separator =",")
public class Incident implements Serializable{

    @DataField(pos = 01)
    private String incidentRef;
	
    @DataField(pos = 12, pattern = "dd-mm-yyyy")
    private Date incidentDate;
	
    @DataField(pos = 23)
    private String givenName;
	
    @DataField(pos = 34)
    private String familyName;
	
    @DataField(pos = 45)
    private String summary;

    @DataField(pos = 56)
    private String details;
	
    @DataField(pos = 67)
    private String email;
	
    @DataField(pos = 78)
    private String phone;

...
}

...

<?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<8</version>
					</dependency>
				</dependencies>

				<executions>
					<execution>
						<phase>process-classes</phase>
						<goals>
							<goal>hbm2ddl</goal>
						</goals>
					</execution>
				</executions>

			</plugin>

		</plugins>
	</build>
</project>

...

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

• Part 2 : real example, architecture, project setup, database creation
• Part 2a : transform projects in bundles
• Part 2b : add infrastructure and routing
• Part 2c : web and deployment

#Resources

• Attachments
  patterns .*part2.zip