add a factory for AS400ConnectionPool objects (#247)

Signed-off-by: Nicola Isotta <[email protected]>

Author: NicolaIsotta

src/main/java/com/ibm/as400/access/AS400ConnectionPool.java

@@ -24,7 +24,13 @@
 import java.io.Serializable;
 import java.io.IOException;
 import java.io.ObjectInputStream;
+import java.util.Objects;
 
+import javax.naming.NamingException;
+import javax.naming.RefAddr;
+import javax.naming.Reference;
+import javax.naming.Referenceable;
+import javax.naming.StringRefAddr;
 
 /**
  *  Manages a pool of AS400 objects.  A connection pool is used to 
@@ -84,9 +90,20 @@
  *    <li>PropertyChangeEvent</li>
  *  </ul>
  **/
-public class AS400ConnectionPool extends ConnectionPool implements Serializable
+public class AS400ConnectionPool extends ConnectionPool implements Serializable, Referenceable
 {
     static final long serialVersionUID = 4L;
+    
+    private static final String CCSID_PROPERTY = "ccsid";
+    private static final String CLEANUP_INTERVAL_PROPERTY = "cleanupInterval";
+    private static final String MAX_CONNECTIONS_PROPERTY = "maxConnections";
+    private static final String MAX_INACTIVITY_PROPERTY = "maxInactivity";
+    private static final String MAX_LIFETIME_PROPERTY = "maxLifetime";
+    private static final String MAX_USE_COUNT_PROPERTY = "maxUseCount";
+    private static final String MAX_USE_TIME_PROPERTY = "maxUseTime";
+    private static final String PRETEST_CONNECTIONS_PROPERTY = "pretestConnections";
+    private static final String RUN_MAINTENANCE_PROPERTY = "runMaintenance";
+    private static final String THREAD_USED_PROPERTY = "threadUsed";
 
     /**
        Indicates that the CCSID used for new connections is the same as the system default CCSID.
@@ -109,13 +126,105 @@ public AS400ConnectionPool()
         initializeTransient();
     }
 
+    /**
+     * Constructs an AS400ConnectionPool from the specified Reference object.
+     *
+     * @param reference to retrieve the ConnectionPool properties from
+     */
+    AS400ConnectionPool(Reference reference) {
+        super();
+        initializeTransient();
+
+        Objects.requireNonNull(reference, "reference");
+        Enumeration<RefAddr> list = reference.getAll();
+        while (list.hasMoreElements()) {
+            RefAddr refAddr = list.nextElement();
+            String property = refAddr.getType();
+            String value = (String) refAddr.getContent();
+            switch (property) {
+                case CCSID_PROPERTY:
+                    setCCSID(Integer.parseInt(value));
+                    break;
+                case CLEANUP_INTERVAL_PROPERTY:
+                    setCleanupInterval(Long.parseLong(value));
+                    break;
+                case MAX_CONNECTIONS_PROPERTY:
+                    setMaxConnections(Integer.parseInt(value));
+                    break;
+                case MAX_INACTIVITY_PROPERTY:
+                    setMaxInactivity(Long.parseLong(value));
+                    break;
+                case MAX_LIFETIME_PROPERTY:
+                    setMaxLifetime(Long.parseLong(value));
+                    break;
+                case MAX_USE_COUNT_PROPERTY:
+                    setMaxUseCount(Integer.parseInt(value));
+                    break;
+                case MAX_USE_TIME_PROPERTY:
+                    setMaxUseTime(Long.parseLong(value));
+                    break;
+                case PRETEST_CONNECTIONS_PROPERTY:
+                    setPretestConnections(Boolean.parseBoolean(value));
+                    break;
+                case RUN_MAINTENANCE_PROPERTY:
+                    setRunMaintenance(Boolean.parseBoolean(value));
+                    break;
+                case THREAD_USED_PROPERTY:
+                    setThreadUsed(Boolean.parseBoolean(value));
+                    break;
+                default:
+                    if (SocketProperties.isSocketProperty(property)) {
+                        socketProperties_.restore(property, value);
+                    }
+                    break;
+            }
+        }
+    }
+
+    /**
+     * Returns the Reference object for the pool object. This is used by
+     * JNDI when bound in a JNDI naming service. Contains the information
+     * necessary to reconstruct the pool object when it is later
+     * retrieved from JNDI via an object factory.
+     *
+     * @return A Reference object of the pool object.
+     * @exception NamingException If a naming error occurs in resolving the
+     * object.
+     *
+     */
+    @Override
+    public Reference getReference() throws NamingException {
+        Trace.log(Trace.INFORMATION, "AS400ConnectionPool.getReference"); 
+
+        Reference ref = new Reference(this.getClass().getName(),
+                                     AS400ObjectFactory.class.getName(),
+                                      null);
+
+        ref.add(new StringRefAddr(CCSID_PROPERTY, Integer.toString(getCCSID())));
+        ref.add(new StringRefAddr(CLEANUP_INTERVAL_PROPERTY, Long.toString(getCleanupInterval())));
+        ref.add(new StringRefAddr(MAX_CONNECTIONS_PROPERTY, Integer.toString(getMaxConnections())));
+        ref.add(new StringRefAddr(MAX_INACTIVITY_PROPERTY, Long.toString(getMaxInactivity())));
+        ref.add(new StringRefAddr(MAX_LIFETIME_PROPERTY, Long.toString(getMaxLifetime())));
+        ref.add(new StringRefAddr(MAX_USE_COUNT_PROPERTY, Integer.toString(getMaxUseCount())));
+        ref.add(new StringRefAddr(MAX_USE_TIME_PROPERTY, Long.toString(getMaxUseTime())));
+        ref.add(new StringRefAddr(PRETEST_CONNECTIONS_PROPERTY, Boolean.toString(isPretestConnections())));
+        ref.add(new StringRefAddr(RUN_MAINTENANCE_PROPERTY, Boolean.toString(isRunMaintenance())));
+        ref.add(new StringRefAddr(THREAD_USED_PROPERTY, Boolean.toString(isThreadUsed())));
+
+        // Add the Socket options
+        socketProperties_.save(ref);
+
+        return ref;
+    }
+
     /**
      * Remove any connections that have exceeded maximum inactivity time, replace any 
      * that have aged past maximum usage or maximum lifetime, and remove any that have 
      * been in use too long.
      *
      * @see ConnectionPoolProperties
      **/
+    @Override
     void cleanupConnections()
     {
         synchronized (as400ConnectionPool_)
@@ -148,6 +257,7 @@ void cleanupConnections()
     /**
      * Close and cleanup the connection pool.
      **/
+    @Override
     public void close()
     {
         log(ResourceBundleLoader.getText("AS400CP_SHUTDOWN"));

src/main/java/com/ibm/as400/access/AS400JDBCDataSource.java

@@ -105,15 +105,6 @@ public class AS400JDBCDataSource
     private static final int MAX_THRESHOLD = 16777216;                  // Maximum threshold (bytes). @A3C, @A4A
     static final int MAX_SCALE = 63;                            // Maximum decimal scale
 
-    // socket options to store away in JNDI
-    private static final String SOCKET_KEEP_ALIVE = "soKeepAlive"; // @F1A
-    private static final String SOCKET_RECEIVE_BUFFER_SIZE = "soReceiveBufferSize"; // @F1A
-    private static final String SOCKET_SEND_BUFFER_SIZE = "soSendBufferSize"; // @F1A
-    private static final String SOCKET_LINGER = "soLinger"; // @F1A
-    private static final String SOCKET_TIMEOUT = "soTimeout"; // @F1A
-    private static final String SOCKET_LOGIN_TIMEOUT = "loginTimeout"; // @st3
-    private static final String SOCKET_TCP_NO_DELAY = "soTCPNoDelay"; // @F1A
-
     // Data source properties.
     transient private AS400 as400_;                           // AS400 object used to store and encrypt the password.
     // @J2d private String databaseName_ = "";                // Database name. @A6C
@@ -373,26 +364,8 @@ else if (property.equals(SAVE_PASSWORD)) {
                 // set the savePasswordWhenSerialized_ flag
                 savePasswordWhenSerialized_ = value.equals(TRUE_) ? true : false;
             }
-            else if (property.equals(SOCKET_KEEP_ALIVE)) {
-                sockProps_.setKeepAlive((value.equals(TRUE_)? true : false));
-            }
-            else if (property.equals(SOCKET_RECEIVE_BUFFER_SIZE)) {
-                sockProps_.setReceiveBufferSize(Integer.parseInt(value));
-            }
-            else if (property.equals(SOCKET_SEND_BUFFER_SIZE)) {
-                sockProps_.setSendBufferSize(Integer.parseInt(value));
-            }
-            else if (property.equals(SOCKET_LINGER)) {
-                sockProps_.setSoLinger(Integer.parseInt(value));
-            }
-            else if (property.equals(SOCKET_TIMEOUT)) {
-                sockProps_.setSoTimeout(Integer.parseInt(value));
-            }
-            else if (property.equals(SOCKET_LOGIN_TIMEOUT)) {        //@st3
-                sockProps_.setLoginTimeout(Integer.parseInt(value)); //@st3
-            }
-            else if (property.equals(SOCKET_TCP_NO_DELAY)) {
-                sockProps_.setTcpNoDelay((value.equals(TRUE_)? true : false));
+            else if (SocketProperties.isSocketProperty(property)) {
+                sockProps_.restore(property, value);
             }
             else
             {
@@ -431,11 +404,12 @@ public void addPropertyChangeListener(PropertyChangeListener listener)
      * Method to create a clone of AS400JDBCDataSource. This does a shallow
      * copy, with the exception of JDProperties, which also gets cloned.
      */
+    @Override
     public Object clone()
     {
         try
         {
-            Trace.log(Trace.INFORMATION, "AS400JDBCDataSource.close()"); 
+            Trace.log(Trace.INFORMATION, "AS400JDBCDataSource.clone()"); 
             AS400JDBCDataSource clone = (AS400JDBCDataSource) super.clone();
             clone.properties_ = (JDProperties) this.properties_.clone();
             return clone;
@@ -1178,6 +1152,7 @@ public String getProxyServer()
     *  @return A Reference object of the data source object.
     *  @exception NamingException If a naming error occurs in resolving the object.
     **/
+    @Override
     public Reference getReference() throws NamingException
     {
 
@@ -1196,13 +1171,7 @@ public Reference getReference() throws NamingException
         }
 
         // Add the Socket options
-        if (sockProps_.keepAliveSet_) ref.add(new StringRefAddr(SOCKET_KEEP_ALIVE, (sockProps_.keepAlive_ ? "true" : "false")));
-        if (sockProps_.receiveBufferSizeSet_) ref.add(new StringRefAddr(SOCKET_RECEIVE_BUFFER_SIZE, Integer.toString(sockProps_.receiveBufferSize_)));
-        if (sockProps_.sendBufferSizeSet_) ref.add(new StringRefAddr(SOCKET_SEND_BUFFER_SIZE, Integer.toString(sockProps_.sendBufferSize_)));
-        if (sockProps_.soLingerSet_) ref.add(new StringRefAddr(SOCKET_LINGER, Integer.toString(sockProps_.soLinger_)));
-        if (sockProps_.soTimeoutSet_) ref.add(new StringRefAddr(SOCKET_TIMEOUT, Integer.toString(sockProps_.soTimeout_)));
-        if (sockProps_.loginTimeoutSet_) ref.add(new StringRefAddr(SOCKET_LOGIN_TIMEOUT, Integer.toString(sockProps_.loginTimeout_))); //@st3
-        if (sockProps_.tcpNoDelaySet_) ref.add(new StringRefAddr(SOCKET_TCP_NO_DELAY, (sockProps_.tcpNoDelay_ ? "true" : "false")));
+        sockProps_.save(ref);
 
         // Add the data source properties.  (unique constant identifiers for storing in JNDI).
         if (getDatabaseName() != null)

src/main/java/com/ibm/as400/access/AS400JDBCManagedDataSource.java

@@ -116,17 +116,6 @@ public class AS400JDBCManagedDataSource extends ToolboxWrapper
   private static final String TOOLBOX_DRIVER = "jdbc:as400:";
   private static final int MAX_THRESHOLD = 16777216; // Maximum threshold (bytes).
 
-  // socket options to store away in JNDI
-  private static final String SOCKET_KEEP_ALIVE = "soKeepAlive";
-  // JDProperties: "keep alive"
-  private static final String SOCKET_RECEIVE_BUFFER_SIZE = "soReceiveBufferSize";
-  // JDProperties: "receive buffer size"
-  private static final String SOCKET_SEND_BUFFER_SIZE = "soSendBufferSize";
-  // JDProperties: "send buffer size"
-  private static final String SOCKET_LINGER = "soLinger";
-  private static final String SOCKET_TIMEOUT = "soTimeout";
-  private static final String SOCKET_TCP_NO_DELAY = "soTCPNoDelay";
-
   // Standard data source properties. (See JDBC Tutorial p. 567, table 16.1)
 
   transient private AS400 as400_; // Object used to store and encrypt the password.
@@ -365,18 +354,8 @@ else if (property.equals(USER)) {
           || property.equals(KEY_RING_PASSWORD)) {
         // Do nothing for these keys. They've already been handled prior to loop,
         // and we don't want them added to JDProperties.
-      } else if (property.equals(SOCKET_KEEP_ALIVE)) {
-        sockProps_.setKeepAlive((value.equals(TRUE_) ? true : false));
-      } else if (property.equals(SOCKET_RECEIVE_BUFFER_SIZE)) {
-        sockProps_.setReceiveBufferSize(Integer.parseInt(value));
-      } else if (property.equals(SOCKET_SEND_BUFFER_SIZE)) {
-        sockProps_.setSendBufferSize(Integer.parseInt(value));
-      } else if (property.equals(SOCKET_LINGER)) {
-        sockProps_.setSoLinger(Integer.parseInt(value));
-      } else if (property.equals(SOCKET_TIMEOUT)) {
-        sockProps_.setSoTimeout(Integer.parseInt(value));
-      } else if (property.equals(SOCKET_TCP_NO_DELAY)) {
-        sockProps_.setTcpNoDelay((value.equals(TRUE_) ? true : false));
+      } else if (SocketProperties.isSocketProperty(property)) {
+        sockProps_.restore(property, value);
       } else if (isConnectionPoolDataSource
           && AS400JDBCManagedConnectionPoolDataSource.isConnectionPoolProperty(property)) {
         // Ignore this property, the subclass will consume it.
@@ -1494,18 +1473,7 @@ public Reference getReference() throws NamingException {
     }
 
     // Add the Socket options
-    if (sockProps_.keepAliveSet_)
-      ref.add(new StringRefAddr(SOCKET_KEEP_ALIVE, (sockProps_.keepAlive_ ? "true" : "false")));
-    if (sockProps_.receiveBufferSizeSet_)
-      ref.add(new StringRefAddr(SOCKET_RECEIVE_BUFFER_SIZE, Integer.toString(sockProps_.receiveBufferSize_)));
-    if (sockProps_.sendBufferSizeSet_)
-      ref.add(new StringRefAddr(SOCKET_SEND_BUFFER_SIZE, Integer.toString(sockProps_.sendBufferSize_)));
-    if (sockProps_.soLingerSet_)
-      ref.add(new StringRefAddr(SOCKET_LINGER, Integer.toString(sockProps_.soLinger_)));
-    if (sockProps_.soTimeoutSet_)
-      ref.add(new StringRefAddr(SOCKET_TIMEOUT, Integer.toString(sockProps_.soTimeout_)));
-    if (sockProps_.tcpNoDelaySet_)
-      ref.add(new StringRefAddr(SOCKET_TCP_NO_DELAY, (sockProps_.tcpNoDelay_ ? "true" : "false")));
+    sockProps_.save(ref);
 
     // Add the data source properties. (unique constant identifiers for storing in
     // JNDI).

src/main/java/com/ibm/as400/access/AS400ObjectFactory.java

@@ -0,0 +1,79 @@
+///////////////////////////////////////////////////////////////////////////////
+//                                                                             
+// JTOpen (IBM Toolbox for Java - OSS version)                                 
+//                                                                             
+// Filename: AS400ObjectFactory.java
+//                                                                             
+// The source code contained herein is licensed under the IBM Public License   
+// Version 1.0, which has been approved by the Open Source Initiative.         
+// Copyright (C) 1997-2001 International Business Machines Corporation and     
+// others. All rights reserved.                                                
+//                                                                             
+///////////////////////////////////////////////////////////////////////////////
+package com.ibm.as400.access;
+
+import java.util.Hashtable;
+import javax.naming.Context;           // JNDI
+import javax.naming.Name;              // JNDI
+import javax.naming.Reference;         // JNDI
+import javax.naming.spi.ObjectFactory; // JNDI
+
+/**
+ * The AS400ObjectFactory is used by a JNDI service provider to reconstruct an
+ * object when it is retrieved from JNDI.
+ *
+ * <p>
+ * For Example:
+ * <pre>
+ * AS400ConnectionPool pool = null;
+ * String objFactoryName = "com.ibm.as400.access.AS400ObjectFactory";
+ * String className = "com.ibm.as400.access.AS400ConnectionPool";
+ * Reference ref = new Reference(className, objFactoryName, "");
+ * ref.add(new StringRefAddr("maxConnections", "10"));
+ * try {
+ *     ObjectFactory objectFactory = (ObjectFactory) Class.forName(objFactoryName).newInstance();
+ *     pool = (AS400ConnectionPool) objectFactory.getObjectInstance(ref, null, null, null);
+ *     AS400 as400 = pool.getConnection("myAS400", "myUserID", "myPassword".toCharArray());
+ * } catch (Exception ex) {
+ *     ex.printStackTrace();
+ *     System.err.println("Exception caught: " + ex);
+ * }
+ * </pre>
+ * The following classes implement the javax.naming.Referenceable interface.
+ *
+ * @see com.ibm.as400.access.AS400ConnectionPool
+ *
+ */
+@SuppressWarnings("UseOfObsoleteCollectionType")
+public class AS400ObjectFactory implements ObjectFactory {
+
+    static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
+
+    /**
+     * Returns the object requested.
+     *
+     * @param referenceObject The object reference.
+     * @param name The object name.
+     * @param nameContext The context of the name.
+     * @param environment The environment.
+     * @return The object requested.
+     * @exception Exception If an error occurs during object creation.
+     *
+     */
+    @Override
+    public Object getObjectInstance(Object referenceObject,
+            Name name,
+            Context nameContext,
+            Hashtable<?, ?> environment) throws Exception {
+        Reference reference = (Reference) referenceObject;
+
+        if (reference.getClassName().equals(AS400ConnectionPool.class.getName())) {
+            return new AS400ConnectionPool(reference);
+        } else {
+            if (JDTrace.isTraceOn()) {
+                JDTrace.logInformation(this, "Lookup error. Class not found: " + reference.getClassName());
+            }
+            return null;
+        }
+    }
+}