INTSAMPLES-97 - Add Postgres Stored Procedure Sample

2012-10-23 17:08:32 -04:00
parent 0a42b6ce88
commit cc81a16ffb
9 changed files with 609 additions and 0 deletions
--- a/intermediate/stored-procedures-postgresql/README.md
+++ b/intermediate/stored-procedures-postgresql/README.md
@@ -0,0 +1,93 @@
+Spring Integration - Stored Procedure Example - PostgreSQL
+================================================================================
+
+# Overview
+
+This example provides a simple example using the *Stored Procedure Outbound Gateway*
+adapter. This example will call 1 PostgreSQL **Stored Function** and 1 **Stored Procedure**.
+
+The second procedure returns a **ResultSet**.
+
+# Setup
+
+## Maven
+
+Please make sure you have *Maven* set up and that the project builds successfully using `mvn clean package`.
+
+## PostgreSQL
+
+Please ensure that you can connect to a running instance of a *PostgreSQL server*. The sample was tested using **PostgreSQL v9.2.1**. 
+
+### Required Table
+
+```SQL
+CREATE TABLE "COFFEE_BEVERAGES"
+(
+  "ID" integer NOT NULL,
+  "COFFEE_NAME" text,
+  "COFFEE_DESCRIPTION" text,
+  CONSTRAINT "COFFEE_BEVERAGES_pkey" PRIMARY KEY ("ID")
+)
+```
+
+### Sample Data
+
+```SQL
+INSERT INTO "COFFEE_BEVERAGES" ("ID", "COFFEE_NAME", "COFFEE_DESCRIPTION") VALUES (1, 'Espresso',     'Espressos keep developers going in the morning. There are never enough of them.');
+INSERT INTO "COFFEE_BEVERAGES" ("ID", "COFFEE_NAME", "COFFEE_DESCRIPTION") VALUES (2, 'Cappuccino',   'For the finer moments. Wrap your espresso in a tasty layer of foam.');
+INSERT INTO "COFFEE_BEVERAGES" ("ID", "COFFEE_NAME", "COFFEE_DESCRIPTION") VALUES (3, 'Mocha',        'Mmmmh, chocolate.');
+INSERT INTO "COFFEE_BEVERAGES" ("ID", "COFFEE_NAME", "COFFEE_DESCRIPTION") VALUES (4, 'Latte',        'If you are more into milk than into foam.');
+```
+
+### Stored Procedures
+
+Please create the following Stored Procedure/Function:
+
+```SQL
+CREATE OR REPLACE FUNCTION find_all_coffee_beverages()
+  RETURNS refcursor AS
+$BODY$
+DECLARE
+    ref refcursor;
+BEGIN
+  OPEN ref FOR SELECT "ID", "COFFEE_NAME", "COFFEE_DESCRIPTION" FROM "COFFEE_BEVERAGES";
+  RETURN ref;
+END;
+$BODY$
+LANGUAGE plpgsql VOLATILE
+COST 100;
+```
+
+```SQL
+CREATE OR REPLACE FUNCTION find_coffee(coffee_name integer)
+  RETURNS character varying AS
+$BODY$
+declare
+    description character varying;
+begin
+    SELECT into description "COFFEE_DESCRIPTION" from "COFFEE_BEVERAGES" where "ID"=coffee_name;
+    return description;
+end
+$BODY$
+LANGUAGE plpgsql VOLATILE
+COST 100;
+```
+### Configure the DataSource
+
+Please configure the necessary credentials in order to connect to your database in **/src/main/resources/META-INF/spring/integration/spring-integration-context.xml**. The default setting expects a database **integration** to run on localhost with a usersname of **postgres** and a password of **postgres**.
+
+# Run the Sample
+
+* 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
+
+* Follow the screen (command line) instructions.
+
+--------------------------------------------------------------------------------
+
+For help please take a look at the Spring Integration documentation:
+
+http://www.springsource.org/spring-integration
+
--- a/intermediate/stored-procedures-postgresql/pom.xml
+++ b/intermediate/stored-procedures-postgresql/pom.xml
@@ -0,0 +1,112 @@
+<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>postgresql-stored-procedures</artifactId>
+	<version>2.2.0.BUILD-SNAPSHOT</version>
+	<packaging>jar</packaging>
+
+	<name>Samples (Intermediate) - Stored Procedures PostgreSQL</name>
+	<url>http://www.springsource.org/spring-integration</url>
+
+	<prerequisites>
+		<maven>2.2.1</maven>
+	</prerequisites>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<spring.integration.version>2.2.0.RC2</spring.integration.version>
+		<log4j.version>1.2.17</log4j.version>
+		<junit.version>4.10</junit.version>
+	</properties>
+
+	<repositories>
+		<repository>
+			<id>repo.springsource.org.milestone</id>
+			<name>SpringSource Maven Milestone Repository</name>
+			<url>https://repo.springsource.org/libs-milestone</url>
+		</repository>
+	</repositories>
+
+	<build>
+		<plugins>
+			<plugin>
+				<artifactId>maven-eclipse-plugin</artifactId>
+				<version>2.9</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.5.1</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.1</version>
+				<configuration>
+					<mainClass>org.springframework.integration.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-jdbc</artifactId>
+			<version>${spring.integration.version}</version>
+		</dependency>
+
+		<!-- Logging -->
+
+		<dependency>
+			<groupId>log4j</groupId>
+			<artifactId>log4j</artifactId>
+			<version>${log4j.version}</version>
+		</dependency>
+
+		<!-- Persistence -->
+
+		<dependency>
+			<groupId>postgresql</groupId>
+			<artifactId>postgresql</artifactId>
+			<version>9.1-901-1.jdbc4</version>
+		</dependency>
+
+		<dependency>
+			<groupId>commons-dbcp</groupId>
+			<artifactId>commons-dbcp</artifactId>
+			<version>1.4</version>
+		</dependency>
+	</dependencies>
+</project>
--- a/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/Main.java
+++ b/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/Main.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2002-2012 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;
+
+import java.util.List;
+import java.util.Scanner;
+
+import org.apache.log4j.Logger;
+import org.springframework.context.support.AbstractApplicationContext;
+import org.springframework.context.support.ClassPathXmlApplicationContext;
+
+import org.springframework.integration.model.CoffeeBeverage;
+import org.springframework.integration.service.CoffeeService;
+
+
+/**
+ * Starts the Spring Context and will initialize the Spring Integration routes.
+ *
+ * @author Gunnar Hillert
+ * @since 2.2
+ *
+ */
+public final class Main {
+
+	private static final Logger LOGGER = Logger.getLogger(Main.class);
+
+	private static final String LINE    = "\n=========================================================";
+	private static final String NEWLINE = "\n";
+
+	private Main() { }
+
+	/**
+	 * Load the Spring Integration Application Context
+	 *
+	 * @param args - command line arguments
+	 */
+	public static void main(final String... args) {
+
+		LOGGER.info(LINE
+				+ LINE
+				+ "\n    Welcome to Spring Integration Coffee Database!       "
+				+ NEWLINE
+				+ "\n    For more information please visit:                   "
+				+ "\n    http://www.springsource.org/spring-integration       "
+				+ NEWLINE
+				+ LINE );
+
+		final AbstractApplicationContext context =
+			new ClassPathXmlApplicationContext("classpath:META-INF/spring/integration/*-context.xml");
+
+		context.registerShutdownHook();
+
+		final Scanner scanner = new Scanner(System.in);
+
+		final CoffeeService service = context.getBean(CoffeeService.class);
+
+		LOGGER.info(LINE
+				+ NEWLINE
+				+ "\n    Please press 'q + Enter' to quit the application."
+				+ NEWLINE
+				+ LINE);
+
+		System.out.print("Please enter 'list' and press <enter> to get a list of coffees.");
+		System.out.print("Enter a coffee id, e.g. '1' and press <enter> to get a description.\n\n");
+
+		while (!scanner.hasNext("q")) {
+
+			String input = scanner.nextLine();
+
+			if ("list".equalsIgnoreCase(input)) {
+				List<CoffeeBeverage> coffeeBeverages = service.findAllCoffeeBeverages();
+
+				for (CoffeeBeverage coffeeBeverage : coffeeBeverages) {
+					System.out.println(String.format("%s - %s", coffeeBeverage.getId(),
+																coffeeBeverage.getName()));
+				}
+
+			} else {
+				System.out.println("Retrieving coffee information...");
+				String coffeeDescription = service.findCoffeeBeverage(Integer.valueOf(input));
+
+				System.out.println(String.format("Searched for '%s' - Found: '%s'.", input, coffeeDescription));
+				System.out.print("To try again, please enter another coffee beverage and press <enter>:\n\n");
+			}
+
+		}
+
+		LOGGER.info("Exiting application...bye.");
+
+		System.exit(0);
+
+	}
+}
--- a/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/model/CoffeeBeverage.java
+++ b/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/model/CoffeeBeverage.java
@@ -0,0 +1,131 @@
+/*
+ * Copyright 2002-2012 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.model;
+
+/**
+ *
+ * @author Gunnar Hillert
+ * @since 2.2
+ *
+ */
+public class CoffeeBeverage {
+
+	private Integer id;
+	private String name;
+	private String description;
+
+	/** Default Constructor */
+	public CoffeeBeverage() {
+		super();
+	}
+
+	/**
+	 * @param id
+	 * @param name
+	 * @param description
+	 */
+	public CoffeeBeverage(Integer id, String name, String description) {
+		super();
+		this.id = id;
+		this.name = name;
+		this.description = description;
+	}
+
+	public Integer getId() {
+		return this.id;
+	}
+
+	public void setId(Integer id) {
+		this.id = id;
+	}
+
+	public String getName() {
+		return this.name;
+	}
+
+	public void setName(String name) {
+		this.name = name;
+	}
+
+	public String getDescription() {
+		return this.description;
+	}
+
+	public void setDescription(String description) {
+		this.description = description;
+	}
+
+	@Override
+	public int hashCode() {
+		final int prime = 31;
+		int result = 1;
+		result = prime
+				* result
+				+ ((this.description == null) ? 0 : this.description.hashCode());
+		result = prime * result
+				+ ((this.name == null) ? 0 : this.name.hashCode());
+		return result;
+	}
+
+	@Override
+	public boolean equals(Object obj) {
+		if (this == obj) {
+			return true;
+		}
+
+		if (obj == null) {
+			return false;
+		}
+
+		if (getClass() != obj.getClass()) {
+			return false;
+		}
+
+		CoffeeBeverage other = (CoffeeBeverage) obj;
+
+		if (this.description == null) {
+
+			if (other.description != null) {
+				return false;
+			}
+
+		} else if (!this.description.equals(other.description)) {
+			return false;
+		}
+
+		if (this.name == null) {
+
+			if (other.name != null) {
+				return false;
+			}
+
+		} else if (!this.name.equals(other.name)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	@Override
+	public String toString() {
+		StringBuilder builder = new StringBuilder();
+		builder.append("CoffeeBeverage [id=").append(this.id).append(", name=")
+				.append(this.name).append(", description=")
+				.append(this.description).append("]");
+		return builder.toString();
+	}
+
+}
--- a/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/service/CoffeeService.java
+++ b/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/service/CoffeeService.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2002-2012 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.service;
+
+import java.util.List;
+
+import org.springframework.integration.annotation.Payload;
+import org.springframework.integration.model.CoffeeBeverage;
+import org.springframework.transaction.annotation.Transactional;
+
+
+/**
+ * Provides access to the Coffee Database Services.
+ *
+ * @author Gunnar Hillert
+ * @since 2.2
+ */
+@Transactional
+public interface CoffeeService {
+
+	/**
+	 * Find the description for a provided coffee beverage.
+	 *
+	 * @param Id of the coffee beverage
+	 * @return The the description of the coffee beverage
+	 */
+	String findCoffeeBeverage(Integer input);
+
+	/**
+	 * Find the description for a provided coffee beverage.
+	 *
+	 * @return Collection of coffee beverages
+	 */
+	@Payload("new java.util.Date()")
+	List<CoffeeBeverage> findAllCoffeeBeverages();
+
+}
--- a/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/support/CoffeBeverageMapper.java
+++ b/intermediate/stored-procedures-postgresql/src/main/java/org/springframework/integration/support/CoffeBeverageMapper.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright 2002-2012 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.support;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+import org.springframework.integration.model.CoffeeBeverage;
+import org.springframework.jdbc.core.RowMapper;
+
+/**
+ *
+ * @author Gunnar Hillert
+ * @since 2.2
+ *
+ */
+public class CoffeBeverageMapper implements RowMapper<CoffeeBeverage> {
+
+	public CoffeeBeverage mapRow(ResultSet rs, int rowNum) throws SQLException {
+		return new CoffeeBeverage(rs.getInt("ID"), rs.getString("COFFEE_NAME"), rs.getString("COFFEE_DESCRIPTION"));
+	}
+
+}
--- a/intermediate/stored-procedures-postgresql/src/main/resources/META-INF/spring/integration/spring-integration-context.xml
+++ b/intermediate/stored-procedures-postgresql/src/main/resources/META-INF/spring/integration/spring-integration-context.xml
@@ -0,0 +1,55 @@
+<?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"
+	xmlns:tx="http://www.springframework.org/schema/tx"
+	xsi:schemaLocation="http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
+		http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration.xsd
+		http://www.springframework.org/schema/integration/jdbc http://www.springframework.org/schema/integration/jdbc/spring-integration-jdbc.xsd
+		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
+		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">
+
+	<tx:annotation-driven transaction-manager="transactionManager"/>
+
+	<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
+		destroy-method="close">
+		<property name="driverClassName" value="org.postgresql.Driver" />
+		<property name="url"
+			value="jdbc:postgresql:integration" />
+		<property name="username" value="postgres" />
+		<property name="password" value="postgres" />
+	</bean>
+
+	<int:channel id="findCoffeeProcedureRequestChannel" />
+	<int:channel id="findAllProcedureRequestChannel" />
+
+	<int:gateway id="gateway" default-request-timeout="4000"
+		default-reply-timeout="4000"
+		service-interface="org.springframework.integration.service.CoffeeService">
+		<int:method name="findCoffeeBeverage" request-channel="findCoffeeProcedureRequestChannel" />
+		<int:method name="findAllCoffeeBeverages" request-channel="findAllProcedureRequestChannel" />
+	</int:gateway>
+
+	<int-jdbc:stored-proc-outbound-gateway
+		id="outbound-gateway-storedproc-find-coffee" data-source="dataSource"
+		request-channel="findCoffeeProcedureRequestChannel" is-function="true"
+		skip-undeclared-results="true" stored-procedure-name="FIND_COFFEE"
+		expect-single-result="true">
+		<int-jdbc:sql-parameter-definition name="coffee_name" type="INTEGER" direction="IN"/>
+		<int-jdbc:parameter name="coffee_name" expression="payload" />
+	</int-jdbc:stored-proc-outbound-gateway>
+
+	<int-jdbc:stored-proc-outbound-gateway
+		id="outbound-gateway-storedproc-find-all" data-source="dataSource" ignore-column-meta-data="true"
+		request-channel="findAllProcedureRequestChannel" expect-single-result="true"
+		stored-procedure-name="FIND_ALL_COFFEE_BEVERAGES">
+		<int-jdbc:returning-resultset name="ref"
+			row-mapper="org.springframework.integration.support.CoffeBeverageMapper" />
+	</int-jdbc:stored-proc-outbound-gateway>
+
+	<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
+		<property name="dataSource" ref="dataSource"/>
+	</bean>
+</beans>
--- a/intermediate/stored-procedures-postgresql/src/main/resources/log4j.xml
+++ b/intermediate/stored-procedures-postgresql/src/main/resources/log4j.xml
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+<log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/">
+
+	<!-- Appenders -->
+	<appender name="console" class="org.apache.log4j.ConsoleAppender">
+		<param name="Target" value="System.out" />
+		<layout class="org.apache.log4j.PatternLayout">
+			<param name="ConversionPattern" value="%d{HH:mm:ss.SSS} %-5p [%t][%c] %m%n" />
+		</layout>
+	</appender>
+
+	<!-- Loggers -->
+	<logger name="org.springframework.integration">
+		<level value="INFO" />
+	</logger>
+
+	<logger name="org.springframework.integration.samples">
+		<level value="INFO" />
+	</logger>
+
+	<!-- Root Logger -->
+	<root>
+		<priority value="INFO" />
+		<appender-ref ref="console" />
+	</root>
+
+</log4j:configuration>