Support for message int properties - #39

Author: matrober-uk

jms20subset/Message.go

@@ -58,6 +58,13 @@ type Message interface {
 	// Returns nil if the named property is not set.
 	GetStringProperty(name string) (*string, JMSException)
 
+	// SetIntProperty enables an application to set a int-type message property.
+	SetIntProperty(name string, value int) JMSException
+
+	// GetIntProperty returns the int value of a named message property.
+	// Returns 0 if the named property is not set.
+	GetIntProperty(name string) (int, JMSException)
+
 	// PropertyExists returns true if the named message property exists on this message.
 	PropertyExists(name string) (bool, JMSException)
 

messageproperties_test.go

@@ -27,6 +27,11 @@ import (
  * JMS: SetStringProperty, GetStringProperty,
  * https://github.com/eclipse-ee4j/messaging/blob/master/api/src/main/java/jakarta/jms/Message.java#L1119
  *
+ * Double
+ * Boolean
+ *
+ * BytesMessage
+ *
  */
 
 /*
@@ -337,19 +342,19 @@ func TestPropertyClearProperties(t *testing.T) {
 	assert.Equal(t, 0, len(allPropNames))
 
 	propName2 := "myPropertyTwo"
-	propValue2 := "myValueTwo"
+	propValue2 := 246811
 
 	// Set multiple properties
 	retErr = txtMsg.SetStringProperty(propName, &propValue)
 	assert.Nil(t, retErr)
 	gotPropValue, propErr = txtMsg.GetStringProperty(propName)
 	assert.Nil(t, propErr)
 	assert.Equal(t, propValue, *gotPropValue)
-	retErr = txtMsg.SetStringProperty(propName2, &propValue2)
+	retErr = txtMsg.SetIntProperty(propName2, propValue2)
 	assert.Nil(t, retErr)
-	gotPropValue, propErr = txtMsg.GetStringProperty(propName2)
+	gotPropValue2, propErr := txtMsg.GetIntProperty(propName2)
 	assert.Nil(t, propErr)
-	assert.Equal(t, propValue2, *gotPropValue)
+	assert.Equal(t, propValue2, gotPropValue2)
 	propExists, propErr = txtMsg.PropertyExists(propName2)
 	assert.Nil(t, propErr)
 	assert.True(t, propExists) // now exists
@@ -593,3 +598,117 @@ func TestStringPropertyTextMessageEmptyBody(t *testing.T) {
 	assert.Equal(t, propBValue, *gotPropValue)
 
 }
+
+/*
+ * Test the creation of a text message with an int property.
+ */
+func TestIntProperty(t *testing.T) {
+
+	// Loads CF parameters from connection_info.json and applicationApiKey.json in the Downloads directory
+	cf, cfErr := mqjms.CreateConnectionFactoryFromDefaultJSONFiles()
+	assert.Nil(t, cfErr)
+
+	// Creates a connection to the queue manager, using defer to close it automatically
+	// at the end of the function (if it was created successfully)
+	context, ctxErr := cf.CreateContext()
+	assert.Nil(t, ctxErr)
+	if context != nil {
+		defer context.Close()
+	}
+
+	// Create a TextMessage and check that we can populate it
+	msgBody := "IntPropertyRequestMsg"
+	txtMsg := context.CreateTextMessage()
+	txtMsg.SetText(msgBody)
+
+	propName := "myProperty"
+	propValue := 6
+
+	// Test the empty value before the property is set.
+	gotPropValue, propErr := txtMsg.GetIntProperty(propName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, 0, gotPropValue)
+	propExists, propErr := txtMsg.PropertyExists(propName)
+	assert.Nil(t, propErr)
+	assert.False(t, propExists)
+
+	// Test the ability to set properties before the message is sent.
+	retErr := txtMsg.SetIntProperty(propName, propValue)
+	assert.Nil(t, retErr)
+	gotPropValue, propErr = txtMsg.GetIntProperty(propName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, propValue, gotPropValue)
+	assert.Equal(t, msgBody, *txtMsg.GetText())
+	propExists, propErr = txtMsg.PropertyExists(propName)
+	assert.Nil(t, propErr)
+	assert.True(t, propExists) // now exists
+
+	propName2 := "myProperty2"
+	propValue2 := 246810
+	retErr = txtMsg.SetIntProperty(propName2, propValue2)
+	assert.Nil(t, retErr)
+	gotPropValue, propErr = txtMsg.GetIntProperty(propName2)
+	assert.Nil(t, propErr)
+	assert.Equal(t, propValue2, gotPropValue)
+
+	// Set a property then try to "unset" it by setting to 0
+	unsetPropName := "mySendThenRemovedString"
+	unsetPropValue := 12345
+	retErr = txtMsg.SetIntProperty(unsetPropName, unsetPropValue)
+	assert.Nil(t, retErr)
+	gotPropValue, propErr = txtMsg.GetIntProperty(unsetPropName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, unsetPropValue, gotPropValue)
+	retErr = txtMsg.SetIntProperty(unsetPropName, 0)
+	assert.Nil(t, retErr)
+	gotPropValue, propErr = txtMsg.GetIntProperty(unsetPropName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, 0, gotPropValue)
+
+	// Set up objects for send/receive
+	queue := context.CreateQueue("DEV.QUEUE.1")
+	consumer, errCons := context.CreateConsumer(queue)
+	if consumer != nil {
+		defer consumer.Close()
+	}
+	assert.Nil(t, errCons)
+
+	// Now send the message and get it back again, to check that it roundtripped.
+	errSend := context.CreateProducer().SetTimeToLive(10000).Send(queue, txtMsg)
+	assert.Nil(t, errSend)
+
+	rcvMsg, errRvc := consumer.ReceiveNoWait()
+	assert.Nil(t, errRvc)
+	assert.NotNil(t, rcvMsg)
+
+	switch msg := rcvMsg.(type) {
+	case jms20subset.TextMessage:
+		assert.Equal(t, msgBody, *msg.GetText())
+	default:
+		assert.Fail(t, "Got something other than a text message")
+	}
+
+	// Check property is available on received message.
+	gotPropValue, propErr = rcvMsg.GetIntProperty(propName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, propValue, gotPropValue)
+	propExists, propErr = txtMsg.PropertyExists(propName)
+	assert.Nil(t, propErr)
+	assert.True(t, propExists) // now exists
+
+	gotPropValue, propErr = rcvMsg.GetIntProperty(propName2)
+	assert.Nil(t, propErr)
+	assert.Equal(t, propValue2, gotPropValue)
+
+	// Properties that are not set should return nil
+	gotPropValue, propErr = rcvMsg.GetIntProperty("nonExistentProperty")
+	assert.Nil(t, propErr)
+	assert.Equal(t, 0, gotPropValue)
+	gotPropValue, propErr = rcvMsg.GetIntProperty(unsetPropName)
+	assert.Nil(t, propErr)
+	assert.Equal(t, 0, gotPropValue)
+	propExists, propErr = txtMsg.PropertyExists(unsetPropName)
+	assert.Nil(t, propErr)
+	assert.True(t, propExists) // exists, even though it is set to zero
+
+}

mqjms/MessageImpl.go

@@ -346,6 +346,65 @@ func (msg *MessageImpl) GetStringProperty(name string) (*string, jms20subset.JMS
 	return &valueStr, retErr
 }
 
+// SetIntProperty enables an application to set a int-type message property.
+func (msg *MessageImpl) SetIntProperty(name string, value int) jms20subset.JMSException {
+	var retErr jms20subset.JMSException
+
+	var linkedErr error
+
+	smpo := ibmmq.NewMQSMPO()
+	pd := ibmmq.NewMQPD()
+
+	linkedErr = msg.msgHandle.SetMP(smpo, name, pd, value)
+
+	if linkedErr != nil {
+		rcInt := int(linkedErr.(*ibmmq.MQReturn).MQRC)
+		errCode := strconv.Itoa(rcInt)
+		reason := ibmmq.MQItoString("RC", rcInt)
+		retErr = jms20subset.CreateJMSException(reason, errCode, linkedErr)
+	}
+
+	return retErr
+}
+
+// GetIntProperty returns the int value of a named message property.
+// Returns 0 if the named property is not set.
+func (msg *MessageImpl) GetIntProperty(name string) (int, jms20subset.JMSException) {
+
+	var valueRet int
+	var retErr jms20subset.JMSException
+
+	impo := ibmmq.NewMQIMPO()
+	pd := ibmmq.NewMQPD()
+
+	_, value, err := msg.msgHandle.InqMP(impo, pd, name)
+
+	if err == nil {
+		switch valueTyped := value.(type) {
+		case int64:
+			valueRet = int(valueTyped)
+		default:
+			// TODO - other conversions
+			//fmt.Println("Other type", value, reflect.TypeOf(value))
+		}
+	} else {
+
+		mqret := err.(*ibmmq.MQReturn)
+		if mqret.MQRC == ibmmq.MQRC_PROPERTY_NOT_AVAILABLE {
+			// This indicates that the requested property does not exist.
+			// valueRet will remain with its default value of nil
+			return 0, nil
+		} else {
+			// Err was not nil
+			rcInt := int(mqret.MQRC)
+			errCode := strconv.Itoa(rcInt)
+			reason := ibmmq.MQItoString("RC", rcInt)
+			retErr = jms20subset.CreateJMSException(reason, errCode, mqret)
+		}
+	}
+	return valueRet, retErr
+}
+
 // PropertyExists returns true if the named message property exists on this message.
 func (msg *MessageImpl) PropertyExists(name string) (bool, jms20subset.JMSException) {