/*
* Copyright 2005-2012 the original author or authors.
*
* Licensed 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.springframework.ws.transport.jms.support;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.jms.DeliveryMode;
import javax.jms.Destination;
import javax.jms.JMSException;
import javax.jms.Message;
import javax.jms.Queue;
import javax.jms.Topic;
import org.springframework.ws.transport.jms.JmsTransportConstants;
/**
* Collection of utility methods to work with JMS transports. Includes methods to retrieve JMS properties from an {@link
* URI}.
*
* @author Arjen Poutsma
* @since 1.5.0
*/
public abstract class JmsTransportUtils {
private static final String[] CONVERSION_TABLE = new String[]{JmsTransportConstants.HEADER_CONTENT_TYPE,
JmsTransportConstants.PROPERTY_CONTENT_TYPE, JmsTransportConstants.HEADER_CONTENT_LENGTH,
JmsTransportConstants.PROPERTY_CONTENT_LENGTH, JmsTransportConstants.HEADER_SOAP_ACTION,
JmsTransportConstants.PROPERTY_SOAP_ACTION, JmsTransportConstants.HEADER_ACCEPT_ENCODING,
JmsTransportConstants.PROPERTY_ACCEPT_ENCODING};
private static final Pattern DESTINATION_NAME_PATTERN = Pattern.compile("^([^\\?]+)");
private static final Pattern DELIVERY_MODE_PATTERN = Pattern.compile("deliveryMode=(PERSISTENT|NON_PERSISTENT)");
private static final Pattern MESSAGE_TYPE_PATTERN = Pattern.compile("messageType=(BYTES_MESSAGE|TEXT_MESSAGE)");
private static final Pattern TIME_TO_LIVE_PATTERN = Pattern.compile("timeToLive=(\\d+)");
private static final Pattern PRIORITY_PATTERN = Pattern.compile("priority=(\\d)");
private static final Pattern REPLY_TO_NAME_PATTERN = Pattern.compile("replyToName=([^&]+)");
private JmsTransportUtils() {
}
/**
* Converts the given transport header to a JMS property name. Returns the given header name if no match is found.
*
* @param headerName the header name to transform
* @return the JMS property name
*/
public static String headerToJmsProperty(String headerName) {
for (int i = 0; i < CONVERSION_TABLE.length; i = i + 2) {
if (CONVERSION_TABLE[i].equals(headerName)) {
return CONVERSION_TABLE[i + 1];
}
}
return headerName;
}
/**
* Converts the given JMS property name to a transport header name. Returns the given property name if no match is
* found.
*
* @param propertyName the JMS property name to transform
* @return the transport header name
*/
public static String jmsPropertyToHeader(String propertyName) {
for (int i = 1; i < CONVERSION_TABLE.length; i = i + 2) {
if (CONVERSION_TABLE[i].equals(propertyName)) {
return CONVERSION_TABLE[i - 1];
}
}
return propertyName;
}
/**
* Converts the given JMS destination into a {@code jms} URI.
*
* @param destination the destination
* @return a jms URI
*/
public static URI toUri(Destination destination) throws URISyntaxException, JMSException {
if (destination == null) {
return null;
}
String destinationName;
if (destination instanceof Queue) {
destinationName = ((Queue) destination).getQueueName();
}
else if (destination instanceof Topic) {
Topic topic = (Topic) destination;
destinationName = topic.getTopicName();
}
else {
throw new IllegalArgumentException("Destination [ " + destination + "] is neither Queue nor Topic");
}
return new URI(JmsTransportConstants.JMS_URI_SCHEME, destinationName, null);
}
/** Returns the destination name of the given URI. */
public static String getDestinationName(URI uri) {
return getStringParameter(DESTINATION_NAME_PATTERN, uri);
}
/** Adds the given header to the specified message. */
public static void addHeader(Message message, String name, String value) throws JMSException {
String propertyName = JmsTransportUtils.headerToJmsProperty(name);
message.setStringProperty(propertyName, value);
}
/**
* Returns an iterator over all header names in the given message. Delegates to {@link
* #jmsPropertyToHeader(String)}.
*/
public static Iterator<String> getHeaderNames(Message message) throws JMSException {
Enumeration<?> properties = message.getPropertyNames();
List<String> results = new ArrayList<String>();
while (properties.hasMoreElements()) {
String property = (String) properties.nextElement();
if (property.startsWith(JmsTransportConstants.PROPERTY_PREFIX)) {
String header = jmsPropertyToHeader(property);
results.add(header);
}
}
return results.iterator();
}
/**
* Returns an iterator over all the header values of the given message and header name. Delegates to {@link
* #headerToJmsProperty(String)}.
*/
public static Iterator<String> getHeaders(Message message, String name) throws JMSException {
String propertyName = headerToJmsProperty(name);
String value = message.getStringProperty(propertyName);
if (value != null) {
return Collections.singletonList(value).iterator();
}
else {
return Collections.<String>emptyList().iterator();
}
}
/**
* Returns the delivery mode of the given URI.
*
* @see DeliveryMode#NON_PERSISTENT
* @see DeliveryMode#PERSISTENT
* @see Message#DEFAULT_DELIVERY_MODE
*/
public static int getDeliveryMode(URI uri) {
String deliveryMode = getStringParameter(DELIVERY_MODE_PATTERN, uri);
if ("NON_PERSISTENT".equals(deliveryMode)) {
return DeliveryMode.NON_PERSISTENT;
}
else if ("PERSISTENT".equals(deliveryMode)) {
return DeliveryMode.PERSISTENT;
}
else {
return Message.DEFAULT_DELIVERY_MODE;
}
}
/**
* Returns the message type of the given URI. Defaults to {@link JmsTransportConstants#BYTES_MESSAGE_TYPE}.
*
* @see JmsTransportConstants#BYTES_MESSAGE_TYPE
* @see JmsTransportConstants#TEXT_MESSAGE_TYPE
*/
public static int getMessageType(URI uri) {
String deliveryMode = getStringParameter(MESSAGE_TYPE_PATTERN, uri);
if ("TEXT_MESSAGE".equals(deliveryMode)) {
return JmsTransportConstants.TEXT_MESSAGE_TYPE;
}
else {
return JmsTransportConstants.BYTES_MESSAGE_TYPE;
}
}
/**
* Returns the lifetime, in milliseconds, of the given URI.
*
* @see Message#DEFAULT_TIME_TO_LIVE
*/
public static long getTimeToLive(URI uri) {
return getLongParameter(TIME_TO_LIVE_PATTERN, uri, Message.DEFAULT_TIME_TO_LIVE);
}
/**
* Returns the priority of the given URI.
*
* @see Message#DEFAULT_PRIORITY
*/
public static int getPriority(URI uri) {
return getIntParameter(PRIORITY_PATTERN, uri, Message.DEFAULT_PRIORITY);
}
/**
* Returns the reply-to name of the given URI.
*
* @see Message#setJMSReplyTo(Destination)
*/
public static String getReplyToName(URI uri) {
return getStringParameter(REPLY_TO_NAME_PATTERN, uri);
}
private static String getStringParameter(Pattern pattern, URI uri) {
Matcher matcher = pattern.matcher(uri.getSchemeSpecificPart());
if (matcher.find() && matcher.groupCount() == 1) {
return matcher.group(1);
}
return null;
}
private static int getIntParameter(Pattern pattern, URI uri, int defaultValue) {
Matcher matcher = pattern.matcher(uri.getSchemeSpecificPart());
if (matcher.find() && matcher.groupCount() == 1) {
try {
return Integer.parseInt(matcher.group(1));
}
catch (NumberFormatException ex) {
// fall through to default value
}
}
return defaultValue;
}
private static long getLongParameter(Pattern pattern, URI uri, long defaultValue) {
Matcher matcher = pattern.matcher(uri.getSchemeSpecificPart());
if (matcher.find() && matcher.groupCount() == 1) {
try {
return Long.parseLong(matcher.group(1));
}
catch (NumberFormatException ex) {
// fall through to default value
}
}
return defaultValue;
}
}