From b1e3f764175ef5d3adbf1a771d2abe68a2ecbf41 Mon Sep 17 00:00:00 2001
From: Oleg Zhurakousky <ozhurakousky@vmware.com>
Date: Thu, 4 Nov 2010 10:15:40 -0400
Subject: [PATCH] INT-1554 added tests and refactored/cleaned
 XmppPresenceMessageMapper

---
 .../presence/XmppPresenceMessageMapper.java   |  69 ++++++------
 .../XmppPresenceMessageMapperTests.java       | 106 ++++++++++++++++++
 2 files changed, 142 insertions(+), 33 deletions(-)
 create mode 100644 spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapperTests.java

diff --git a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapper.java b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapper.java
index 0ca9beb4cd..33a3bf9f45 100644
--- a/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapper.java
+++ b/spring-integration-xmpp/src/main/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapper.java
@@ -15,12 +15,11 @@
  */
 package org.springframework.integration.xmpp.presence;
 
-import org.apache.commons.logging.Log;
-import org.apache.commons.logging.LogFactory;
 import org.jivesoftware.smack.packet.Presence;
 import org.springframework.integration.Message;
 import org.springframework.integration.MessageHeaders;
 import org.springframework.integration.mapping.InboundMessageMapper;
+import org.springframework.integration.mapping.MessageMappingException;
 import org.springframework.integration.mapping.OutboundMessageMapper;
 import org.springframework.integration.support.MessageBuilder;
 import org.springframework.integration.xmpp.XmppHeaders;
