/* * 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.lang.reflect.InvocationTargetException; import javax.jms.Destination; import javax.jms.JMSException; import javax.jms.Message; import javax.jms.MessageConsumer; import javax.jms.MessageProducer; import javax.jms.Session; import javax.naming.NamingException; import org.apache.tuscany.sca.binding.jms.impl.JMSBinding; import org.apache.tuscany.sca.binding.jms.impl.JMSBindingConstants; import org.apache.tuscany.sca.binding.jms.impl.JMSBindingException; import org.apache.tuscany.sca.interfacedef.Operation; import org.apache.tuscany.sca.invocation.Invoker; import org.apache.tuscany.sca.invocation.DataExchangeSemantics; import org.osoa.sca.ServiceRuntimeException; /** * Interceptor for the JMS binding. * * @version $Rev$ $Date$ */ public class JMSBindingInvoker implements Invoker, DataExchangeSemantics { protected Operation operation; protected String operationName; protected JMSBinding jmsBinding; protected JMSResourceFactory jmsResourceFactory; protected JMSMessageProcessor requestMessageProcessor; protected JMSMessageProcessor responseMessageProcessor; protected Destination requestDest; protected Destination replyDest; public JMSBindingInvoker(JMSBinding jmsBinding, Operation operation, JMSResourceFactory jmsResourceFactory) { this.operation = operation; operationName = operation.getName(); this.jmsBinding = jmsBinding; this.jmsResourceFactory = jmsResourceFactory; requestMessageProcessor = jmsBinding.getRequestMessageProcessor(); responseMessageProcessor = jmsBinding.getResponseMessageProcessor(); try { requestDest = lookupDestination(); replyDest = lookupResponseDestination(); } catch (NamingException e) { throw new JMSBindingException(e); } } /** * Looks up the Destination Queue for the JMS Binding * * @return The Destination Queue * @throws NamingException Failed to lookup Destination Queue * @throws JMSBindingException Failed to lookup Destination Queue * @see #lookupDestinationQueue(boolean) */ private Destination lookupDestination() throws NamingException, JMSBindingException { return lookupDestinationQueue(false); } /** * Looks up the Destination Response Queue for the JMS Binding * * @return The Destination Response Queue * @throws NamingException Failed to lookup Destination Response Queue * @throws JMSBindingException Failed to lookup Destination Response Queue * @see #lookupDestinationQueue(boolean) */ private Destination lookupResponseDestination() throws NamingException, JMSBindingException { return lookupDestinationQueue(true); } /** * Looks up the Destination Queue for the JMS Binding. *
* What happens in the look up will depend on the create mode specified for the JMS Binding: *
*
* @param isReponseQueue true
if we are creating a response queue. false
if we are
* creating a request queue
* @return The Destination queue.
* @throws NamingException Failed to lookup JMS queue
* @throws JMSBindingException Failed to lookup JMS Queue. Probable cause is that the JMS queue's current
* existence/non-existence is not compatible with the create mode specified on the binding
*/
private Destination lookupDestinationQueue(boolean isReponseQueue) throws NamingException, JMSBindingException {
String queueName;
String queueType;
String qCreateMode;
if (isReponseQueue) {
queueName = jmsBinding.getResponseDestinationName();
queueType = "JMS Response Destination ";
qCreateMode = jmsBinding.getResponseDestinationCreate();
if (JMSBindingConstants.DEFAULT_RESPONSE_DESTINATION_NAME.equals(queueName)) {
return null;
}
} else {
queueName = jmsBinding.getDestinationName();
queueType = "JMS Destination ";
qCreateMode = jmsBinding.getDestinationCreate();
}
Destination dest = jmsResourceFactory.lookupDestination(queueName);
if (qCreateMode.equals(JMSBindingConstants.CREATE_ALWAYS)) {
// In this mode, the queue must not already exist as we are creating it
if (dest != null) {
throw new JMSBindingException(queueType + queueName
+ " already exists but has create mode of \""
+ qCreateMode
+ "\" while registering binding "
+ jmsBinding.getName()
+ " invoker");
}
// Create the queue
dest = jmsResourceFactory.createDestination(queueName);
} else if (qCreateMode.equals(JMSBindingConstants.CREATE_IF_NOT_EXIST)) {
// In this mode, the queue may nor may not exist. It will be created if it does not exist
if (dest == null) {
dest = jmsResourceFactory.createDestination(queueName);
}
} else if (qCreateMode.equals(JMSBindingConstants.CREATE_NEVER)) {
// In this mode, the queue must have already been created.
if (dest == null) {
throw new JMSBindingException(queueType + queueName
+ " not found but create mode of \""
+ qCreateMode
+ "\" while registering binding "
+ jmsBinding.getName()
+ " invoker");
}
}
// Make sure we ended up with a queue
if (dest == null) {
throw new JMSBindingException(queueType + queueName
+ " not found with create mode of \""
+ qCreateMode
+ "\" while registering binding "
+ jmsBinding.getName()
+ " invoker");
}
return dest;
}
public org.apache.tuscany.sca.invocation.Message invoke(org.apache.tuscany.sca.invocation.Message msg) {
try {
Object resp = invokeTarget((Object[])msg.getBody(), (short)0);
msg.setBody(resp);
} catch (InvocationTargetException e) {
msg.setFaultBody(e.getCause());
} catch (ServiceRuntimeException e) {
if (e.getCause() instanceof InvocationTargetException) {
if ((e.getCause().getCause() instanceof RuntimeException)) {
msg.setFaultBody(e.getCause());
} else {
msg.setFaultBody(e.getCause().getCause());
}
} else {
msg.setFaultBody(e);
}
} catch (Throwable e) {
msg.setFaultBody(e);
}
return msg;
}
public Object invokeTarget(Object payload, final short sequence) throws InvocationTargetException {
try {
Session session = jmsResourceFactory.createSession();
try {
Destination replyToDest;
if (operation.isNonBlocking()) {
replyToDest = null;
} else {
replyToDest = (replyDest != null) ? replyDest : session.createTemporaryQueue();
}
Message requestMsg = sendRequest((Object[])payload, session, replyToDest);
if (replyToDest == null) {
return null;
} else {
Message replyMsg = receiveReply(session, replyToDest, requestMsg.getJMSMessageID());
return ((Object[])responseMessageProcessor.extractPayloadFromJMSMessage(replyMsg))[0];
}
} finally {
session.close();
}
} catch (JMSException e) {
throw new InvocationTargetException(e);
} catch (NamingException e) {
throw new InvocationTargetException(e);
}
}
protected Message sendRequest(Object payload, Session session, Destination replyToDest) throws JMSException {
Message requestMsg = requestMessageProcessor.insertPayloadIntoJMSMessage(session, payload);
requestMsg.setJMSDeliveryMode(jmsBinding.getDeliveryMode());
requestMsg.setJMSPriority(jmsBinding.getPriority());
requestMessageProcessor.setOperationName(operationName, requestMsg);
requestMsg.setJMSReplyTo(replyToDest);
MessageProducer producer = session.createProducer(requestDest);
try {
producer.send(requestMsg);
} finally {
producer.close();
}
return requestMsg;
}
protected Message receiveReply(Session session, Destination replyToDest, String requestMsgId) throws JMSException,
NamingException {
String msgSelector = "JMSCorrelationID = '" + requestMsgId + "'";
MessageConsumer consumer = session.createConsumer(replyToDest, msgSelector);
Message replyMsg;
try {
jmsResourceFactory.startConnection();
replyMsg = consumer.receive(jmsBinding.getTimeToLive());
} finally {
consumer.close();
}
if (replyMsg == null) {
throw new JMSBindingException("No reply message received on " + replyToDest + " for message id " + requestMsgId);
}
return replyMsg;
}
public boolean allowsPassByReference() {
// JMS always pass by value
return true;
}
}