Merge pull request #90 from charithag/IoTS-1.0.0-M1

Update annotations

components/device-mgt-iot-arduino/org.wso2.carbon.device.mgt.iot.arduino.service.impl/src/main/java/org/wso2/carbon/device/mgt/iot/arduino/service/ArduinoService.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
@@ -484,10 +484,10 @@ public class ArduinoService {
      * @param state
      * @param response
      */
-    @Path("controller/bulb/{state}")
+    @Path("controller/bulb")
     @POST
-    @Feature( code="ARDUINO_BULB_CONTROL", name="Control Bulb", type = "monitor",
+    @Feature( code="bulb", name="Control Bulb", type="operation",
-            description="Control Bulb on Arduino Arduino")
+            description="Control Bulb on Arduino Uno")
     public void switchBulb(@HeaderParam("owner") String owner,
                            @HeaderParam("deviceId") String deviceId,
                            @HeaderParam("protocol") String protocol,
@@ -612,10 +612,11 @@ public class ArduinoService {
      * @param response
      * @return
      */
-    @Path("controller/readcontrols/{deviceId}")
+    @Path("controller/readcontrols")
     @GET
-    public String readControls(@QueryParam("owner") String owner,
+    public String readControls(@HeaderParam("owner") String owner,
-                               @PathParam("deviceId") String deviceId,
+                               @HeaderParam("deviceId") String deviceId,
+                               @HeaderParam("protocol") String protocol,
                                @Context HttpServletResponse response) {
         String result;
         LinkedList<String> deviceControlList = internalControlsQueue.get(deviceId);

components/device-mgt-iot-digitaldisplay/org.wso2.carbon.device.mgt.iot.digitaldisplay.api/src/main/java/org/wso2/carbon/device/mgt/iot/digitaldisplay/api/DigitalDisplayControllerService.java

@@ -69,14 +69,14 @@ public class DigitalDisplayControllerService {
      */
     @Path("/restart-browser")
     @POST
-    @Feature(code = "DISPLAY_BROWSERRESTART", name = "Restart Browser", type = "operation",
+    @Feature(code = "restart-browser", name = "Restart Browser", type="operation",
             description = "Restart Browser in Digital Display")
     public void restartBrowser(@HeaderParam("deviceId") String deviceId,
                                @HeaderParam("owner") String owner,
                                @HeaderParam("sessionId") String sessionId,
                                @Context HttpServletResponse response) {
 
-        log.info("Restrat Browser : " + deviceId);
+        log.info("Restart Browser : " + deviceId);
 
         try {
             sendCommandViaMQTT(owner, deviceId, sessionId + "::" + DigitalDisplayConstants.RESTART_BROWSER_CONSTANT + ":", "");
@@ -102,7 +102,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/close-browser")
     @POST
-    @Feature(code = "DISPLAY_BROWSERCLOSE", name = "Close Browser", type = "operation",
+    @Feature(code = "close-browser", name = "Close Browser", type="operation",
             description = "Close Browser in Digital Display")
     public void closeBrowser(@HeaderParam("deviceId") String deviceId,
                              @HeaderParam("owner") String owner,
@@ -134,8 +134,8 @@ public class DigitalDisplayControllerService {
      */
     @Path("/terminate-display")
     @POST
-    @Feature(code = "DISPLAY_TERMINATE", name = "Terminate Display", type = "operation",
+    @Feature(code = "terminate-display", name = "Terminate Display", type="operation",
-            description = "Terminate all running processe in Digital Display")
+            description = "Terminate all running process in Digital Display")
     public void terminateDisplay(@HeaderParam("deviceId") String deviceId,
                                  @HeaderParam("owner") String owner,
                                  @HeaderParam("sessionId") String sessionId,
@@ -166,14 +166,14 @@ public class DigitalDisplayControllerService {
      */
     @Path("/restart-display")
     @POST
-    @Feature(code = "DISPLAY_RESTART", name = "Restart Display", type = "operation",
+    @Feature(code = "restart-display", name = "Restart Display", type="operation",
             description = "Restart Digital Display")
     public void restartDisplay(@HeaderParam("deviceId") String deviceId,
                                @HeaderParam("owner") String owner,
                                @HeaderParam("sessionId") String sessionId,
                                @Context HttpServletResponse response) {
 
-        log.info("Restrat Display : " + deviceId);
+        log.info("Restart Display : " + deviceId);
 
         try {
             sendCommandViaMQTT(owner, deviceId, sessionId + "::" + DigitalDisplayConstants.RESTART_DISPLAY_CONSTANT + ":", "");
@@ -201,7 +201,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/edit-content")
     @POST
-    @Feature(code = "DISPLAY_EDITCONTENT", name = "Edit Content", type = "operation",
+    @Feature(code = "edit-content", name = "Edit Content", type="operation",
             description = "Search through the sequence and edit requested resource in Digital Display")
     public void editContent(@HeaderParam("deviceId") String deviceId,
                             @HeaderParam("owner") String owner,
@@ -240,7 +240,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/add-resource")
     @POST
-    @Feature(code = "DISPLAY_ADDRESOURCE", name = "Add Resource", type = "operation",
+    @Feature(code = "add-resource", name = "Add Resource", type="operation",
             description = "Add new resource end to the existing sequence in Digital Display")
     public void addNewResource(@HeaderParam("deviceId") String deviceId,
                                @HeaderParam("owner") String owner,
@@ -280,7 +280,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/add-resource-before")
     @POST
-    @Feature(code = "DISPLAY_ADDRESOURCE_BEFORE", name = "Add Resource Before", type = "operation",
+    @Feature(code = "add-resource-before", name = "Add Resource Before", type="operation",
             description = "Add new resource to sequence before given page no. in Digital Display")
     public void addNewResourceBefore(@HeaderParam("deviceId") String deviceId,
                                      @HeaderParam("owner") String owner,
@@ -323,7 +323,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/add-resource-next")
     @POST
-    @Feature(code = "DISPLAY_ADDRESOURCE_NEXT", name = "Add Resource Next", type = "operation",
+    @Feature(code = "add-resource-next", name = "Add Resource Next", type="operation",
             description = "Add new resource to sequence after given page in Digital Display")
     public void addNewResourceAfter(@HeaderParam("deviceId") String deviceId,
                                     @HeaderParam("owner") String owner,
@@ -362,7 +362,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/remove-resource")
     @POST
-    @Feature(code = "DISPLAY_REMOVE_RESOURCE", name = "Remove Resource", type = "operation",
+    @Feature(code = "remove-resource", name = "Remove Resource", type="operation",
             description = "Delete a resource from sequence in Digital Display")
     public void removeResource(@HeaderParam("deviceId") String deviceId,
                                @HeaderParam("owner") String owner,
@@ -397,7 +397,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/remove-directory")
     @POST
-    @Feature(code = "DISPLAY_REMOVE_DIR", name = "Remove Directory", type = "operation",
+    @Feature(code = "remove-directory", name = "Remove Directory", type="operation",
             description = "Remove directory and whole content in Digital Display")
     public void removeDirectory(@FormParam("directory-name") String directoryName,
                                 @HeaderParam("deviceId") String deviceId,
@@ -432,7 +432,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/remove-content")
     @POST
-    @Feature(code = "DISPLAY_REMOVE_CONTENT", name = "Remove Content", type = "operation",
+    @Feature(code = "remove-content", name = "Remove Content", type="operation",
             description = "Remove content from www folder in Digital Display")
     public void removeContent(@FormParam("directory-name") String directoryName,
                               @FormParam("content") String content,
@@ -466,7 +466,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/shutdown-display")
     @POST
-    @Feature(code = "DISPLAY_SHUTDOWN", name = "Shut Down", type = "operation",
+    @Feature(code = "shutdown-display", name = "Shut Down", type="operation",
             description = "Stop specific display in Digital Display")
     public void shutDownDisplay(@HeaderParam("deviceId") String deviceId,
                                 @HeaderParam("owner") String owner,
@@ -498,7 +498,7 @@ public class DigitalDisplayControllerService {
      */
     @Path("/get-status")
     @POST
-    @Feature(code = "DISPLAY_GET_STATUS", name = "Get Status", type = "operation",
+    @Feature(code = "get-status", name = "Get Status", type="operation",
             description = "Check specific digital display power ON of OFF")
     public void getStatus(@HeaderParam("deviceId") String deviceId,
                           @HeaderParam("owner") String owner,

components/device-mgt-iot-droneanalyzer/org.wso2.carbon.device.mgt.iot.droneanalyzer.api/src/main/java/org/wso2/carbon/device/mgt/iot/droneanalyzer/service/DroneService.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
@@ -381,9 +381,9 @@ public class DroneService {
 
     @Path("controller/send_command")
     @POST
-    @Feature( code="DRONE_SEND_COMMAND", name="Send Command", type = "operation",
+    @Feature( code="send_command", name="Send Command", type="operation",
             description="Send Commands to Drone")
-    public Response droneController(@QueryParam("owner") String owner, @QueryParam("deviceId") String deviceId,
+    public Response droneController(@HeaderParam("owner") String owner, @HeaderParam("deviceId") String deviceId,
                                  @QueryParam("action") String action, @QueryParam("duration") String duration,
                                  @QueryParam("speed") String speed){
         try {

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.advanced.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/agent/advanced/sidhdhi/SidhdhiQuery.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/agent/communication/mqtt/FireAlarmMQTTCommunicator.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.agent.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/agent/communication/xmpp/FireAlarmXMPPCommunicator.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.plugin.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/plugin/constants/VirtualFireAlarmConstants.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/service/VirtualFireAlarmService.java

@@ -570,10 +570,10 @@ public class VirtualFireAlarmService {
      * @param state
      * @param response
      */
-    @Path("controller/bulb")
+    @Path("controller/buzzer")
     @POST
-    @Feature( code="VIRTUALFIREALARM_BULBCONTROL", name="Control Bulb", type = "operation",
+    @Feature( code="buzzer", name="Buzzer On / Off", type="operation",
-            description="Switch on/off Virtual Fire Alarm Bulb")
+            description="Switch on/off Virtual Fire Alarm Buzzer. (On / Off)")
     public void switchBulb(@HeaderParam("owner") String owner,
                            @HeaderParam("deviceId") String deviceId,
                            @HeaderParam("protocol") String protocol,
@@ -657,7 +657,7 @@ public class VirtualFireAlarmService {
      */
     @Path("controller/readhumidity")
     @GET
-    @Feature( code="VIRTUALFIREALARM_READHUMIDITY", name="Read Humidity", type = "monitor",
+    @Feature( code="readhumidity", name="Humidity", type = "monitor",
             description="Read Humidity Readings from Virtual Fire Alarm")
     public String requestHumidity(@HeaderParam("owner") String owner,
                                   @HeaderParam("deviceId") String deviceId,
@@ -738,8 +738,8 @@ public class VirtualFireAlarmService {
     @GET
     @Consumes(MediaType.APPLICATION_JSON)
     @Produces(MediaType.APPLICATION_JSON)
-    @Feature( code="VIRTUALFIREALARM_REQTEMP", name="Request Tempreature", type = "monitor",
+    @Feature( code="readtemperature", name="Temperature", type="monitor",
-            description="Request Tempreature reading from Virtual Fire Alarm")
+            description="Request Temperature reading from Virtual Fire Alarm")
     public SensorRecord requestTemperature(@HeaderParam("owner") String owner,
                                            @HeaderParam("deviceId") String deviceId,
                                            @HeaderParam("protocol") String protocol,

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/service/transport/VirtualFireAlarmMQTTConnector.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/service/transport/VirtualFireAlarmXMPPConnector.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/java/org/wso2/carbon/device/mgt/iot/virtualfirealarm/service/util/VirtualFireAlarmServiceUtils.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/webapp/META-INF/resources.xml

@@ -5,14 +5,14 @@
   ~ WSO2 Inc. 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
+  ~ You may obtain a copy of the License at
   ~
-  ~   http://www.apache.org/licenses/LICENSE-2.0
+  ~ 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
+  ~ KIND, either express or implied. See the License for the
   ~ specific language governing permissions and limitations
   ~ under the License.
   -->

components/device-mgt-iot-virtualfirealarm/org.wso2.carbon.device.mgt.iot.virtualfirealarm.service.impl/src/main/webapp/WEB-INF/cxf-servlet.xml

@@ -13,7 +13,7 @@
   ~ 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
+  ~ KIND, either express or implied. See the License for the
   ~ specific language governing permissions and limitations
   ~ under the License.
   -->

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/DeviceController.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/controlqueue/xmpp/XmppAccount.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/controlqueue/xmpp/XmppServerClient.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/transport/TransportHandler.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/transport/mqtt/MQTTTransportHandler.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

components/device-mgt-iot/org.wso2.carbon.device.mgt.iot/src/main/java/org/wso2/carbon/device/mgt/iot/transport/xmpp/XMPPTransportHandler.java

@@ -11,7 +11,7 @@
  * 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
+ * KIND, either express or implied. See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */