/* * 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.impl; import static javax.xml.stream.XMLStreamConstants.END_ELEMENT; import static javax.xml.stream.XMLStreamConstants.START_ELEMENT; import java.util.Map; import java.util.StringTokenizer; import javax.xml.namespace.QName; import javax.xml.stream.XMLStreamException; import javax.xml.stream.XMLStreamReader; import javax.xml.stream.XMLStreamWriter; import org.apache.tuscany.sca.assembly.builder.impl.ProblemImpl; import org.apache.tuscany.sca.assembly.xml.Constants; import org.apache.tuscany.sca.assembly.xml.PolicyAttachPointProcessor; import org.apache.tuscany.sca.contribution.ModelFactoryExtensionPoint; import org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor; import org.apache.tuscany.sca.contribution.resolver.DefaultModelResolver; import org.apache.tuscany.sca.contribution.resolver.ExtensibleModelResolver; import org.apache.tuscany.sca.contribution.resolver.ModelResolver; import org.apache.tuscany.sca.contribution.service.ContributionReadException; import org.apache.tuscany.sca.contribution.service.ContributionResolveException; import org.apache.tuscany.sca.contribution.service.ContributionWriteException; import org.apache.tuscany.sca.monitor.Monitor; import org.apache.tuscany.sca.monitor.Problem; import org.apache.tuscany.sca.monitor.Problem.Severity; import org.apache.tuscany.sca.policy.PolicyFactory; /** * A processor to read the XML that describes the JMS binding... * * * * * * * ? * * * * * ? * * * * * ? * * * * * * ? * * * * * ? * * * * * ? * ? * * * * * * ? * * * ? * * * * * ? * * * * * * * * ? * * * * * @version $Rev$ $Date$ */ public class JMSBindingProcessor implements StAXArtifactProcessor { private PolicyFactory policyFactory; private PolicyAttachPointProcessor policyProcessor; private Monitor monitor; public JMSBindingProcessor(ModelFactoryExtensionPoint modelFactories, Monitor monitor) { this.policyFactory = modelFactories.getFactory(PolicyFactory.class); this.policyProcessor = new PolicyAttachPointProcessor(policyFactory); this.monitor = monitor; } /** * Report a error. * * @param problems * @param message * @param model */ private void warning(String message, Object model, Object... messageParameters) { if (monitor != null) { Problem problem = new ProblemImpl(this.getClass().getName(), "binding-jms-validation-messages", Severity.WARNING, model, message, (Object[])messageParameters); monitor.problem(problem); } } /** * Report a error. * * @param problems * @param message * @param model */ private void error(String message, Object model, Object... messageParameters) { if (monitor != null) { Problem problem = new ProblemImpl(this.getClass().getName(), "binding-jms-validation-messages", Severity.ERROR, model, message, (Object[])messageParameters); monitor.problem(problem); } } public QName getArtifactType() { return JMSBindingConstants.BINDING_JMS_QNAME; } public Class getModelType() { return JMSBinding.class; } public JMSBinding read(XMLStreamReader reader) throws ContributionReadException, XMLStreamException { JMSBinding jmsBinding = new JMSBinding(); // Read policies policyProcessor.readPolicies(jmsBinding, reader); // Read binding name String name = reader.getAttributeValue(null, "name"); if (name != null) { jmsBinding.setName(name); } // Read binding URI String uri = reader.getAttributeValue(null, "uri"); if (uri != null && uri.length() > 0) { parseURI(uri, jmsBinding); } // Read correlation scheme String correlationScheme = reader.getAttributeValue(null, "correlationScheme"); if (correlationScheme != null && correlationScheme.length() > 0) { if (JMSBindingConstants.VALID_CORRELATION_SCHEMES.contains(correlationScheme.toLowerCase())) { jmsBinding.setCorrelationScheme(correlationScheme); } else { error("InvalidCorrelationScheme", reader, correlationScheme); } } // Read initial context factory String initialContextFactory = reader.getAttributeValue(null, "initialContextFactory"); if (initialContextFactory != null && initialContextFactory.length() > 0) { jmsBinding.setInitialContextFactoryName(initialContextFactory); } // Read JNDI URL String jndiURL = reader.getAttributeValue(null, "jndiURL"); if (jndiURL != null && jndiURL.length() > 0) { jmsBinding.setJndiURL(jndiURL); } // Read message processor class name String messageProcessorName = reader.getAttributeValue(null, "messageProcessor"); if (messageProcessorName != null && messageProcessorName.length() > 0) { if ("XMLTextMessage".equalsIgnoreCase(messageProcessorName)) { messageProcessorName = JMSBindingConstants.XML_MP_CLASSNAME; } else if ("TextMessage".equalsIgnoreCase(messageProcessorName)) { messageProcessorName = JMSBindingConstants.TEXT_MP_CLASSNAME; } else if ("ObjectMessage".equalsIgnoreCase(messageProcessorName)) { messageProcessorName = JMSBindingConstants.OBJECT_MP_CLASSNAME; } jmsBinding.setRequestMessageProcessorName(messageProcessorName); jmsBinding.setResponseMessageProcessorName(messageProcessorName); } String requestConnectionName = reader.getAttributeValue(null, "requestConnection"); if (requestConnectionName != null && requestConnectionName.length() > 0) { jmsBinding.setRequestConnectionName(requestConnectionName); } String responseConnectionName = reader.getAttributeValue(null, "responseConnection"); if (responseConnectionName != null && responseConnectionName.length() > 0) { jmsBinding.setResponseConnectionName(responseConnectionName); } // Read sub-elements of binding.jms boolean endFound = false; while (!endFound) { int fg = reader.next(); switch (fg) { case START_ELEMENT: String elementName = reader.getName().getLocalPart(); if ("destination".equals(elementName)) { parseDestination(reader, jmsBinding); } else if ("connectionFactory".equals(elementName)) { parseConnectionFactory(reader, jmsBinding); } else if ("activationSpec".equals(elementName)) { parseActivationSpec(reader, jmsBinding); } else if ("response".equals(elementName)) { parseResponse(reader, jmsBinding); } else if ("resourceAdapter".equals(elementName)) { parseResourceAdapter(reader, jmsBinding); } else if ("headers".equals(elementName)) { parseHeaders(reader, jmsBinding); } else if ("operationProperties".equals(elementName)) { parseOperationProperties(reader, jmsBinding); } else if ("SubscriptionHeaders".equals(elementName)) { parseSubscriptionHeaders(reader, jmsBinding); } reader.next(); break; case END_ELEMENT: QName x = reader.getName(); if (x.equals(JMSBindingConstants.BINDING_JMS_QNAME)) { endFound = true; } else { error("UnexpectedElement", reader, x.toString()); } } } validate(); return jmsBinding; } protected void parseURI(String uri, JMSBinding jmsBinding) { if (!uri.startsWith("jms:")) { error("MustStartWithSchema", jmsBinding, uri); return; } int i = uri.indexOf('?'); if (i >= 0) { StringTokenizer st = new StringTokenizer(uri.substring(i+1),"&"); while (st.hasMoreTokens()) { String s = st.nextToken(); if (s.startsWith("connectionFactoryName=")) { jmsBinding.setConnectionFactoryName(s.substring(22)); } else { error("UnknownTokenInURI", jmsBinding, s, uri); //throw new JMSBindingException("unknown token '" + s + "' in uri: " + uri); return; } } jmsBinding.setDestinationName(uri.substring(4, i)); } else { jmsBinding.setDestinationName(uri.substring(4)); } } public void resolve(JMSBinding model, ModelResolver resolver) throws ContributionResolveException { if (model.getRequestConnectionName() != null) { model.setRequestConnectionBinding(getConnectionBinding(model.getRequestConnectionName(), resolver)); } if (model.getResponseConnectionName() != null) { model.setResponseConnectionBinding(getConnectionBinding(model.getResponseConnectionName(), resolver)); } } @SuppressWarnings("unchecked") private JMSBinding getConnectionBinding(String bindingName, ModelResolver resolver) { if (resolver instanceof ExtensibleModelResolver) { DefaultModelResolver dr = (DefaultModelResolver)((ExtensibleModelResolver) resolver).getDefaultModelResolver(); Map models = dr.getModels(); for (Object o : models.keySet()) { if (o instanceof JMSBinding) { JMSBinding binding = (JMSBinding) o; if (bindingName.equals(binding.getName())) { return binding; } } } } return null; } public void write(JMSBinding rmiBinding, XMLStreamWriter writer) throws ContributionWriteException, XMLStreamException { // Write a writer.writeStartElement(Constants.SCA10_NS, JMSBindingConstants.BINDING_JMS); // FIXME Implement writer.writeEndElement(); } private void parseDestination(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { jmsBinding.setDestinationName(name); } String type = reader.getAttributeValue(null, "type"); if (type != null && type.length() > 0) { warning("DoesntProcessDestinationType", jmsBinding); if (JMSBindingConstants.DESTINATION_TYPE_QUEUE.equalsIgnoreCase(type)) { jmsBinding.setDestinationType(JMSBindingConstants.DESTINATION_TYPE_QUEUE); } else if (JMSBindingConstants.DESTINATION_TYPE_TOPIC.equalsIgnoreCase(type)) { jmsBinding.setDestinationType(JMSBindingConstants.DESTINATION_TYPE_TOPIC); } else { warning("InvalidDestinationType", reader, type); } } String create = reader.getAttributeValue(null, "create"); if (create != null && create.length() > 0) { jmsBinding.setDestinationCreate(create); } } private void parseConnectionFactory(XMLStreamReader reader, JMSBinding jmsBinding) { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { jmsBinding.setConnectionFactoryName(name); } else { error("MissingConnectionFactoryName", reader); } } private void parseActivationSpec(XMLStreamReader reader, JMSBinding jmsBinding) { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { warning("DoesntProcessActivationSpec", jmsBinding); jmsBinding.setActivationSpecName(name); } else { warning("MissingActivationSpecName", reader); } } private void parseResponseDestination(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { jmsBinding.setResponseDestinationName(name); } String type = reader.getAttributeValue(null, "type"); if (type != null && type.length() > 0) { warning("DoesntProcessResponseDestinationType", jmsBinding); if (JMSBindingConstants.DESTINATION_TYPE_QUEUE.equalsIgnoreCase(type)) { jmsBinding.setResponseDestinationType(JMSBindingConstants.DESTINATION_TYPE_QUEUE); } else if (JMSBindingConstants.DESTINATION_TYPE_TOPIC.equalsIgnoreCase(type)) { jmsBinding.setResponseDestinationType(JMSBindingConstants.DESTINATION_TYPE_TOPIC); } else { warning("InvalidResponseDestinationType", reader, type); } } String create = reader.getAttributeValue(null, "create"); if (create != null && create.length() > 0) { jmsBinding.setResponseDestinationCreate(create); } } private void parseResponseConnectionFactory(XMLStreamReader reader, JMSBinding jmsBinding) { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { warning("DoesntProcessResponseConnectionFactory", jmsBinding); jmsBinding.setResponseConnectionFactoryName(name); } else { warning("MissingResponseConnectionFactory", reader); } } private void parseResponseActivationSpec(XMLStreamReader reader, JMSBinding jmsBinding) { String name = reader.getAttributeValue(null, "name"); if (name != null && name.length() > 0) { warning("DoesntProcessResponseActivationSpec", jmsBinding); jmsBinding.setResponseActivationSpecName(name); } else { warning("MissingResponseActivationSpec", reader); } } private void parseResponse(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { // Read sub-elements of response while (true) { switch (reader.next()) { case START_ELEMENT: String elementName = reader.getName().getLocalPart(); if ("destination".equals(elementName)) { parseResponseDestination(reader, jmsBinding); } else if ("connectionFactory".equals(elementName)) { parseResponseConnectionFactory(reader, jmsBinding); } else if ("activationSpec".equals(elementName)) { parseResponseActivationSpec(reader, jmsBinding); } reader.next(); break; case END_ELEMENT: QName x = reader.getName(); if (x.getLocalPart().equals("response")) { return; } else { error("UnexpectedResponseElement", reader, x.toString()); } } } } private void parseResourceAdapter(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { warning("DoesntProcessResourceAdapter", jmsBinding); } /** * * * * ? */ private void parseHeaders(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { String jmsType = reader.getAttributeValue(null, "JMSType"); if (jmsType != null && jmsType.length() > 0) { jmsBinding.setJMSType(jmsType); } String jmsCorrelationId = reader.getAttributeValue(null, "JMSCorrelationID"); if (jmsCorrelationId != null && jmsCorrelationId.length() > 0) { jmsBinding.setJMSCorrelationId(jmsCorrelationId); } String jmsDeliveryMode = reader.getAttributeValue(null, "JMSDeliveryMode"); if (jmsDeliveryMode != null && jmsDeliveryMode.length() > 0) { if ("PERSISTENT".equalsIgnoreCase(jmsDeliveryMode)) { jmsBinding.setJMSDeliveryMode(true); } else if ("NON_PERSISTENT".equalsIgnoreCase(jmsDeliveryMode)) { jmsBinding.setJMSDeliveryMode(false); } else { warning("InvalidJMSDeliveryMode", jmsBinding, jmsDeliveryMode); } } String jmsTimeToLive = reader.getAttributeValue(null, "JMSTimeToLive"); if (jmsTimeToLive != null && jmsTimeToLive.length() > 0) { jmsBinding.setJMSTimeToLive(Long.parseLong(jmsTimeToLive)); } String jmsPriority = reader.getAttributeValue(null, "JMSPriority"); if (jmsPriority != null && jmsPriority.length() > 0) { int p = Integer.parseInt(jmsPriority); if (p >= 0 && p <= 9) { jmsBinding.setJMSPriority(p); } else { warning("InvalidJMSPriority", jmsBinding, jmsPriority); } } while (true) { switch (reader.next()) { case START_ELEMENT: if (reader.getName().getLocalPart().equals("property")) { parseProperty(reader, jmsBinding); } break; case END_ELEMENT: QName x = reader.getName(); if (x.getLocalPart().equals("headers")) { return; } else { error("UnexpectedResponseElement", reader, x.toString()); } } } } private void parseProperty(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { String name = reader.getAttributeValue(null, "name"); String type = reader.getAttributeValue(null, "type"); if (name != null && name.length() > 0) { Object value = reader.getElementText(); if ("boolean".equalsIgnoreCase(type)) { value = Boolean.parseBoolean((String)value); } else if ("byte".equalsIgnoreCase(type)) { value = Byte.parseByte(((String)value)); } else if ("short".equalsIgnoreCase(type)) { value = Short.parseShort((String)value); } else if ("int".equalsIgnoreCase(type)) { value = Integer.parseInt((String)value); } else if ("long".equalsIgnoreCase(type)) { value = Long.parseLong((String)value); } else if ("float".equalsIgnoreCase(type)) { value = Float.parseFloat((String)value); } else if ("double".equalsIgnoreCase(type)) { value = Double.parseDouble((String)value); } else if ("String".equalsIgnoreCase(type)) { // its already a string } jmsBinding.setProperty(name, value); } } /** * * * * * * * ? * * */ private void parseOperationProperties(XMLStreamReader reader, JMSBinding jmsBinding) throws XMLStreamException { String opName = reader.getAttributeValue(null, "name"); if (opName == null || opName.length() < 1) { warning("MissingJMSOperationPropertyName", jmsBinding); return; } String nativeOpName = reader.getAttributeValue(null, "nativeOperation"); if (nativeOpName != null && nativeOpName.length() > 0) { jmsBinding.setNativeOperationName(opName, nativeOpName); } while (true) { switch (reader.next()) { case START_ELEMENT: if (reader.getName().getLocalPart().equals("headers")) { parseOperationHeaders(reader, jmsBinding, opName); } break; case END_ELEMENT: QName x = reader.getName(); if (x.getLocalPart().equals("operationProperties")) { return; } else { error("UnexpectedResponseElement", reader, x.toString()); } } } } private void parseOperationHeaders(XMLStreamReader reader, JMSBinding jmsBinding, String opName) throws XMLStreamException { String jmsType = reader.getAttributeValue(null, "JMSType"); if (jmsType != null && jmsType.length() > 0) { jmsBinding.setOperationJMSType(opName, jmsType); } String jmsCorrelationId = reader.getAttributeValue(null, "JMSCorrelationID"); if (jmsCorrelationId != null && jmsCorrelationId.length() > 0) { jmsBinding.setOperationJMSCorrelationId(opName, jmsCorrelationId); } String jmsDeliveryMode = reader.getAttributeValue(null, "JMSDeliveryMode"); if (jmsDeliveryMode != null && jmsDeliveryMode.length() > 0) { if ("PERSISTENT".equalsIgnoreCase(jmsDeliveryMode)) { jmsBinding.setJMSDeliveryMode(true); } else if ("NON_PERSISTENT".equalsIgnoreCase(jmsDeliveryMode)) { jmsBinding.setOperationJMSDeliveryMode(opName, false); } else { warning("InvalidOPJMSDeliveryMode", jmsBinding, jmsDeliveryMode); } } String jmsTimeToLive = reader.getAttributeValue(null, "JMSTimeToLive"); if (jmsTimeToLive != null && jmsTimeToLive.length() > 0) { jmsBinding.setOperationJMSTimeToLive(opName, Long.parseLong(jmsTimeToLive)); } String jmsPriority = reader.getAttributeValue(null, "JMSPriority"); if (jmsPriority != null && jmsPriority.length() > 0) { int p = Integer.parseInt(jmsPriority); if (p >= 0 && p <= 9) { jmsBinding.setOperationJMSPriority(opName, p); } else { warning("InvalidOPJMSPriority", jmsBinding, jmsPriority); } } while (true) { switch (reader.next()) { case START_ELEMENT: if (reader.getName().getLocalPart().equals("property")) { parseOperationPropertyProperties(reader, jmsBinding, opName); } break; case END_ELEMENT: QName x = reader.getName(); if (x.getLocalPart().equals("headers")) { return; } else { error("UnexpectedResponseElement", reader, x.toString()); } } } } private void parseOperationPropertyProperties(XMLStreamReader reader, JMSBinding jmsBinding, String opName) throws XMLStreamException { String propName = reader.getAttributeValue(null, "name"); String type = reader.getAttributeValue(null, "type"); if (propName != null && propName.length() > 0) { Object value = reader.getElementText(); if ("boolean".equalsIgnoreCase(type)) { value = Boolean.parseBoolean((String)value); } else if ("byte".equalsIgnoreCase(type)) { value = Byte.parseByte(((String)value)); } else if ("short".equalsIgnoreCase(type)) { value = Short.parseShort((String)value); } else if ("int".equalsIgnoreCase(type)) { value = Integer.parseInt((String)value); } else if ("long".equalsIgnoreCase(type)) { value = Long.parseLong((String)value); } else if ("float".equalsIgnoreCase(type)) { value = Float.parseFloat((String)value); } else if ("double".equalsIgnoreCase(type)) { value = Double.parseDouble((String)value); } else if ("String".equalsIgnoreCase(type)) { // its already a string } jmsBinding.setOperationProperty(opName, propName, value); } } private void parseSubscriptionHeaders(XMLStreamReader reader, JMSBinding jmsBinding) { String jmsSelector = reader.getAttributeValue(null, "JMSSelector"); if (jmsSelector != null && jmsSelector.length() > 0) { jmsBinding.setJMSSelector(jmsSelector); } } /** * The validation rules for the JMS model are relatively complicated to they all live together here */ public void validate() throws JMSBindingException { /* * first fix up anything now the model has been read */ /* * Now some cross field validation */ // connection factory doesn't contradict destination type // connection factory and activation Specification are mutually exclusive // TODO check Specification for all validations } }