@@ -28,21 +27,21 @@ import org.springframework.util.StringUtils;
 
 
 /**
- * Implementation of the strategy interface {@link org.springframework.integration.mapping.OutboundMessageMapper}. This is the hook that lets the adapter receive various payloads from
- * components inside Spring Integration and forward them correctly as {@link org.jivesoftware.smack.packet.Presence} instances.
+ * Implementation of the strategy interface {@link OutboundMessageMapper}
+ * which maps {@link Presence} to {@link Message}
  *
  * @author Josh Long
+ * @author Oleg Zhurakousky
  * @since 2.0
  */
 public class XmppPresenceMessageMapper implements OutboundMessageMapper<Presence>,
 		InboundMessageMapper<Presence> {
 
-	private static final Log logger = LogFactory.getLog(XmppPresenceMessageMapper.class);
-
 	/**
-	 * Returns a {@link org.springframework.integration.Message} with payload {@link org.jivesoftware.smack.packet.Presence}
+	 * Builds {@link Message} with payload of {@link Presence} while also 
+	 * setting Presense attributes as {@link MessageHeaders}
 	 *
-	 * @param presence the presence object that can be used to present the priority, status, mode, and type of a given roster entry. This will be decomposed into a series of headers, as well as a payload
+	 * @param presence the presence object
 	 * @return the Message
 	 * @throws Exception thrown if conversion should fail
 	 */
@@ -72,46 +71,50 @@ public class XmppPresenceMessageMapper implements OutboundMessageMapper<Presence
 		String language = (String) messageHeaders.get(XmppHeaders.PRESENCE_LANGUAGE);
 		String from = (String) messageHeaders.get(XmppHeaders.PRESENCE_FROM);
 
-		// trickery afoot
 		Object modeObj = messageHeaders.get(XmppHeaders.PRESENCE_MODE);
 		Presence.Mode mode = null;
 
 		Object typeObj = messageHeaders.get(XmppHeaders.PRESENCE_TYPE);
 		Presence.Type type = null;
 
-		if (typeObj instanceof String) {
-			try {
+		if (typeObj != null){
+			if (typeObj instanceof String) {
 				type = Presence.Type.valueOf((String) typeObj);
-			} catch (Throwable th) {
-				logger.debug("couldn't convert type header into an object of type Presence.Type");
+			} 
+			else if (typeObj instanceof Presence.Type) {
+				type = (Presence.Type) typeObj;
+			}
+			else {
+				throw new MessageMappingException("Unsupported type for Presence type. Only" +
+						" String or Presence.Type is allowed, but was: " + typeObj.getClass().getName());
 			}
-		} else if (modeObj instanceof Presence.Type) {
-			type = (Presence.Type) typeObj;
 		}
+		
 
-		if (modeObj instanceof String) {
-			try {
+		if (modeObj != null){
+			if (modeObj instanceof String) {
 				mode = Presence.Mode.valueOf((String) modeObj);
-			} catch (Throwable th) {
-				logger.debug("couldn't convert mode header into an object of type Presence.Mode ");
+			} 
+			else if (modeObj instanceof Presence.Mode) {
+				mode = (Presence.Mode) modeObj;
+			}
+			else {
+				throw new MessageMappingException("Unsupported type for Presence mode. Only" +
+						" String or Presence.Mode is allowed, but was: " + modeObj.getClass().getName());
 			}
-		} else if (modeObj instanceof Presence.Mode) {
-			mode = (Presence.Mode) modeObj;
 		}
-
+		
 		Object payload = message.getPayload();
-
-		if (null != payload) {
-			if (payload instanceof Presence) {
-				return (Presence) payload;
-			}
-
-			if (payload instanceof Presence.Type) {
-				type = (Presence.Type) payload;
-			}
+		if (payload instanceof Presence) {
+			return (Presence) payload;
+		}
+		else if (payload instanceof Presence.Type) {
+			type = (Presence.Type) payload;
+			return this.factoryPresence(from, status, priority, type, mode, language);
+		}
+		else {
+			throw new MessageMappingException("Unsupported Payload type: " + payload.getClass().getName());
 		}
-
-		return this.factoryPresence(from, status, priority, type, mode, language);
 	}
 
 	private Presence factoryPresence(String from, String status, Integer priority,
diff --git a/spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapperTests.java b/spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapperTests.java
new file mode 100644
index 0000000000..66895c8eb4
--- /dev/null
+++ b/spring-integration-xmpp/src/test/java/org/springframework/integration/xmpp/presence/XmppPresenceMessageMapperTests.java
@@ -0,0 +1,106 @@
+/*
+ * Copyright 2002-2010 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.integration.xmpp.presence;
+
+import static junit.framework.Assert.assertEquals;
+
+import org.jivesoftware.smack.packet.Presence;
+import org.jivesoftware.smack.packet.Presence.Mode;
+import org.jivesoftware.smack.packet.Presence.Type;
+import org.junit.Test;
+import org.springframework.integration.Message;
+import org.springframework.integration.mapping.MessageMappingException;
+import org.springframework.integration.support.MessageBuilder;
+import org.springframework.integration.xmpp.XmppHeaders;
+
+/**
+ * @author Oleg Zhurakousky
+ *
+ */
+public class XmppPresenceMessageMapperTests {
+
+	@Test
+	public void testFromMessageWithPayloadPresence() throws Exception{
+		Presence presence = new Presence(Type.available, "Hello", 1, Mode.chat);
+		Message<?> message = MessageBuilder.withPayload(presence).build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		Presence mappedPresence = mapper.fromMessage(message);
+		assertEquals(Mode.chat, mappedPresence.getMode());
+		assertEquals(Type.available, mappedPresence.getType());
+		assertEquals("Hello", mappedPresence.getStatus());
+		assertEquals(1, mappedPresence.getPriority());
+	}
+	
+	@Test
+	public void testFromMessageWithPayloadPresenceType() throws Exception{
+		Message<?> message = MessageBuilder.withPayload(Type.available)
+		.setHeader(XmppHeaders.PRESENCE_FROM, "oleg")
+		.setHeader(XmppHeaders.PRESENCE_MODE, Mode.chat)
+		.setHeader(XmppHeaders.PRESENCE_STATUS, "hello")
+		.setHeader(XmppHeaders.PRESENCE_TYPE, Type.subscribed)
+		.setHeader(XmppHeaders.PRESENCE_PRIORITY, 1)
+		.build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		Presence mappedPresence = mapper.fromMessage(message);
+		assertEquals(Mode.chat, mappedPresence.getMode());
+		assertEquals(Type.available, mappedPresence.getType());
+		assertEquals("hello", mappedPresence.getStatus());
+		assertEquals(1, mappedPresence.getPriority());
+	}
+	@Test
+	public void testFromMessageWithPayloadPresenceTypeAndStringModeType() throws Exception{
+		Message<?> message = MessageBuilder.withPayload(Type.available)
+		.setHeader(XmppHeaders.PRESENCE_FROM, "oleg")
+		.setHeader(XmppHeaders.PRESENCE_MODE, "chat")
+		.setHeader(XmppHeaders.PRESENCE_STATUS, "hello")
+		.setHeader(XmppHeaders.PRESENCE_TYPE, "subscribed")
+		.setHeader(XmppHeaders.PRESENCE_PRIORITY, 1)
+		.build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		Presence mappedPresence = mapper.fromMessage(message);
+		assertEquals(Mode.chat, mappedPresence.getMode());
+		assertEquals(Type.available, mappedPresence.getType());
+		assertEquals("hello", mappedPresence.getStatus());
+		assertEquals(1, mappedPresence.getPriority());
+	}
+	
+	@Test(expected=MessageMappingException.class)
+	public void testFromMessageWithPayloadPresenceTypeUnsupportedMode() throws Exception{
+		
+		Message<?> message = MessageBuilder.withPayload(Type.available)
+		.setHeader(XmppHeaders.PRESENCE_MODE, 1)
+		.build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		mapper.fromMessage(message);
+	}
+	
+	@Test(expected=MessageMappingException.class)
+	public void testFromMessageWithPayloadPresenceTypeUnsupportedType() throws Exception{
+		
+		Message<?> message = MessageBuilder.withPayload(Type.available)
+		.setHeader(XmppHeaders.PRESENCE_TYPE, 1)
+		.build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		mapper.fromMessage(message);
+	}
+	
+	@Test(expected=MessageMappingException.class)
+	public void testFromMessageWithUnsupportedPayload() throws Exception{	
+		Message<?> message = MessageBuilder.withPayload("hello").build();
+		XmppPresenceMessageMapper mapper = new XmppPresenceMessageMapper();
+		mapper.fromMessage(message);
+	}
+}