Merge pull request #12 from ghillert/INTSAMPLES-33

INTSAMPLES-33 Add initial Jdbc sample

basic/jdbc/README.md

@@ -0,0 +1,28 @@
+Spring Integration - JDBC Sample
+================================
+
+# Overview
+
+This sample provides example of how the Jdbc Adapters can be used.
+
+# Getting Started
+
+You can run the application by either
+
+* running the "Main" class from within STS (Right-click on Main class --> Run As --> Java Application)
+* or from the command line:
+    - mvn package
+    - mvn exec:java
+
+Currently one example exists. On the command prompt you can enter the following valid values and get a response back:
+
+* 'a'
+* 'b'
+* 'foo'
+
+# Resources
+
+For help please take a look at the Spring Integration documentation:
+
+http://www.springsource.org/spring-integration
+

basic/jdbc/pom.xml

@@ -0,0 +1,129 @@
+<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/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>org.springframework.integration.samples</groupId>
+    <artifactId>jdbc</artifactId>
+    <version>1.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <name>jdbc-sample</name>
+    <url>http://www.springsource.org/spring-integration</url>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <spring.integration.version>2.1.0.M3</spring.integration.version>
+        <slf4j.version>1.6.1</slf4j.version>
+        <junit.version>4.7</junit.version>
+    </properties>
+
+    <repositories>
+        <repository>
+            <id>repository.springframework.maven.release</id>
+            <name>Spring Framework Maven Release Repository</name>
+            <url>http://maven.springframework.org/release</url>
+        </repository>
+		<repository>
+		    <id>repository.springframework.maven.milestone</id>
+		    <name>Spring Framework Maven Milestone Repository</name>
+		    <url>http://maven.springframework.org/milestone</url>
+		</repository>
+    </repositories>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-eclipse-plugin</artifactId>
+                <version>2.8</version>
+                <configuration>
+                    <additionalProjectnatures>
+                        <projectnature>org.springframework.ide.eclipse.core.springnature</projectnature>
+                    </additionalProjectnatures>
+                    <additionalBuildcommands>
+                        <buildcommand>org.springframework.ide.eclipse.core.springbuilder</buildcommand>
+                    </additionalBuildcommands>
+                    <downloadSources>true</downloadSources>
+                    <downloadJavadocs>true</downloadJavadocs>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>2.3.2</version>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                    <compilerArgument>-Xlint:all</compilerArgument>
+                    <showWarnings>true</showWarnings>
+                    <showDeprecation>true</showDeprecation>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.2</version>
+                <configuration>
+                    <mainClass>org.springframework.integration.samples.jdbc.Main</mainClass>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+
+        <!-- Testing -->
+
+        <dependency>
+            <groupId>junit</groupId>
+            <artifactId>junit</artifactId>
+            <version>${junit.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <!-- Spring Integration -->
+
+        <dependency>
+            <groupId>org.springframework.integration</groupId>
+            <artifactId>spring-integration-core</artifactId>
+            <version>${spring.integration.version}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>org.springframework.integration</groupId>
+            <artifactId>spring-integration-jdbc</artifactId>
+            <version>${spring.integration.version}</version>
+        </dependency>
+
+        <!-- Logging -->
+
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>0.9.28</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>log4j-over-slf4j</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>jcl-over-slf4j</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+
+        <!-- Embedded Database -->
+
+        <dependency>
+	        <groupId>com.h2database</groupId>
+	        <artifactId>h2</artifactId>
+	        <version>1.3.160</version>
+	    </dependency>
+
+    </dependencies>
+</project>

basic/jdbc/src/main/java/org/springframework/integration/samples/jdbc/Main.java

@@ -0,0 +1,97 @@
+/*
+ * Copyright 2002-2010 the original author or authors.
+ *
+ * Licensed 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.springframework.integration.samples.jdbc;
+
+import java.util.Scanner;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.context.support.AbstractApplicationContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+import org.springframework.integration.samples.jdbc.service.UserService;
+
+
+/**
+ * Starts the Spring Context and will initialize the Spring Integration routes.
+ *
+ * @author Gunnar Hillert
+ * @version 1.0
+ *
+ */
+public final class Main {
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(Main.class);
+
+    private Main() { }
+
+    /**
+     * Load the Spring Integration Application Context
+     *
+     * @param args - command line arguments
+     */
+    public static void main(final String... args) {
+
+        LOGGER.info("\n========================================================="
+                  + "\n                                                         "
+                  + "\n          Welcome to Spring Integration!                 "
+                  + "\n                                                         "
+                  + "\n    For more information please visit:                   "
+                  + "\n    http://www.springsource.org/spring-integration       "
+                  + "\n                                                         "
+                  + "\n=========================================================" );
+
+        final AbstractApplicationContext context =
+                new ClassPathXmlApplicationContext("classpath:META-INF/spring/integration/*-context.xml");
+
+        context.registerShutdownHook();
+
+        final Scanner scanner = new Scanner(System.in);
+
+        final UserService service = context.getBean(UserService.class);
+
+        LOGGER.info("\n========================================================="
+                  + "\n                                                         "
+                  + "\n    Please press 'q + Enter' to quit the application.    "
+                  + "\n                                                         "
+                  + "\n=========================================================" );
+
+        System.out.print("Please enter a string and press <enter>: ");
+        while (!scanner.hasNext("q")) {
+
+        	final String input = scanner.nextLine();
+        	final User user = service.findUser(input);
+
+        	if (user != null) {
+
+	        	System.out.println(
+	        			String.format("User found - Username: '%s',  Email: '%s', Password: '%s'",
+	        			              user.getUsername(), user.getEmail(), user.getPassword()));
+
+        	} else {
+	        	System.out.println(
+	        			String.format("No User found for username: '%s'.", input));
+        	}
+
+            System.out.print("Please enter a string and press <enter>:");
+
+        }
+
+        LOGGER.info("Exiting application...bye.");
+
+        System.exit(0);
+
+    }
+}

basic/jdbc/src/main/java/org/springframework/integration/samples/jdbc/User.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright 2002-2011 the original author or authors.
+ *
+ * Licensed 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.springframework.integration.samples.jdbc;
+
+public class User {
+    private String username;
+    private String password;
+    private String email;
+
+    public User(String username, String password, String email) {
+        super();
+        this.username = username;
+        this.password = password;
+        this.email = email;
+    }
+
+    public String getUsername() {
+        return this.username;
+    }
+
+    public String getPassword() {
+        return this.password;
+    }
+
+    public String getEmail() {
+        return this.email;
+    }
+}

basic/jdbc/src/main/java/org/springframework/integration/samples/jdbc/UserMapper.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2002-2011 the original author or authors.
+ *
+ * Licensed 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.springframework.integration.samples.jdbc;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import org.springframework.jdbc.core.RowMapper;
+
+public class UserMapper implements RowMapper<User> {
+    public User mapRow(ResultSet rs, int rowNum) throws SQLException {
+        return new User(rs.getString("username"), rs.getString("password"), rs.getString("email"));
+    }
+}

basic/jdbc/src/main/java/org/springframework/integration/samples/jdbc/service/UserService.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2002-2011 the original author or authors
+ *
+ *     Licensed 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.springframework.integration.samples.jdbc.service;
+
+import org.springframework.integration.samples.jdbc.User;
+
+/**
+ * Provides user services.
+ */
+public interface UserService {
+
+    /**
+     * Retrieves a user based on the provided username.
+     *
+     * @param username Find users by username
+     * @return The user if exists, null otherwise.
+     */
+    User findUser(String username);
+
+}

basic/jdbc/src/main/resources/META-INF/spring/integration/spring-integration-context.xml

@@ -0,0 +1,38 @@
+<?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:int="http://www.springframework.org/schema/integration"
+	xmlns:int-jdbc="http://www.springframework.org/schema/integration/jdbc"
+	xmlns:jdbc="http://www.springframework.org/schema/jdbc"
+	xsi:schemaLocation="http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-3.0.xsd
+		http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration-2.0.xsd
+		http://www.springframework.org/schema/integration/jdbc http://www.springframework.org/schema/integration/jdbc/spring-integration-jdbc-2.1.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
+
+    <int:channel id="requestChannel"/>
+    <int:channel id="replyChannel"/>
+
+    <jdbc:embedded-database id="datasource" type="H2">
+        <jdbc:script location="classpath:setup-tables.sql"/>
+    </jdbc:embedded-database>
+
+    <!-- See also:
+        http://static.springsource.org/spring-integration/reference/htmlsingle/#gateway-proxy
+        http://www.eaipatterns.com/MessagingGateway.html -->
+    <int:gateway default-request-timeout="5000"
+                 default-reply-timeout="5000"
+                 default-request-channel="requestChannel"
+                 default-reply-channel="replyChannel"
+                 service-interface="org.springframework.integration.samples.jdbc.service.UserService">
+        <int:method name="convertToUpperCase"/>
+    </int:gateway>
+
+    <int-jdbc:outbound-gateway data-source="datasource"
+        update="UPDATE DUMMY SET DUMMY_VALUE='test'"
+                               request-channel="requestChannel" query="select * from users where username=:payload"
+                               reply-channel="replyChannel" row-mapper="rowMapper">
+    </int-jdbc:outbound-gateway>
+
+    <bean id="rowMapper" class="org.springframework.integration.samples.jdbc.UserMapper"/>
+
+</beans>

basic/jdbc/src/main/resources/logback.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<configuration>
+
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d %5p | %t | %-55logger{55} | %m %n</pattern>
+        </encoder>
+    </appender>
+
+    <logger name="org.springframework.integration">
+        <level value="INFO" />
+    </logger>
+
+    <logger name="org.springframework">
+        <level value="INFO" />
+    </logger>
+
+    <root>
+        <level value="INFO" />
+        <appender-ref ref="CONSOLE" />
+    </root>
+
+</configuration>

basic/jdbc/src/main/resources/setup-tables.sql

@@ -0,0 +1,5 @@
+create table IF NOT EXISTS USERS(USERNAME varchar(100),PASSWORD varchar(100), EMAIL varchar(100));
+create table IF NOT EXISTS DUMMY(DUMMY_VALUE varchar(10));
+INSERT INTO USERS(USERNAME, PASSWORD, EMAIL) VALUES ('a', 'secret', 'spring-integration@awesome.com');
+INSERT INTO USERS(USERNAME, PASSWORD, EMAIL) VALUES ('b', 's3cr3t', 'spring@rocks.com');
+INSERT INTO USERS(USERNAME, PASSWORD, EMAIL) VALUES ('foo', 'bar', 'foo@bar.de');

basic/jdbc/src/test/java/org/springframework/integration/sts/StringConversionServiceTest.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2002-2010 the original author or authors.
+ *
+ * Licensed 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.springframework.integration.sts;
+
+import static junit.framework.Assert.*;
+
+import org.junit.Test;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+import org.springframework.integration.samples.jdbc.User;
+import org.springframework.integration.samples.jdbc.service.UserService;
+
+
+/**
+ * Verify that the Spring Integration Application Context starts successfully.
+ */
+public class StringConversionServiceTest {
+
+    @Test
+    public void testStartupOfSpringInegrationContext() throws Exception{
+        final ApplicationContext context
+            = new ClassPathXmlApplicationContext("/META-INF/spring/integration/spring-integration-context.xml",
+                                                  StringConversionServiceTest.class);
+        Thread.sleep(2000);
+    }
+
+    @Test
+    public void testConvertStringToUpperCase() {
+        final ApplicationContext context
+            = new ClassPathXmlApplicationContext("/META-INF/spring/integration/spring-integration-context.xml",
+                                                  StringConversionServiceTest.class);
+
+        final UserService service = context.getBean(UserService.class);
+
+        final String userNameToUse = "a";
+        final String expectedResult  = "I LOVE SPRING INTEGRATION";
+
+        final User user = service.findUser(userNameToUse);
+
+        assertEquals("Expecting that the returned username is 'a'.",
+        		userNameToUse, user.getUsername());
+
+    }
+
+}

basic/pom.xml

@@ -15,6 +15,7 @@
         <module>file</module>
         <module>ftp</module>
         <module>helloworld</module>
+        <module>jdbc</module>
         <module>jms</module>
         <module>jmx</module>
         <module>mail</module>