#343 Define callableImplementation connection property

Author: mrotteveel

src/main/org/firebirdsql/ds/AbstractConnectionPropertiesDataSource.java

@@ -551,6 +551,16 @@ public void setEscapeProcessing(boolean escapeProcessing) {
         FirebirdConnectionProperties.super.setEscapeProcessing(escapeProcessing);
     }
 
+    @Override
+    public String getCallableImplementation() {
+        return FirebirdConnectionProperties.super.getCallableImplementation();
+    }
+
+    @Override
+    public void setCallableImplementation(String callableImplementation) {
+        FirebirdConnectionProperties.super.setCallableImplementation(callableImplementation);
+    }
+
     @SuppressWarnings("deprecation")
     @Deprecated(since = "5")
     @Override

src/main/org/firebirdsql/jaybird/props/DatabaseConnectionProperties.java

@@ -893,4 +893,42 @@ default void setEscapeProcessing(boolean escapeProcessing) {
         setBooleanProperty(PropertyNames.escapeProcessing, escapeProcessing);
     }
 
+    /**
+     * @return the callable statement implementation version
+     * @see #setCallableImplementation(String)
+     * @since 7
+     */
+    default String getCallableImplementation() {
+        return getProperty(PropertyNames.callableImplementation, PropertyConstants.DEFAULT_CALLABLE_IMPLEMENTATION);
+    }
+
+    /**
+     * Configures the callable statement version.
+     * <p>
+     * Currently supported callable statement versions are:
+     * </p>
+     * <ul>
+     * <li>{@code V1} &mdash; the first (original) callable statement implementation (default), basically
+     * the implementation available since Jaybird 1 (with some evolution since then)</li>
+     * <li>{@code V2} &mdash; the second callable statement implementation, introduced in Jaybird 7 (currently
+     * experimental)</li>
+     * </ul>
+     * <p>
+     * In Jaybird 7, the {@code V2} implementation is experimental. It can be enabled for evaluation/testing. A future
+     * point release of Jaybird 7 may declare it stable. V2 is expected to become the default in Jaybird 8. Once V2 is
+     * the default, we will likely remove V1 support in Jaybird 9 or later (or at minimum, at least one version after V2
+     * becomes the default).
+     * </p>
+     * <p>
+     * For more information also see (TODO Add link the JDP and Jaybird manual)
+     * </p>
+     *
+     * @param callableImplementation
+     *         callable statement version, {@code V1} (default) or {@code v2} (experimental) (case-insensitive)
+     * @since 7
+     */
+    default void setCallableImplementation(String callableImplementation) {
+        setProperty(PropertyNames.callableImplementation, callableImplementation);
+    }
+
 }

src/main/org/firebirdsql/jaybird/props/PropertyConstants.java

@@ -73,6 +73,10 @@ public final class PropertyConstants {
     public static final String DEFAULT_AUTH_PLUGINS = "Srp256,Srp";
     static final String DEFAULT_LEGACY_AUTH_CHARSET = "UTF-8";
 
+    public static final String CALLABLE_IMPLEMENTATION_V1 = "V1";
+    public static final String CALLABLE_IMPLEMENTATION_V2 = "V2";
+    static final String DEFAULT_CALLABLE_IMPLEMENTATION = CALLABLE_IMPLEMENTATION_V1;
+
     private PropertyConstants() {
         // no instances
     }

src/main/org/firebirdsql/jaybird/props/PropertyNames.java

@@ -72,6 +72,8 @@ public final class PropertyNames {
     public static final String maxBlobCacheSize = "maxBlobCacheSize";
     public static final String searchPath = "searchPath";
     public static final String escapeProcessing = "escapeProcessing";
+    // TODO Maybe use a shorter name or add a shorter alias?
+    public static final String callableImplementation = "callableImplementation";
 
     // service connection
     public static final String expectedDb = "expectedDb";

src/main/org/firebirdsql/jaybird/props/internal/StandardConnectionPropertyDefiner.java

@@ -108,6 +108,8 @@ public Stream<ConnectionProperty> defineProperties() {
                         .dpbItem(isc_dpb_max_blob_cache_size),
                 builder(searchPath).aliases("search_path", "isc_dpb_search_path").dpbItem(isc_dpb_search_path),
                 builder(escapeProcessing).type(BOOLEAN),
+                // TODO Maybe use a shorter name or add a shorter alias?
+                builder(callableImplementation).choices(CALLABLE_IMPLEMENTATION_V1, CALLABLE_IMPLEMENTATION_V2),
 
                 // TODO Consider removing this property, otherwise formally add it to PropertyNames
                 builder("filename_charset"),