From 2f2205abc7bee5754af23e4eb19cc3b74d76128f Mon Sep 17 00:00:00 2001 From: charithag Date: Tue, 22 Dec 2015 14:25:32 +0530 Subject: [PATCH] Update annotations --- .../iot/arduino/service/ArduinoService.java | 19 +++++------ .../api/DigitalDisplayControllerService.java | 32 +++++++++---------- .../droneanalyzer/service/DroneService.java | 6 ++-- .../service/VirtualFireAlarmService.java | 12 +++---- 4 files changed, 32 insertions(+), 37 deletions(-) diff --git a/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 b/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 index dbf5a1904c..88b562f948 100644 --- a/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 +++ b/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", - description="Control Bulb on Arduino Arduino") + @Feature( code="bulb", name="Control Bulb", type="operation", + description="Control Bulb on Arduino Uno") public void switchBulb(@HeaderParam("owner") String owner, @HeaderParam("deviceId") String deviceId, @HeaderParam("protocol") String protocol, @@ -557,8 +557,6 @@ public class ArduinoService { @Path("controller/pushdata") @POST @Consumes(MediaType.APPLICATION_JSON) - @Feature( code="ARDUINO_READ_DATA", name="Read Data", - description="Read Data from Arduino") public void pushData(final DeviceJSON dataMsg, @Context HttpServletResponse response) { String owner = dataMsg.owner; @@ -614,10 +612,11 @@ public class ArduinoService { * @param response * @return */ - @Path("controller/readcontrols/{deviceId}") + @Path("controller/readcontrols") @GET - public String readControls(@QueryParam("owner") String owner, - @PathParam("deviceId") String deviceId, + public String readControls(@HeaderParam("owner") String owner, + @HeaderParam("deviceId") String deviceId, + @HeaderParam("protocol") String protocol, @Context HttpServletResponse response) { String result; LinkedList deviceControlList = internalControlsQueue.get(deviceId); @@ -651,8 +650,6 @@ public class ArduinoService { @Path("controller/push_temperature") @POST @Consumes(MediaType.APPLICATION_JSON) - @Feature( code="ARDUINO_READ_TEMP", name="Read Tempreature", - description="Read Tempreature from Arduino") public void pushTemperatureData(final DeviceJSON dataMsg, @Context HttpServletResponse response, @Context HttpServletRequest request) { diff --git a/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 b/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 index 8a84572a22..3024afb7dc 100644 --- a/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 +++ b/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", + @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", + @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", - description = "Terminate all running processe in Digital Display") + @Feature(code = "terminate-display", name = "Terminate Display", type="operation", + 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", + @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", + @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", + @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", + @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", + @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", + @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", + @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", + @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", + @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", + @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, diff --git a/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 b/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 index 1d2330a76c..79eac5838c 100644 --- a/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 +++ b/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", + @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 { diff --git a/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 b/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 index 34f31b4dd2..9c66a4731f 100644 --- a/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 +++ b/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", - description="Switch on/off Virtual Fire Alarm Bulb") + @Feature( code="buzzer", name="Buzzer On / Off", type="operation", + 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, @@ -655,8 +655,6 @@ public class VirtualFireAlarmService { */ @Path("controller/readsonar") @GET - @Feature( code="VIRTUALFIREALARM_READSONAR", name="Read Sonar", - description="Read Sonar Readings from Virtual Fire Alarm") public String requestSonarReading(@HeaderParam("owner") String owner, @HeaderParam("deviceId") String deviceId, @HeaderParam("protocol") String protocol, @@ -740,8 +738,8 @@ public class VirtualFireAlarmService { @GET @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) - @Feature( code="VIRTUALFIREALARM_REQTEMP", name="Request Tempreature", - description="Request Tempreature reading from Virtual Fire Alarm") + @Feature( code="readtemperature", name="Request Temperature", type="monitor", + description="Request Temperature reading from Virtual Fire Alarm") public SensorRecord requestTemperature(@HeaderParam("owner") String owner, @HeaderParam("deviceId") String deviceId, @HeaderParam("protocol") String protocol,