Merge pull request #29 from mendix/callable-statements

This PR adds support for calling statements with more complex input and output structures than the prepared statements already available in the module.

Because of this extra complexity, it also adds entities to the module's domain model to allow the user to define a more complex call/return process.

Author: dahfjkg

DatabaseConnector.mpr

@@ -0,0 +1,90 @@
+// This file was generated by Mendix Studio Pro.
+//
+// WARNING: Only the following code will be retained when actions are regenerated:
+// - the import list
+// - the code between BEGIN USER CODE and END USER CODE
+// - the code between BEGIN EXTRA CODE and END EXTRA CODE
+// Other code you write will be lost the next time you deploy the project.
+// Special characters, e.g., é, ö, à, etc. are supported in comments.
+
+package databaseconnector.actions;
+
+import com.mendix.core.Core;
+import com.mendix.logging.ILogNode;
+import com.mendix.systemwideinterfaces.core.IContext;
+import com.mendix.webui.CustomJavaAction;
+import databaseconnector.impl.JdbcConnector;
+import com.mendix.systemwideinterfaces.core.IMendixObject;
+
+/**
+ * For a more detailed documentation, please visit the website at
+ * https://docs.mendix.com/appstore/connectors/database-connector
+ * 
+ * This Java action provides a consistent environment for Mendix projects to
+ * call an arbitrary statement on external relational databases.
+ * 
+ * This action requires an instance of the Statement NPE (Non-Persistable Entity)
+ * with associated NPEs of its Parameters. Input parameters need to be filled in
+ * before calling this action and output parameters will be filled in afterwards.
+ * 
+ * The JDBC drivers for the databases you want to connect to must be placed
+ * inside the userlib directory of your project.
+ * 
+ * Note: Proper security is required when manually composing the statement text to
+ *       avoid SQL injection.
+ * 
+ * @param jdbcUrl A database JDBC URL address that points to your database.
+ * 
+ * @param userName The user name for logging into the database.
+ * 
+ * @param password The password for logging into the database.
+ * 
+ * @param statement An instance of the Statement NPE containing both the content of the
+ *                  statement to be called as well as all of its parameters.
+ */
+public class ExecuteCallableStatement extends CustomJavaAction<java.lang.Void>
+{
+	private java.lang.String jdbcUrl;
+	private java.lang.String userName;
+	private java.lang.String password;
+	private IMendixObject __statement;
+	private databaseconnector.proxies.Statement statement;
+
+	public ExecuteCallableStatement(IContext context, java.lang.String jdbcUrl, java.lang.String userName, java.lang.String password, IMendixObject statement)
+	{
+		super(context);
+		this.jdbcUrl = jdbcUrl;
+		this.userName = userName;
+		this.password = password;
+		this.__statement = statement;
+	}
+
+	@java.lang.Override
+	public java.lang.Void executeAction() throws Exception
+	{
+		this.statement = __statement == null ? null : databaseconnector.proxies.Statement.initialize(getContext(), __statement);
+
+		// BEGIN USER CODE
+		if (this.statement == null) {
+			throw new IllegalArgumentException("Execute callable statement was called with an empty value.");
+		}
+		connector.executeCallableStatement(this.jdbcUrl, this.userName, this.password, this.statement);
+		return null;
+		// END USER CODE
+	}
+
+	/**
+	 * Returns a string representation of this action
+	 */
+	@java.lang.Override
+	public java.lang.String toString()
+	{
+		return "ExecuteCallableStatement";
+	}
+
+	// BEGIN EXTRA CODE
+	private final ILogNode logNode = Core.getLogger(this.getClass().getName());
+
+	private final JdbcConnector connector = new JdbcConnector(logNode);
+	// END EXTRA CODE
+}

javasource/databaseconnector/actions/ExecuteCallableStatement.java

@@ -10,8 +10,6 @@
 package databaseconnector.actions;
 
 import java.util.List;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 import com.mendix.core.Core;
 import com.mendix.logging.ILogNode;
 import com.mendix.systemwideinterfaces.core.IContext;
