Changes to java for changes to gateway core.

Author: andrew-buckley

bindings/CMakeLists.txt

@@ -9,6 +9,7 @@ endif()
 
 if(${enable_java_binding})
     add_subdirectory(java)
+endif()
 
 if(${enable_nodejs_binding})
     add_subdirectory(nodejs)

bindings/java/devdoc/java_binding_hld.md

@@ -82,11 +82,12 @@ public interface IGatewayModule {
      * Gateway creates the Module. The constructor
      * should save both the {@code moduleAddr} and {@code bus} parameters.
      *
+     * @param moduleAddr The address of the native module pointer
      * @param bus The {@link MessageBus} to which this Module belongs
      * @param configuration The configuration for this module represented as a JSON
      * string
      */
-    void create(MessageBus bus, String configuration);
+    void create(long moduleAddr, MessageBus bus, String configuration);
 
     /**
      * The destroy method is called on a {@link GatewayModule} before it is about 
@@ -135,8 +136,9 @@ gateway, it:
 -   Constructs a `MessageBus` Java object using the `MESSAGE_BUS_HANDLE`.
 
 -   Finds the module’s class with the name specified by the `args.class_name`,
-    invokes the constructor passing in the `MessageBus` object and the JSON args
-    string for that module, and creates the Java module.
+    invokes the constructor passing in the native `MODULE_HANDLE` address,
+    the `MessageBus` object and the JSON args string for that module, and 
+    creates the Java module.
 
 -   Gets a global reference to the newly created `GatewayModule` object to be
     saved by the `JAVA_MODULE_HOST_HANDLE`.
@@ -168,7 +170,7 @@ Communication **FROM** the Java module
 In order to communicate **from** the Java module to the native gateway process,
 the `MessageBus` class must be used. The `MessageBus` class provides a method to
 publish messages onto the native Message Bus and loads a dynamic library that
-implements expected functions for publishing onto the native Message Bus. So,
-the above diagram should look a bit more like this:
+implements the functions for publishing onto the native message bus. So,the 
+above diagram should look a bit more like this:
 
 ![](HLD2.png)

bindings/java/devdoc/requirements_docs/com/microsoft/azure/gateway/messaging/message_requirements.md

@@ -16,8 +16,7 @@ public final class Message implements Serializable{
 
     private String content;
 
-    public Message(String content, Map<String, String> properties);
-    public Message(String content);
+    public Message(byte[] content, Map<String, String> properties);
     public Message(byte[] serializedMessage);
     public Map<String, String> getProperties();
     public String getContent();
@@ -27,7 +26,7 @@ public final class Message implements Serializable{
 
 ##  Message
 ```java
-public Message(byte[] serializedMessage | String content[, Map<String, String> properties]);
+public Message(byte[] serializedMessage | byte[] content, Map<String, String> properties);
 ```
 **SRS_JAVA_MESSAGE_14_001: [** The constructor shall create a Message object by deserializing the byte array. **]**
 

bindings/java/devdoc/requirements_docs/java_module_host_hl_requirements.md

@@ -35,7 +35,7 @@ This JSON object will be the `"args"` section of the Gateway JSON configuration
             "module path": "/path/to/java_module_host_hl.so|.dll",
             "args": {
                 "class_path": "/path/to/relevant/class/files",
-                "library_path": "/path/to/dir/with/java_module_host_hl.so|.dll",
+                "library_path": "/path/to/dir/with/java_module_host.so|.dll",
                 "class_name": "Poller",
                 "args": {
                     "frequency": 30

bindings/java/devdoc/requirements_docs/java_module_host_requirements.md

@@ -164,7 +164,7 @@ static void JavaModuleHost_Receive(MODULE_HANDLE module, MESSAGE_HANDLE message)
 JNIEXPORT jint JNICALL Java_com_microsoft_azure_gateway_core_MessageBus_publishMessage(JNIEnv *env, jobject MessageBus, jlong addr, jbyteArray message);
 ```
 
-**SRS_JAVA_MODULE_HOST_14_025: [** This function shall use convert the `jbyteArray message` into an `unsigned char` array. **]**
+**SRS_JAVA_MODULE_HOST_14_025: [** This function shall convert the `jbyteArray message` into an `unsigned char` array. **]**
 
 **SRS_JAVA_MODULE_HOST_14_026: [** This function shall use the serialized message in a call to `Message_Create`. **]**
 

bindings/java/gateway-java-binding/pom.xml

@@ -26,8 +26,8 @@
         </dependency>
         <dependency>
             <groupId>junit</groupId>
-            <artifactId>junit-dep</artifactId>
-            <version>4.11</version>
+            <artifactId>junit</artifactId>
+            <version>4.12</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -40,6 +40,25 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.3</version>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.19.1</version>
+                <configuration>
+                    <argLine>
+                    -Dfile.encoding=UTF-8 -javaagent:${settings.localRepository}/org/jmockit/jmockit/1.22/jmockit-1.22.jar
+                    </argLine>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>

bindings/java/gateway-java-binding/src/main/java/com/microsoft/azure/gateway/core/GatewayModule.java

@@ -16,6 +16,9 @@ public abstract class GatewayModule implements IGatewayModule{
     public abstract void receive(Message message);
     public abstract void destroy();
 
+    /** The address of the native module pointer */
+    private long _addr;
+
     /** The {@link MessageBus} to which this module belongs */
     private MessageBus bus;
 
@@ -26,20 +29,24 @@ public abstract class GatewayModule implements IGatewayModule{
      * Constructs a {@link GatewayModule} from the provided address and {@link MessageBus}. A {@link GatewayModule} should always call this super
      * constructor before any module-specific constructor code.
      *
+     * The {@code address} parameter must be passed to the super constructor but can be ignored by the module-implementor when writing a module implementation.
+     *
+     * @param address The address of the native module pointer.
      * @param bus The {@link MessageBus} to which this module belongs
      * @param configuration The module-specific configuration
      */
-    public GatewayModule(MessageBus bus, String configuration){
+    public GatewayModule(long address, MessageBus bus, String configuration){
         /*Codes_SRS_JAVA_GATEWAY_MODULE_14_002: [ If address or bus is null the constructor shall throw an IllegalArgumentException. ]*/
-        if(bus == null){
+        if(address == 0 || bus == null){
             throw new IllegalArgumentException("Address is invalid or MessageBus is null.");
         }
 
         /*Codes_SRS_JAVA_GATEWAY_MODULE_14_001: [ The constructor shall save address, bus, and configuration into class variables. ]*/
-        this.create(bus, configuration);
+        this.create(address, bus, configuration);
     }
 
-    public void create(MessageBus bus, String configuration){
+    public void create(long moduleAddr, MessageBus bus, String configuration){
+        this._addr = moduleAddr;
         this.bus = bus;
         this.configuration = configuration;
     }
@@ -48,6 +55,10 @@ public void receive(byte[] serializedMessage){
         this.receive(new Message(serializedMessage));
     }
 
+    public int publish(Message message) throws IOException {
+        return this.bus.publishMessage(message, this._addr);
+    }
+
     //Public getter methods
 
     final public MessageBus getMessageBus(){

bindings/java/gateway-java-binding/src/main/java/com/microsoft/azure/gateway/core/IGatewayModule.java

@@ -10,10 +10,11 @@ public interface IGatewayModule {
      * The create method is called by the subclass constructor when the native Gateway creates the Module. The constructor
      * should save the {@code bus} parameter.
      *
+     * @param moduleAddr The address of the native module pointer
      * @param bus The {@link MessageBus} to which this Module belongs
      * @param configuration The configuration for this module represented as a JSON string
      */
-    void create(MessageBus bus, String configuration);
+    void create(long moduleAddr, MessageBus bus, String configuration);
 
     /**
      * The receive method is called on a {@link GatewayModule} whenever it receives a message.

bindings/java/gateway-java-binding/src/main/java/com/microsoft/azure/gateway/core/MessageBus.java

@@ -21,19 +21,20 @@ public class MessageBus {
      * function to publish the provided {@link Message} onto the MessageBus.
      *
      * @param busAddr The address of the pointer to the native MessageBus.
+     * @param moduleAddr The address of the pointer to the native Module.
      * @param message The serialized {@link Message} to be published.
      * @return 0 on success, non-zero otherwise.
      */
-    private native int publishMessage(long busAddr, byte[] message);
+    private native int publishMessage(long busAddr, long moduleAddr, byte[] message);
 
     private long _busAddr;
 
     public MessageBus(long addr){
         this._busAddr = addr;
     }
 
-    public int publishMessage(Message message) throws IOException {
-        return this.publishMessage(this._busAddr, message.toByteArray());
+    public int publishMessage(Message message, long moduleAddr) throws IOException {
+        return this.publishMessage(this._busAddr, moduleAddr, message.toByteArray());
     }
 
     public long getAddress(){

bindings/java/gateway-java-binding/src/test/java/tests/unit/com/microsoft/azure/gateway/core/GatewayModuleTest.java

@@ -7,6 +7,7 @@
 import com.microsoft.azure.gateway.core.GatewayModule;
 import com.microsoft.azure.gateway.core.MessageBus;
 import com.microsoft.azure.gateway.messaging.Message;
+import mockit.Deencapsulation;
 import mockit.Mocked;
 import org.junit.Test;
 
@@ -17,27 +18,37 @@ public class GatewayModuleTest {
     @Mocked(stubOutClassInitialization = true)
     protected MessageBus mockBus;
 
-    /*Codes_SRS_JAVA_GATEWAY_MODULE_14_001: [ The constructor shall save address, bus, and configuration into class variables. ]*/
+    /*Tests_SRS_JAVA_GATEWAY_MODULE_14_001: [ The constructor shall save address, bus, and configuration into class variables. ]*/
     @Test
     public void constructorSavesAllDataSuccess(){
         long address = 0x12345678;
         String configuration = "\"test-configuration\"";
 
-        GatewayModule module = new TestModule(mockBus, configuration);
+        GatewayModule module = new TestModule(address, mockBus, configuration);
 
         MessageBus expectedBus = module.getMessageBus();
+        long expectedAddress = Deencapsulation.getField(module, "_addr");
         String expectedConfiguration = module.getConfiguration();
 
         assertEquals(mockBus, expectedBus);
+        assertEquals(address, expectedAddress);
         assertEquals(configuration, expectedConfiguration);
     }
 
-    /*Codes_SRS_JAVA_GATEWAY_MODULE_14_002: [ If address or bus is null the constructor shall throw an IllegalArgumentException. ]*/
+    /*Tests_SRS_JAVA_GATEWAY_MODULE_14_002: [ If address or bus is null the constructor shall throw an IllegalArgumentException. ]*/
     @Test(expected = IllegalArgumentException.class)
     public void constructorThrowsExceptionForNullMessageBus(){
         long address = 0x12345678;
 
-        GatewayModule module = new TestModule(null, null);
+        GatewayModule module = new TestModule(address, null, null);
+    }
+
+    /*Tests_SRS_JAVA_GATEWAY_MODULE_14_002: [ If address or bus is null the constructor shall throw an IllegalArgumentException. ]*/
+    @Test(expected = IllegalArgumentException.class)
+    public void constructorThrowsExceptionForNullMessageAddr(){
+        long address = 0;
+
+        GatewayModule module = new TestModule(0, mockBus, null);
     }
 
     public class TestModule extends GatewayModule{
@@ -46,11 +57,12 @@ public class TestModule extends GatewayModule{
          * Constructs a {@link GatewayModule} from the provided address and {@link MessageBus}. A {@link GatewayModule} should always call this super
          * constructor before any module-specific constructor code.
          *
+         * @param address       The address of the native module pointer
          * @param bus           The {@link MessageBus} to which this module belongs
          * @param configuration The module-specific configuration
          */
-        public TestModule(MessageBus bus, String configuration) {
-            super(bus, configuration);
+        public TestModule(long address, MessageBus bus, String configuration) {
+            super(address, bus, configuration);
         }
 
         @Override

bindings/java/gateway-java-binding/src/test/java/tests/unit/com/microsoft/azure/gateway/messaging/MessageTest.java

@@ -37,6 +37,17 @@ public class MessageTest {
                     0x00, 0x00, 0x00, 0x02,  /*2 message content size*/
                     '3', '4'
             };
+
+    public byte[] validMessagePropertySwap =
+            {
+                    (byte) 0xA1, 0x60,       /*header*/
+                    0x00, 0x00, 0x00, 64,   /*size of this array*/
+                    0x00, 0x00, 0x00, 0x02, /*two properties*/
+                    'A', 'z','u','r','e',' ','I','o','T',' ','G','a','t','e','w','a','y',' ','i','s','\0','a','w','e','s','o','m','e','\0',
+                    'B','l','e','e','d','i','n','g','E','d','g','e','\0','r','o','c','k','s','\0',
+                    0x00, 0x00, 0x00, 0x02,  /*2 message content size*/
+                    '3', '4'
+            };
 
     /*Tests_SRS_JAVA_MESSAGE_14_003: [ The constructor shall save the message content and properties map. ]*/
     @Test
@@ -241,7 +252,7 @@ public void toByteArraySerializesMessageSuccess() throws IOException {
 
         byte[] actualByteArray = m.toByteArray();
 
-        assertTrue(Arrays.equals(validMessage, actualByteArray));
+        assertTrue(Arrays.equals(validMessage, actualByteArray) || Arrays.equals(validMessagePropertySwap, actualByteArray));
     }
 
     /*Tests_SRS_JAVA_MESSAGE_14_005: [ The function shall return throw an IOException if the Message could not be serialized. ]*/

bindings/java/inc/Java_module_host_common.h bindings/java/inc/java_module_host_common.h

@@ -11,7 +11,7 @@
 #define MODULE_DESTROY_DESCRIPTOR "()V"
 #define MODULE_RECEIVE_DESCRIPTOR "([B)V"
 #define MESSAGE_BUS_CONSTRUCTOR_DESCRIPTOR "(J)V"
-#define MODULE_CONSTRUCTOR_DESCRIPTOR "(Lcom/microsoft/azure/gateway/core/MessageBus;Ljava/lang/String;)V"
+#define MODULE_CONSTRUCTOR_DESCRIPTOR "(JLcom/microsoft/azure/gateway/core/MessageBus;Ljava/lang/String;)V"
 #define DEBUG_PORT_DEFAULT 9876
 
 #endif /*JAVA_MODULE_HOST_COMMON_H*/

bindings/java/inc/message_bus_proxy.h

@@ -64,6 +64,11 @@ typedef signed char jbyte;
 #define JNIFunc(jptr, call, ...) (*(jptr))->call(jptr, ##__VA_ARGS__)
 #endif
 
+/* We currently have a dependency on Java 1.6, in case the user doesn't have Java 1.8 this will define the symbol so this will be able to compile.*/
+#ifndef JNI_VERSION_1_8
+#define JNI_VERSION_1_8 0x00010008
+#endif
+
 typedef struct JAVA_MODULE_HANDLE_DATA_TAG
 {
 	JavaVM* jvm;
@@ -232,7 +237,7 @@ static MODULE_HANDLE JavaModuleHost_Create(MESSAGE_BUS_HANDLE bus, const void* c
 												}
 												else
 												{
-													jobject jModule_object = NewObjectInternal(result->env, jModule_class, jModule_constructor, 2, jMessageBus_object, jModule_configuration);
+													jobject jModule_object = NewObjectInternal(result->env, jModule_class, jModule_constructor, 3, (jlong)result, jMessageBus_object, jModule_configuration);
 													exception = JNIFunc(result->env, ExceptionOccurred);
 													if (jModule_object == NULL || exception)
 													{
@@ -354,7 +359,7 @@ static void JavaModuleHost_Receive(MODULE_HANDLE module, MESSAGE_HANDLE message)
 		}
 		else
 		{
-			/*SRS_JAVA_MODULE_HOST_14_042: [This function shall attach the JVM to the current thread.]*/
+			/*Codes_SRS_JAVA_MODULE_HOST_14_042: [This function shall attach the JVM to the current thread.]*/
 			jint jni_result = JNIFunc(moduleHandle->jvm, AttachCurrentThread, (void**)(&(moduleHandle->env)), NULL);
 
 			if (jni_result == JNI_OK)
@@ -425,14 +430,14 @@ static void JavaModuleHost_Receive(MODULE_HANDLE module, MESSAGE_HANDLE message)
 
 }
 
-JNIEXPORT jint JNICALL Java_com_microsoft_azure_gateway_core_MessageBus_publishMessage(JNIEnv* env, jobject jMessageBus, jlong bus_address, jbyteArray serialized_message)
+JNIEXPORT jint JNICALL Java_com_microsoft_azure_gateway_core_MessageBus_publishMessage(JNIEnv* env, jobject jMessageBus, jlong bus_address, jlong module_address, jbyteArray serialized_message)
 {
 	/*Codes_SRS_JAVA_MODULE_HOST_14_048: [This function shall return a non - zero value if any underlying function call fails.]*/
 	MESSAGE_BUS_RESULT result = MESSAGE_BUS_ERROR;
 
 	MESSAGE_BUS_HANDLE bus = (MESSAGE_BUS_HANDLE)bus_address;
+	MODULE_HANDLE module = (MODULE_HANDLE)module_address;
 
-	/*Codes_SRS_JAVA_MODULE_HOST_14_025: [This function shall use convert the jbyteArray message into an unsigned char array.]*/
 	size_t length = JNIFunc(env, GetArrayLength, serialized_message);
 	if (length == 0)
 	{
@@ -447,6 +452,7 @@ JNIEXPORT jint JNICALL Java_com_microsoft_azure_gateway_core_MessageBus_publishM
 		}
 		else
 		{
+			/*Codes_SRS_JAVA_MODULE_HOST_14_025: [This function shall convert the jbyteArray message into an unsigned char array.]*/
 			JNIFunc(env, GetByteArrayRegion, serialized_message, 0, length, arr);
 			jthrowable exception = JNIFunc(env, ExceptionOccurred);
 			if (exception)
@@ -467,7 +473,7 @@ JNIEXPORT jint JNICALL Java_com_microsoft_azure_gateway_core_MessageBus_publishM
 				else
 				{
 					/*Codes_SRS_JAVA_MODULE_HOST_14_027: [This function shall publish the message to the MESSAGE_BUS_HANDLE addressed by addr and return the value of this function call.]*/
-					result = MessageBus_Publish(bus, message);
+					result = MessageBus_Publish(bus, module, message);
 
 					//Cleanup
 					Message_Destroy(message);