1 files changed, 359 insertions, 0 deletions
diff --git a/sandbox/sebastien/java/wrapped/modules/binding-jms-runtime/src/main/java/org/apache/tuscany/sca/binding/jms/provider/JMSResourceFactoryImpl.java b/sandbox/sebastien/java/wrapped/modules/binding-jms-runtime/src/main/java/org/apache/tuscany/sca/binding/jms/provider/JMSResourceFactoryImpl.java
new file mode 100644
index 0000000000..7e56fb2329
--- /dev/null
+++ b/sandbox/sebastien/java/wrapped/modules/binding-jms-runtime/src/main/java/org/apache/tuscany/sca/binding/jms/provider/JMSResourceFactoryImpl.java
@@ -0,0 +1,359 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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.apache.tuscany.sca.binding.jms.provider;
+
+import java.util.Properties;
+
+import javax.jms.Connection;
+import javax.jms.ConnectionFactory;
+import javax.jms.Destination;
+import javax.jms.JMSException;
+import javax.jms.Session;
+import javax.naming.Context;
+import javax.naming.InitialContext;
+import javax.naming.NamingException;
+import javax.naming.NoInitialContextException;
+import javax.resource.spi.ActivationSpec;
+
+import org.apache.tuscany.sca.binding.jms.JMSBindingException;
+import org.apache.tuscany.sca.extensibility.ClassLoaderContext;
+import org.apache.activemq.jndi.ActiveMQInitialContextFactory;
+
+/**
+ * Abstracts away any JMS provide specific feature from the JMS binding
+ * 
+ * @version $Rev$ $Date$
+ */
+public class JMSResourceFactoryImpl implements JMSResourceFactory {
+
+    protected String initialContextFactoryName;
+    protected String connectionFactoryName = "ConnectionFactory";
+    protected String jndiURL;
+
+    protected Connection connection;
+    protected Context context;
+    protected boolean isConnectionStarted;
+    private Connection responseConnection;
+    private String responseConnectionFactoryName;
+
+    public JMSResourceFactoryImpl(String connectionFactoryName, String responseConnectionFactoryName, String initialContextFactoryName, String jndiURL) {
+        if (connectionFactoryName != null && connectionFactoryName.trim().length() > 0) {
+            this.connectionFactoryName = connectionFactoryName.trim();
+        }
+        if (responseConnectionFactoryName != null && responseConnectionFactoryName.trim().length() > 0) {
+            this.responseConnectionFactoryName = responseConnectionFactoryName.trim();
+        }
+        if (initialContextFactoryName != null && initialContextFactoryName.trim().length() > 0) {
+            this.initialContextFactoryName = initialContextFactoryName.trim();
+        }
+        if (jndiURL != null) {
+            this.jndiURL = jndiURL.trim();
+        }
+    }
+
+    /*
+     * This is a simple implementation where a connection is created per binding Ideally the resource factory should be
+     * able to leverage the host environment to provide connection pooling if it can. E.g. if Tuscany is running inside 
+     * an AppServer Then we could leverage the JMS resources it provides
+     * 
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#getConnection()
+     */
+    public Connection getConnection() throws NamingException, JMSException {
+        if (connection == null) {
+            createConnection();
+        }
+        return connection;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#createSession()
+     */
+    public Session createSession() throws JMSException, NamingException {
+        return getConnection().createSession(false, Session.AUTO_ACKNOWLEDGE);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#closeSession(javax.jms.Session)
+     */
+    public void closeSession(Session session) throws JMSException {
+        session.close();
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#startConnection()
+     */
+    public void startConnection() throws JMSException, NamingException {
+        if (!isConnectionStarted) {
+            getConnection().start();
+            isConnectionStarted = true;
+        }
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#closeConnection()
+     */
+    public void closeConnection() throws JMSException {
+        if (connection != null) {
+            try {
+                connection.close();
+            } catch (JMSException e) {
+                // if using an embedded broker then when shutting down Tuscany the broker may get closed
+                // before this stop method is called. I can't see how to detect that so for now just
+                // ignore the exception if the message is that the transport is already disposed
+                if (!e.getMessage().contains("disposed")) {
+                    throw e;
+                }
+            }
+        }
+    }
+
+    protected void createConnection() throws NamingException, JMSException {
+        Object o  = jndiLookUp(connectionFactoryName);
+        if (o == null) {
+            throw new JMSBindingException("connection factory not found: " + connectionFactoryName);
+        }
+    	if (!(o instanceof ConnectionFactory)) { 
+    		throw new JMSBindingException("JNDI resource '" + connectionFactoryName +"' is not a JMS ConnectionFactory");
+    	}
+        ConnectionFactory connectionFactory = (ConnectionFactory)o;
+        connection = connectionFactory.createConnection();
+    }
+   
+    protected synchronized Context getInitialContext() throws NamingException {
+        if (context == null) {
+            Properties props = new Properties();
+
+            if (initialContextFactoryName != null) {
+                props.setProperty(Context.INITIAL_CONTEXT_FACTORY, initialContextFactoryName);
+            }
+            if (jndiURL != null) {
+                props.setProperty(Context.PROVIDER_URL, jndiURL);
+            }
+
+            initJREEnvironment(props);
+            
+            try {
+        		// Load the JNDI InitialContext (will load the InitialContextFactory, if present)
+        		context = new InitialContext(props);
+                if( context == null ) {
+                	throw new NamingException();
+                } else if ( context.getEnvironment().get(InitialContext.INITIAL_CONTEXT_FACTORY) == null ) {
+                	throw new NamingException();
+                } // end if
+            } catch (NamingException e ) {
+            	context = getInitialContextOsgi( props );
+            } // end try
+        	// In the case where the InitialContext fails, check whether performing an OSGi based load succeeds...            
+
+            
+        }
+        return context;
+    } // end method getInitialContext
+    
+    static final String ACTIVEMQ_FACTORY = "org.apache.activemq.jndi.ActiveMQInitialContextFactory";    
+    private Context getInitialContextOsgi( Properties props ) throws NamingException {
+        /**
+         * For OSGi, need to provide access to the InitialContextFactory for the JMS provider that is going to be used.
+         * 
+         * The situation is that the InitialContext constructor instantiates an instance of the InitialContextFactory by
+         * calling "new" using the TCCL - thus there is a need to prepare the TCCL.
+         * 03/12/2010 MJE - for the present, only worry about ActiveMQ - other providers can be added later 
+         * 10/12/2010 MJE - the following code attempts to get the classloader for the ActiveMQ initial context factory
+         *                  it will fail if the ActiveMQ classes are not available in the runtime, but the code will still
+         *                  execute (although under OSGi the new InitialContext() operation will fail to find a suitable
+         *                  InitialContextFactory object...)
+         */
+    	
+    	String contextFactoryName = (String)props.get(Context.INITIAL_CONTEXT_FACTORY);
+    	
+        ClassLoader ActiveMQCl = null;
+        try {
+        	if( contextFactoryName == null || ACTIVEMQ_FACTORY.equals(contextFactoryName) ) {
+	        	ActiveMQCl = ActiveMQInitialContextFactory.class.getClassLoader();
+	        	props.setProperty(Context.INITIAL_CONTEXT_FACTORY, ACTIVEMQ_FACTORY);
+	        	if( props.getProperty(Context.PROVIDER_URL) == null ) {
+	        		props.setProperty(Context.PROVIDER_URL, "vm://localhost?broker.persistent=false" );
+	        	} // end if
+        	} // end if 
+        } catch (Exception e) {
+        	// Nothing to do in this case - the ActiveMQCl classloader will simply be null
+        } // end try 
+
+    	ClassLoader tccl = ClassLoaderContext.setContextClassLoader(JMSResourceFactoryImpl.class.getClassLoader(),
+    			ActiveMQCl,
+    			Thread.currentThread().getContextClassLoader() );
+    	try {
+    		// Load the JNDI InitialContext (will load the InitialContextFactory, if present)
+    		return new InitialContext(props);
+    	} finally {
+            // Restore the TCCL if we changed it
+            if( tccl != null ) Thread.currentThread().setContextClassLoader(tccl);
+    	} // end try
+
+    } // end method getInitialContextOsgi
+
+
+    /**
+     * If using the WAS JMS Client with a non-IBM JRE then an additional
+     * environment property needs to be set to initialize the ORB correctly. 
+     * See: http://www-1.ibm.com/support/docview.wss?uid=swg24012804
+     */
+    protected void initJREEnvironment(Properties props) {
+        if ("com.ibm.websphere.naming.WsnInitialContextFactory".equals(props.get(Context.INITIAL_CONTEXT_FACTORY))) {
+            String vendor = System.getProperty("java.vendor");
+            if (vendor == null || !vendor.contains("IBM")) {
+                props.setProperty("com.ibm.CORBA.ORBInit", "com.ibm.ws.sib.client.ORB");
+            }
+        }
+    }
+
+    /* (non-Javadoc)
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#lookupDestination(java.lang.String)
+     */
+    public Destination lookupDestination(String destName) throws NamingException {
+        if (destName == null) {
+            return null;
+        }
+        
+        Destination dest = (Destination)jndiLookUp(destName);
+        if (dest == null) {
+            dest = lookupPhysical(destName);
+        }
+        return dest;
+    }
+
+    protected Destination lookupPhysical(String jndiName) {
+
+        // TODO: the SCA JMS spec says a destination name may be a non-jndi plain destination name 
+        
+//        Session session = null;
+//        try {
+//
+//            Destination dest;
+//            session = createSession();
+//            dest = session.createQueue(jndiName);
+//            return dest;
+//
+//        } catch (JMSException e) {
+//            throw new JMSBindingException(e);
+//        } catch (NamingException e) {
+//            throw new JMSBindingException(e);
+//        } finally {
+//            if (session != null) {
+//                try {
+//                    session.close();
+//                } catch (JMSException e) {
+//                    throw new JMSBindingException(e);
+//                }
+//            }
+//        }
+        return null;
+    }
+
+    /* (non-Javadoc)
+     * @see org.apache.tuscany.sca.binding.jms.provider.JMSResourceFactory#createDestination(java.lang.String)
+     */
+    public Destination createDestination(String jndiName) throws NamingException {
+    	if ( jndiName == null ) 
+    		return null;
+    	
+        return lookupDestination("dynamicQueues/" + jndiName);
+    }
+
+    protected Object jndiLookUp(String name) {
+        Object o = null;
+        try {
+            o = getInitialContext().lookup("java:comp/env/" + name);
+        } catch (Exception ex) {
+            // ignore
+        }
+        if (o == null) {
+            try {
+                o = getInitialContext().lookup(name);
+            } catch (NamingException ex) {
+                // ignore
+            }
+        }
+        return o;
+    }
+
+    public Session createResponseSession() throws JMSException, NamingException {
+        return getResponseConnection().createSession(false, Session.AUTO_ACKNOWLEDGE);
+    }
+
+    public void closeResponseSession(Session session) throws JMSException {
+        session.close();
+    }
+
+    public Connection getResponseConnection() throws NamingException, JMSException {
+        if (responseConnection == null) {
+            if (responseConnectionFactoryName != null) {
+                ConnectionFactory connectionFactory = (ConnectionFactory)jndiLookUp(responseConnectionFactoryName);
+                if (connectionFactory == null) {
+                    throw new JMSBindingException("connection factory not found: " + responseConnectionFactoryName);
+                }
+                responseConnection = connectionFactory.createConnection();
+            } else {
+                // if no response connection is defined in the SCDL use the request connection
+                responseConnection = getConnection();
+            }
+        }
+        return responseConnection;
+    }
+
+    public void closeResponseConnection() throws JMSException {
+        if (responseConnection != null && !responseConnection.equals(connection)) {
+            try {
+                responseConnection.close();
+            } catch (JMSException e) {
+                // if using an embedded broker then when shutting down Tuscany the broker may get closed
+                // before this stop method is called. I can't see how to detect that so for now just
+                // ignore the exception if the message is that the transport is already disposed
+                if (!e.getMessage().contains("disposed")) {
+                    throw e;
+                }
+            }
+        }
+    }
+
+    public boolean isConnectionClosedAfterUse() {
+        // It is assumed this resource factory is used in an environment
+        // where the connection can be held for the life of the binding.
+        return false;
+    }
+
+	public ActivationSpec lookupActivationSpec(String activationSpecName) {
+		Object o = jndiLookUp(activationSpecName);
+		if ( o == null ) 
+			return null;
+		else if (o instanceof ActivationSpec) 
+			return (ActivationSpec) o;
+		
+		throw new JMSBindingException("Incorrect resource type for ActivationSpec: " + o.getClass().getName());
+	}
+
+}