systests/src/test/java/org/apache/qpid/test/unit/message/JMSPropertiesTest.java

/*
 *
 * 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.qpid.test.unit.message;

import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;

import javax.jms.Connection;
import javax.jms.Destination;
import javax.jms.Message;
import javax.jms.MessageConsumer;
import javax.jms.MessageFormatException;
import javax.jms.MessageProducer;
import javax.jms.ObjectMessage;
import javax.jms.Queue;
import javax.jms.Session;
import javax.jms.Topic;

import org.apache.qpid.client.message.QpidMessageProperties;
import org.apache.qpid.test.utils.QpidBrokerTestCase;

public class JMSPropertiesTest extends QpidBrokerTestCase
{
    private static final String JMS_CORR_ID = "QPIDID_01";
    private static final String JMS_TYPE = "test.jms.type";
    private static final String INVALID_OBJECT_PROPERTY = "InvalidObject";

    public void testJMSProperties() throws Exception
    {
        Connection con = getConnection();
        Session consumerSession = con.createSession(false, Session.CLIENT_ACKNOWLEDGE);

        Queue queue = createTestQueue(consumerSession, "someQ");
        MessageConsumer consumer = consumerSession.createConsumer(queue);

        Connection con2 = getConnection();
        final Session producerSession = con2.createSession(false, Session.CLIENT_ACKNOWLEDGE);
        final MessageProducer producer = producerSession.createProducer(queue);
        Destination replyTo = createTestQueue(producerSession, "my.replyto");

        // create a test message to send
        ObjectMessage sentMsg = producerSession.createObjectMessage();
        sentMsg.setJMSCorrelationID(JMS_CORR_ID);
        sentMsg.setJMSType(JMS_TYPE);
        sentMsg.setJMSReplyTo(replyTo);

        String JMSXGroupID_VALUE = "group";
        sentMsg.setStringProperty("JMSXGroupID", JMSXGroupID_VALUE);
        
        int JMSXGroupSeq_VALUE = 1;
        sentMsg.setIntProperty("JMSXGroupSeq", JMSXGroupSeq_VALUE);

        try
        {
            sentMsg.setObjectProperty(INVALID_OBJECT_PROPERTY, new Exception());
            fail("Non serializable Object Property value set");
        }
        catch (MessageFormatException mfe)
        {
            // pass

        }

        // send it
        producer.send(sentMsg);

        con2.close();

        con.start();

        // get message and check JMS properties
        ObjectMessage rm = (ObjectMessage) consumer.receive(getReceiveTimeout());
        assertNotNull(rm);

        assertEquals("JMS Correlation ID mismatch", sentMsg.getJMSCorrelationID(), rm.getJMSCorrelationID());
        assertEquals("JMS Type mismatch", sentMsg.getJMSType(), rm.getJMSType());
        assertEquals("JMS Reply To mismatch", sentMsg.getJMSReplyTo(), rm.getJMSReplyTo());
        assertTrue("JMSMessageID Does not start ID:", rm.getJMSMessageID().startsWith("ID:"));
        assertEquals("JMS Default priority should be 4",Message.DEFAULT_PRIORITY,rm.getJMSPriority());

        //Validate that the JMSX values are correct
        assertEquals("JMSXGroupID is not as expected:", JMSXGroupID_VALUE, rm.getStringProperty("JMSXGroupID"));
        assertEquals("JMSXGroupSeq is not as expected:", JMSXGroupSeq_VALUE, rm.getIntProperty("JMSXGroupSeq"));

        boolean JMSXGroupID_Available = false;
        boolean JMSXGroupSeq_Available = false;
        Enumeration props = con.getMetaData().getJMSXPropertyNames();
        while (props.hasMoreElements())
        {
            String name = (String) props.nextElement();
            if (name.equals("JMSXGroupID"))
            {
                JMSXGroupID_Available = true;
            }
            if (name.equals("JMSXGroupSeq"))
            {
                JMSXGroupSeq_Available = true;
            }
        }

        assertTrue("JMSXGroupID not available.",JMSXGroupID_Available);
        assertTrue("JMSXGroupSeq not available.",JMSXGroupSeq_Available);

        // Check that the INVALID_OBJECT_PROPERTY was not set or transmitted.
        assertFalse(INVALID_OBJECT_PROPERTY + " was not set.", rm.propertyExists(INVALID_OBJECT_PROPERTY));

        con.close();
    }

    /**
     * Test Goal : Test if custom message properties can be set and retrieved properly with out an error.
     *             Also test if unsupported properties are filtered out. See QPID-2930.
     */
    public void testQpidExtensionProperties() throws Exception
    {
        Connection con = getConnection();
        Session ssn = con.createSession(false, Session.CLIENT_ACKNOWLEDGE);
        con.start();

        Topic topic = createTopic(con, "test");
        MessageConsumer consumer = ssn.createConsumer(topic);
        MessageProducer prod = ssn.createProducer(topic);
        Message m = ssn.createMessage();
        m.setObjectProperty("foo-bar", "foobar".getBytes());
        m.setObjectProperty(QpidMessageProperties.AMQP_0_10_APP_ID, "my-app-id");
        prod.send(m);

        Message msg = consumer.receive(getReceiveTimeout());
        assertNotNull(msg);

    	Enumeration<String> enu = msg.getPropertyNames();
    	Map<String,String> map = new HashMap<String,String>();
    	while (enu.hasMoreElements())
    	{
    	    String name = enu.nextElement();
    	    String value = msg.getStringProperty(name);
    		map.put(name, value);
       }

       assertFalse("Property 'foo-bar' should have been filtered out",map.containsKey("foo-bar"));
       assertEquals("Property "+ QpidMessageProperties.AMQP_0_10_APP_ID + " should be present","my-app-id",msg.getStringProperty(QpidMessageProperties.AMQP_0_10_APP_ID));
       assertEquals("Property "+ QpidMessageProperties.AMQP_0_10_ROUTING_KEY + " should be present","test",msg.getStringProperty(QpidMessageProperties.AMQP_0_10_ROUTING_KEY));
       
    }
}