From ba3afc7c2b1927a6f01791cbc69069effa12ff8b Mon Sep 17 00:00:00 2001 From: Arjen Poutsma Date: Fri, 28 Sep 2007 23:22:07 +0000 Subject: [PATCH] Javadoc --- .../jms/support/JmsTransportUtils.java | 22 +++++++++++++++++-- .../ws/transport/jms/support/package.html | 5 +++++ 2 files changed, 25 insertions(+), 2 deletions(-) create mode 100644 sandbox/src/main/java/org/springframework/ws/transport/jms/support/package.html diff --git a/sandbox/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java b/sandbox/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java index 872a1fdb..fa672f9f 100644 --- a/sandbox/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java +++ b/sandbox/src/main/java/org/springframework/ws/transport/jms/support/JmsTransportUtils.java @@ -18,7 +18,13 @@ package org.springframework.ws.transport.jms.support; import org.springframework.ws.transport.jms.JmsTransportConstants; -/** @author Arjen Poutsma */ +/** + * Collection of utility methods to work with JMS transports. Includes methods to convert from transport header names to + * JMS Properties and vice-versa. + * + * @author Arjen Poutsma + * @since 1.1.0 + */ public class JmsTransportUtils { private static final String[] CONVERSION_TABLE = new String[]{JmsTransportConstants.HEADER_CONTENT_TYPE, @@ -27,9 +33,14 @@ public class JmsTransportUtils { JmsTransportConstants.PROPERTY_SOAP_ACTION}; 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)) { @@ -39,6 +50,13 @@ public class JmsTransportUtils { 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)) { diff --git a/sandbox/src/main/java/org/springframework/ws/transport/jms/support/package.html b/sandbox/src/main/java/org/springframework/ws/transport/jms/support/package.html new file mode 100644 index 00000000..8c2ac138 --- /dev/null +++ b/sandbox/src/main/java/org/springframework/ws/transport/jms/support/package.html @@ -0,0 +1,5 @@ + + +Classes supporting the org.springframework.ws.transport.jms package. + + \ No newline at end of file