@@ -21,39 +19,34 @@
 import databaseconnector.impl.JdbcConnector;
 
 /**
- * <p>
- * This Java action provides a consistent environment for Mendix projects to perform an arbitrary parameterized SELECT SQL query on relational external databases.
- * JDBC (Java Database Connectivity) API, a standard Java API, is used when this Java action attempts
- * to connect with a Relational Database for which a JDBC driver exists.
- * The JDBC drivers for the databases you want to connect to, must be placed inside the userlib directory of a project.
- * </p>
+ * For a more detailed documentation, please visit the website at
+ * https://docs.mendix.com/appstore/connectors/database-connector
  * 
- * Do not use this Java action for INSERT, UPDATE, DELETE or DDL queries.
- * This action returns a list of Mendix objects based on the JDBC result set.
- * The jdbcUrl argument must specify a database URL address that points to your relational database and is dependent
- * upon the particular database and JDBC driver. It will always begin with "jdbc:" protocol, but the rest is up to particular vendor.
- * For example 'jdbc:mysql://hostname/databaseName' jdbcUrl format can be used for MySQL databases.
- * Note: Proper security must be applied as this action can allow SQL Injection in your Mendix application.
+ * This Java action provides a consistent environment for Mendix projects to
+ * perform an arbitrary parameterized SELECT SQL query on external relational
+ * databases.
  * 
- * @see    JdbcConnector
- * @since  Mendix World 2016
- * @param <String> jdbcUrl
- *    A database URL address that points to your database.
+ * Do not use this Java action for INSERT, UPDATE, DELETE or DDL queries. This
+ * action returns a list of Mendix objects based on the JDBC result set.
  * 
- * @param <String> userName 
- *    The user name for logging into the database, relative to the jdbcUrl argument.
+ * The JDBC drivers for the databases you want to connect to must be placed
+ * inside the userlib directory of your project.
  * 
- * @param <String> password 
- *    The password for logging into the database, relative to the jdbcUrl argument.
+ * Note: Proper security is required when manually composing the query text to
+ *       avoid SQL injection.
  * 
- * @param <IStringTemplate> sql
- *    A string template containing the SELECT query to be performed and the query parameters, relative to the database type.
+ * @param jdbcUrl A database JDBC URL address that points to your database.
  * 
- * @param <String> resultObjectType
- *    A fully qualified name of the result object type. Concrete <IMetaObject> can be retrieved with a call to `Core.getMetaObject`.
+ * @param userName The user name for logging into the database.
  * 
- * @return <List<IMendixObject>>
- *    SELECT Query result as a list of objects.
+ * @param password The password for logging into the database.
+ * 
+ * @param sql A string template containing the SELECT query to be performed and
+ *            its query parameters.
+ * 
+ * @param resultObjectType A fully qualified name for the result object type. 
+ * 
+ * @return Result of the query as a list of mendix objects.
  */
 public class ExecuteParameterizedQuery extends CustomJavaAction<java.util.List<IMendixObject>>
 {
@@ -78,9 +71,8 @@ public java.util.List<IMendixObject> executeAction() throws Exception
 	{
 		// BEGIN USER CODE
 		IMetaObject metaObject = Core.getMetaObject(this.resultObjectType);
-		Stream<IMendixObject> resultStream = connector.executeQuery(
-				this.jdbcUrl, this.userName, this.password, metaObject, this.sql, this.getContext());
-		List<IMendixObject> resultList = resultStream.collect(Collectors.toList());
+		List<IMendixObject> resultList = connector.executeQuery(this.jdbcUrl, this.userName, this.password,
+				metaObject, this.sql, this.getContext());
 		logNode.trace(String.format("Result list count: %d", resultList.size()));
 
 		return resultList;

javasource/databaseconnector/actions/ExecuteParameterizedQuery.java

@@ -16,37 +16,34 @@
 import databaseconnector.impl.JdbcConnector;
 
 /**
- * <p>
- * This Java action provides a consistent environment for Mendix projects to perform an arbitrary parameterized SQL statement on relational
- * external databases.
- * JDBC (Java Database Connectivity) API, a standard Java API, is used when this Java action attempts
- * to connect with a Relational Database for which a JDBC driver exists.
- * The JDBC drivers for the databases you want to connect to, must be placed inside the userlib directory of a project.
- * </p>
+ * For a more detailed documentation, please visit the website at
+ * https://docs.mendix.com/appstore/connectors/database-connector
  * 
- * Do not use this Java action for SELECT queries.
- * This Java action returns number of affected rows.
- * The jdbcUrl argument must specify a database URL address that points to your relational database and is dependent
- * upon the particular database and JDBC driver. It will always begin with "jdbc:" protocol, but the rest is up to particular vendor.
- * For example 'jdbc:mysql://hostname/databaseName' jdbcUrl format can be used for MySQL databases.
- * Note: Proper security must be applied as this action can allow SQL Injection in your Mendix application.
+ * This Java action provides a consistent environment for Mendix projects to
+ * perform arbitrary parameterized SQL statements on external relational
+ * databases. The statement text may contain placeholders to be filled in with
+ * values directly from Mendix.
  * 
- * @see    JdbcConnector
- * @since  Mendix World 2016
- * @param <String> jdbcUrl
- *    A database URL address that points to your database.
+ * Do not use this Java action for SELECT queries. This action returns the
+ * number of affected rows.
  * 
- * @param <String> userName 
- *    The user name for logging into the database, relative to the jdbcUrl argument.
+ * The JDBC drivers for the databases you want to connect to must be placed
+ * inside the userlib directory of your project.
  * 
- * @param <String> password 
- *    The password for logging into the database, relative to the jdbcUrl argument.
+ * Note: While the text parameters are properly escaped, proper security is still
+ *       required when manually composing the parameterized template text to avoid
+ *       SQL injection.
  * 
- * @param <IStringTemplate> sql
- *    A string template containing the SQL statement to be performed and the statement parameters, relative to the database type.
+ * @param jdbcUrl A database JDBC URL address that points to your database.
  * 
- * @return <Integer/Long>
- *    Number of affected rows.
+ * @param userName The user name for logging into the database.
+ * 
+ * @param password The password for logging into the database.
+ * 
+ * @param sql A string template containing the SQL statement to be performed and the
+ *            statement parameters.
+ * 
+ * @return Number of affected rows.
  */
 public class ExecuteParameterizedStatement extends CustomJavaAction<java.lang.Long>
 {
@@ -84,6 +81,6 @@ public java.lang.String toString()
 	// BEGIN EXTRA CODE
 	private final ILogNode logNode = Core.getLogger(this.getClass().getName());
 
-  	private final JdbcConnector connector = new JdbcConnector(logNode);
+	private final JdbcConnector connector = new JdbcConnector(logNode);
 	// END EXTRA CODE
 }

javasource/databaseconnector/actions/ExecuteParameterizedStatement.java

@@ -10,8 +10,6 @@
 package databaseconnector.actions;
 
 import java.util.List;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 import com.mendix.core.Core;
 import com.mendix.logging.ILogNode;
 import com.mendix.systemwideinterfaces.core.IContext;
@@ -21,39 +19,33 @@
 import databaseconnector.impl.JdbcConnector;
 
 /**
- * <p>
- * This Java action provides a consistent environment for Mendix projects to perform an arbitrary SELECT SQL query on relational external databases.
- * JDBC (Java Database Connectivity) API, a standard Java API, is used when this Java action attempts
- * to connect with a Relational Database for which a JDBC driver exists.
- * The JDBC drivers for the databases you want to connect to, must be placed inside the userlib directory of a project.
- * </p>
+ * For a more detailed documentation, please visit the website at
+ * https://docs.mendix.com/appstore/connectors/database-connector
  * 
- * Do not use this Java action for INSERT, UPDATE, DELETE or DDL queries.
- * This action returns a list of Mendix objects based on the JDBC result set.
- * The jdbcUrl argument must specify a database URL address that points to your relational database and is dependent
- * upon the particular database and JDBC driver. It will always begin with "jdbc:" protocol, but the rest is up to particular vendor.
- * For example 'jdbc:mysql://hostname/databaseName' jdbcUrl format can be used for MySQL databases.
- * Note: Proper security must be applied as this action can allow SQL Injection in your Mendix application.
+ * This Java action provides a consistent environment for Mendix projects to
+ * perform an arbitrary SELECT SQL query on external relational databases.
  * 
- * @see    JdbcConnector
- * @since  Mendix World 2016
- * @param <String> jdbcUrl
- *    A database URL address that points to your database.
+ * Do not use this Java action for INSERT, UPDATE, DELETE or DDL queries. This
+ * action returns a list of Mendix objects based on the JDBC result set.
  * 
- * @param <String> userName 
- *    The user name for logging into the database, relative to the jdbcUrl argument.
+ * The JDBC drivers for the databases you want to connect to must be placed
+ * inside the userlib directory of your project.
  * 
- * @param <String> password 
- *    The password for logging into the database, relative to the jdbcUrl argument.
+ * Note: Proper security is required when manually composing the query text to
+ *       avoid SQL injection.
  * 
- * @param <String> sql
- *    The SELECT query to be performed, relative to the database type.
+ * @param jdbcUrl A database JDBC URL address that points to your database.
  * 
- * @param <IMendixObject> resultObject
- *    An instance of the resulting object. This instance is used only for defining the type of object to be returned.
+ * @param userName The user name for logging into the database.
  * 
- * @return <List<IMendixObject>>
- *    SELECT Query result as a list of objects.
+ * @param password The password for logging into the database.
+ * 
+ * @param sql The SELECT query to be performed.
+ * 
+ * @param resultObject An instance of the resulting object. This instance is used
+ *                     only for defining the type of object to be returned.
+ * 
+ * @return Result of the query as a list of mendix objects.
  */
 public class ExecuteQuery extends CustomJavaAction<java.util.List<IMendixObject>>
 {
@@ -78,9 +70,8 @@ public java.util.List<IMendixObject> executeAction() throws Exception
 	{
 		// BEGIN USER CODE
 		IMetaObject metaObject = resultObject.getMetaObject();
-		Stream<IMendixObject> resultStream = connector.executeQuery(
-		    this.jdbcUrl, this.userName, this.password, metaObject, this.sql, this.getContext());
-		List<IMendixObject> resultList = resultStream.collect(Collectors.toList());
+		List<IMendixObject> resultList = connector.executeQuery(this.jdbcUrl, this.userName, this.password,
+				metaObject, this.sql, this.getContext());
 		logNode.trace(String.format("Result list count: %d", resultList.size()));
 
 		return resultList;