JAVA - Client APIs

Overview

This section describes how to use/implement the Java library Client API  functions available to interact with the deviceWISE Cloud. The base class DwClient contains all the basic TR50 connection and communication APIs. Two additional classes DwMqttClient and DwHttpClient have been provided that extend the base set of client APIs to implement the TR50 connection and communication functions in MQTT and HTTP respectively.

DwClient

Constructors

Methods

Notes

• All current client implementations - DwMqttClient and DwHttpClient are subclasses of the abstract DwClient class and extend all of the API functions listed above.
• All current client implementations - DwMqttClient and DwHttpClient implement the abstract methods connect(), disconnect(), sendJsonRequest() and sendAsyncJsonRequest() based on the protocol spec.
• All current clients use the common DwOpenWorker, which is initialized by calling each clients super() - DwClient constructor class. This initializes the common set of JAVA - Worker APIs that allow interaction with the M2M Service APIs. See DwMqttClient and DwHttpClient implementations below for specific connection and communication related examples.

DwCommand (TR50 Command)

DwPacket ( TR50 Message )

• java.lang.Object
  • com.devicewise.tr50.protocol.DwPacket
  • extends java.lang.Object implements IDwPacket

     
    @Test
    public void testMultiCommandPacketParser() throws DwOpenException, IOException{
        
        DwPacket packet = new DwPacket();
        DwCommand cmd1 = new DwCommand(DwOpenCommands.CMD_API_THING_LIST);
        cmd1.addIntegerParam("offset",0);
        cmd1.addIntegerParam("limit", 10);
        DwCommand cmd2 = new DwCommand(DwOpenCommands.CMD_API_THINGDEF_LIST);
        packet.addCommand("corrId1",cmd1);
        packet.addCommand("corrId2",cmd2);
        
        Assert.assertTrue(packet.getRequest().equals("{\"corrId1\":{\"command\":\"thing.list\",\"params\":{\"offset\":0,\"limit\":10}},\"corrId2\":{\"command\":\"thing_def.list\",\"params\":{}}}"));
        
        Assert.assertEquals(client.sendPacket(packet),0);
        
        DwOpenThingList list = new DwOpenThingList();
        list.getCorrId();
        list.parseResponse("corrId1",packet.getResponse());
        DwOpenThingDefList defList = new DwOpenThingDefList();
        defList.setCorrId("corrId2");
        defList.parseResponse(packet.getResponse());
        
        Assert.assertTrue(list.isSuccess());
        Assert.assertTrue(defList.isSuccess());
        Assert.assertNotNull(list.getResult());
        Assert.assertEquals(list.getResult().size(), 10);
        Assert.assertNotNull(defList.getResult());
        Assert.assertTrue(defList.getResult().size()>0 && defList.getResult().size()<5);
        
        LinkedHashMap<String,Object> response = packet.getRawResponse("corrId2");
        Assert.assertTrue((boolean)response.get("success"));
 
        LinkedHashMap<String,Object> params = ((LinkedHashMap<String,Object>)(packet.getRawResponse("1").get("params")));
        ArrayList<LinkedHashMap<String,Object>> result = (ArrayList<LinkedHashMap<String,Object>>)params.get("result");
        Assert.assertTrue(result.size()==10);
    }
 

DwMqttClient

Usage Examples: Authenticating and Making an API call with the MQTT Client

     public void MQTTClientAsUser() throws Exception{
        
        DwMqttClient user= new DwMqttClient();
        user.initialize(MqttConstants.DEFAULT_MQTTHOST, true, "tr50_client_id");
        user.authenticate("tr50user","tr50password");
        DwOpenWorker worker = client.getWorker();
        
        DwOpenLocationEncodeDecode response = new DwOpenLocationEncodeDecode();
        
        worker.Location().decode(30.455, -84.25333,response);
        
        user.disconnect();
    }
 
    public void MQTTClientAsThing() throws Exception{
        
        DwMqttClient thing= new DwMqttClient();
        thing.initialize(MqttConstants.DEFAULT_MQTTHOST, true, "tr50_client_id");
        thing.authenticate("myThingKey","myAppToken");
        DwOpenWorker worker = client.getWorker();
        
        DwOpenLocationEncodeDecode response = new DwOpenLocationEncodeDecode();
        
        worker.Location().decode(30.455, -84.25333,response);
        
        thing.disconnect();
    }

DwHttpClient

 public void HTTPClientAsUser() throws Exception{
        
        DwHttpClient user= new DwHttpClient();
        user.initialize("https://my.openserver.com/api");
        user.authenticate("tr50user","tr50password");
        DwOpenWorker worker = client.getWorker();
        
        DwOpenLocationEncodeDecode response = new DwOpenLocationEncodeDecode();
        
        worker.Location().decode(30.455, -84.25333,response); // does a connect, send and disconnect as per HTTP 1.0 Protocol Spec
    }
 
    public void HTTPClientAsThing() throws Exception{
        
        DwHttpClient thing= new DwHttpClient();
        thing.initialize("https://my.openserver.com/api");
        thing.authenticate("myThingKey","myAppToken");
        DwOpenWorker worker = client.getWorker();
        
        DwOpenLocationEncodeDecode response = new DwOpenLocationEncodeDecode();
        
        worker.Location().decode(30.455, -84.25333,response); // does a connect, send and disconnect as per HTTP 1.0 Protocol Spec
    }