/*
* 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 javax.jms.JMSException;
import javax.jms.MessageListener;
import javax.naming.NamingException;
import org.apache.tuscany.sca.binding.jms.JMSBinding;
import org.apache.tuscany.sca.binding.jms.JMSBindingException;
import org.apache.tuscany.sca.binding.jms.headers.HeaderReferenceInterceptor;
import org.apache.tuscany.sca.binding.jms.host.AsyncResponseJMSServiceListener;
import org.apache.tuscany.sca.binding.jms.host.JMSAsyncResponseInvoker;
import org.apache.tuscany.sca.binding.jms.transport.TransportReferenceInterceptor;
import org.apache.tuscany.sca.core.ExtensionPointRegistry;
import org.apache.tuscany.sca.core.FactoryExtensionPoint;
import org.apache.tuscany.sca.core.UtilityExtensionPoint;
import org.apache.tuscany.sca.interfacedef.InterfaceContract;
import org.apache.tuscany.sca.interfacedef.Operation;
import org.apache.tuscany.sca.invocation.InvocationChain;
import org.apache.tuscany.sca.invocation.Invoker;
import org.apache.tuscany.sca.invocation.MessageFactory;
import org.apache.tuscany.sca.invocation.Phase;
import org.apache.tuscany.sca.provider.EndpointReferenceAsyncProvider;
import org.apache.tuscany.sca.provider.ProviderFactoryExtensionPoint;
import org.apache.tuscany.sca.provider.WireFormatProvider;
import org.apache.tuscany.sca.provider.WireFormatProviderFactory;
import org.apache.tuscany.sca.runtime.RuntimeComponentReference;
import org.apache.tuscany.sca.runtime.RuntimeEndpointReference;
import org.apache.tuscany.sca.work.WorkScheduler;
/**
* Implementation of the JMS reference binding provider.
*
* This version supports native async service invocations
*
* @version $Rev: 1222193 $ $Date: 2011-12-22 12:00:24 +0000 (Thu, 22 Dec 2011) $
*/
public class JMSBindingReferenceBindingProvider implements EndpointReferenceAsyncProvider {
protected RuntimeEndpointReference endpointReference;
protected RuntimeComponentReference reference;
protected JMSBinding jmsBinding;
protected JMSResourceFactory jmsResourceFactory;
protected InterfaceContract interfaceContract;
protected ExtensionPointRegistry extensions;
protected ProviderFactoryExtensionPoint providerFactories;
protected WireFormatProviderFactory requestWireFormatProviderFactory;
protected WireFormatProvider requestWireFormatProvider;
protected WireFormatProviderFactory responseWireFormatProviderFactory;
protected WireFormatProvider responseWireFormatProvider;
protected AsyncResponseJMSServiceListener responseQueue = null;
public JMSBindingReferenceBindingProvider(RuntimeEndpointReference endpointReference, ExtensionPointRegistry extensions, JMSResourceFactory jmsResourceFactory) {
this.endpointReference = endpointReference;
this.reference = (RuntimeComponentReference) endpointReference.getReference();
this.jmsBinding = (JMSBinding) endpointReference.getBinding();
this.extensions = extensions;
this.jmsResourceFactory = jmsResourceFactory;
// Get the factories/providers for operation selection
this.providerFactories = extensions.getExtensionPoint(ProviderFactoryExtensionPoint.class);
// Get the factories/providers for wire format
this.requestWireFormatProviderFactory =
(WireFormatProviderFactory)providerFactories.getProviderFactory(jmsBinding.getRequestWireFormat().getClass());
if (this.requestWireFormatProviderFactory != null){
this.requestWireFormatProvider = requestWireFormatProviderFactory.createReferenceWireFormatProvider(endpointReference);
}
this.responseWireFormatProviderFactory =
(WireFormatProviderFactory)providerFactories.getProviderFactory(jmsBinding.getResponseWireFormat().getClass());
if (this.responseWireFormatProviderFactory != null){
this.responseWireFormatProvider = responseWireFormatProviderFactory.createReferenceWireFormatProvider(endpointReference);
}
// create an interface contract that reflects both request and response
// wire formats
try {
interfaceContract = (InterfaceContract)reference.getInterfaceContract().clone();
requestWireFormatProvider.configureWireFormatInterfaceContract(interfaceContract);
responseWireFormatProvider.configureWireFormatInterfaceContract(interfaceContract);
} catch (CloneNotSupportedException ex){
interfaceContract = reference.getInterfaceContract();
} // end try
// If the service is asyncInvocation, then create a fixed response location
if( endpointReference.isAsyncInvocation() ) {
String asyncCallbackName = endpointReference.getReference().getName() + "_asyncResponse";
jmsBinding.setResponseDestinationName(asyncCallbackName);
} // end if
} // end constructor
public Invoker createInvoker(Operation operation) {
if (jmsBinding.getDestinationName() == null) {
throw new JMSBindingException("No destination specified for reference " + reference.getName());
} // end if
if ( jmsBinding.getActivationSpecName() != null ) {
throw new JMSBindingException("Activation spec can not be specified on an SCA reference binding.");
}
Invoker invoker = null;
invoker = new RRBJMSBindingInvoker(operation, jmsResourceFactory, endpointReference);
return invoker;
} // end method createInvoker
public boolean supportsOneWayInvocation() {
return true;
}
public InterfaceContract getBindingInterfaceContract() {
return interfaceContract;
}
public void start() {
// If the reference is async invocation, then a response queue handler and associated JMS listener must be created
// and started
if (endpointReference.isAsyncInvocation()) {
// Create the JMS listener
FactoryExtensionPoint modelFactories = extensions.getExtensionPoint(FactoryExtensionPoint.class);
MessageFactory messageFactory = modelFactories.getFactory(MessageFactory.class);
MessageListener listener;
try {
listener = new JMSAsyncResponseInvoker(endpointReference, messageFactory, jmsResourceFactory);
} catch (NamingException e) {
throw new JMSBindingException("Unable to create JMSResponseInvoker", e);
} // end try
// Create the response queue handler
UtilityExtensionPoint utilities = extensions.getExtensionPoint(UtilityExtensionPoint.class);
WorkScheduler workScheduler = utilities.getUtility(WorkScheduler.class);
responseQueue = new AsyncResponseJMSServiceListener(listener,
jmsBinding.getResponseDestinationName(),
jmsBinding, workScheduler, jmsResourceFactory);
responseQueue.start();
} // end if
} // end method start
public void stop() {
try {
if( responseQueue != null ) {
responseQueue.stop();
} // end if
jmsResourceFactory.closeConnection();
jmsResourceFactory.closeResponseConnection();
} catch (JMSException e) {
throw new JMSBindingException(e);
}
} // end method stop
/*
* set up the reference binding wire with the right set of jms reference
* interceptors
*/
public void configure() {
InvocationChain bindingChain = endpointReference.getBindingInvocationChain();
// add transport interceptor
bindingChain.addInterceptor(Phase.REFERENCE_BINDING_TRANSPORT,
new TransportReferenceInterceptor(jmsBinding,
jmsResourceFactory,
endpointReference) );
// add request wire format
bindingChain.addInterceptor(requestWireFormatProvider.getPhase(),
requestWireFormatProvider.createInterceptor());
// add response wire format, but only add it if it's different from the request
if (!jmsBinding.getRequestWireFormat().equals(jmsBinding.getResponseWireFormat())){
bindingChain.addInterceptor(responseWireFormatProvider.getPhase(),
responseWireFormatProvider.createInterceptor());
}
// add the header processor that comes after the wire formatter but before the
// policy interceptors
bindingChain.addInterceptor(Phase.REFERENCE_BINDING_WIREFORMAT,
new HeaderReferenceInterceptor(extensions,
jmsBinding,
jmsResourceFactory,
endpointReference) );
}
/**
* Indicates that this binding supports async invocations natively
*/
public boolean supportsNativeAsync() {
return true;
} // end method supportsNativeAsync
public JMSResourceFactory getJMSResourceFactory() {
return jmsResourceFactory;
}
} // end class