Merge pull request #215 from rasika90/master

Adding support for Generic Feature Manager to generate operations

components/device-mgt/org.wso2.carbon.device.mgt.extensions/src/main/java/org/wso2/carbon/device/mgt/extensions/feature/mgt/util/AnnotationUtil.java

@@ -35,6 +35,9 @@ import javax.ws.rs.HttpMethod;
 import javax.ws.rs.OPTIONS;
 import javax.ws.rs.POST;
 import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.QueryParam;
 import java.io.IOException;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.InvocationHandler;
@@ -61,7 +64,8 @@ public class AnnotationUtil {
     private static final String PACKAGE_ORG_SPRINGFRAMEWORK = "org.springframework";
     public static final String STRING_ARR = "string_arr";
     public static final String STRING = "string";
-    private Class<org.wso2.carbon.device.mgt.extensions.feature.mgt.annotations.Feature> featureClazz;
+    private Class<org.wso2.carbon.device.mgt.extensions.feature.mgt.annotations.Feature>
+            featureAnnotationClazz;
     private ClassLoader classLoader;
     private ServletContext servletContext;
 
@@ -108,7 +112,7 @@ public class AnnotationUtil {
                                     if (deviceTypeAnno != null) {
                                         Method[] deviceTypeMethod = deviceTypeClazz.getMethods();
                                         String deviceType = invokeMethod(deviceTypeMethod[0], deviceTypeAnno, STRING);
-                                        featureClazz =
+                                        featureAnnotationClazz =
                                                 (Class<org.wso2.carbon.device.mgt.extensions.feature.mgt.annotations
                                                         .Feature>) classLoader.loadClass(
                                                         org.wso2.carbon.device.mgt.extensions.feature.mgt
@@ -130,19 +134,87 @@ public class AnnotationUtil {
         return features;
     }
 
-    private List<Feature> getFeatures(Method[] annotatedMethods) throws Throwable {
+    private List<Feature> getFeatures(Method[] methodsList) throws Throwable {
         List<Feature> featureList = new ArrayList<>();
-        for (Method method : annotatedMethods) {
+        for (Method currentMethod : methodsList) {
-            Annotation methodAnnotation = method.getAnnotation(featureClazz);
+            Annotation featureAnnotation = currentMethod.getAnnotation(featureAnnotationClazz);
-            if (methodAnnotation != null) {
+            if (featureAnnotation != null) {
-                Annotation[] annotations = method.getDeclaredAnnotations();
-                for (int i = 0; i < annotations.length; i++) {
-                    if (annotations[i].annotationType().getName().equals(
-                            org.wso2.carbon.device.mgt.extensions.feature.mgt.annotations.Feature.class.getName())) {
                 Feature feature = new Feature();
-                        Method[] featureAnnoMethods = featureClazz.getMethods();
+                feature = processFeatureAnnotation(feature, currentMethod);
-                        Annotation featureAnno = method.getAnnotation(featureClazz);
+                Annotation[] annotations = currentMethod.getDeclaredAnnotations();
+                Feature.MetadataEntry metadataEntry = new Feature.MetadataEntry();
+                metadataEntry.setId(-1);
+                Map<String, Object> apiParams = new HashMap<>();
+                for (int i = 0; i < annotations.length; i++) {
+                    Annotation currentAnnotation = annotations[i];
+                    feature = processHttpMethodAnnotation(feature, currentAnnotation);
+                    if (currentAnnotation.annotationType().getName().equals(Path.class.getName())) {
+                        String uri = getPathAnnotationValue(currentMethod);
+                        apiParams.put("uri", uri);
+                    }
+                    apiParams = processParamAnnotations(apiParams, currentMethod);
+                }
+                metadataEntry.setValue(apiParams);
+                List<Feature.MetadataEntry> metaInfoList = new ArrayList<>();
+                metaInfoList.add(metadataEntry);
+                feature.setMetadataEntries(metaInfoList);
+                featureList.add(feature);
+            }
+        }
+        return featureList;
+    }
 
+    private Map<String, Object> processParamAnnotations(Map<String, Object> apiParams, Method currentMethod) throws Throwable{
+        try {
+            apiParams.put("pathParams", processParamAnnotations(currentMethod, PathParam.class));
+            apiParams.put("queryParams", processParamAnnotations(currentMethod, QueryParam.class));
+            apiParams.put("formParams", processParamAnnotations(currentMethod, FormParam.class));
+        } catch (ClassNotFoundException e) {
+            log.debug("No Form Param found for class " + featureAnnotationClazz.getName());
+        }
+        return apiParams;
+    }
+
+    private List<String> processParamAnnotations(Method currentMethod, Class<?> clazz) throws Throwable{
+        List<String> params = new ArrayList<>();
+        try {
+            Class<?> paramClazz = (Class<?>) classLoader.loadClass(clazz.getName());
+            Method[] formMethods = paramClazz.getMethods();
+            //Extract method parameter information and store same as feature meta info
+            Annotation[][] paramAnnotations = currentMethod.getParameterAnnotations();
+            Method valueMethod = formMethods[0];
+            for (int j = 0; j < paramAnnotations.length; j++) {
+                for (Annotation anno : paramAnnotations[j]) {
+                    if (anno.annotationType().getName().equals(clazz.getName())) {
+                        params.add(invokeMethod(valueMethod, anno, STRING));
+                    }
+                }
+            }
+        } catch (ClassNotFoundException e) {
+            log.debug("No "+ clazz.getName() +" Param found for class " + featureAnnotationClazz.getName());
+        }
+        return params;
+    }
+
+    private Feature processHttpMethodAnnotation(Feature feature, Annotation currentAnnotation) {
+        //Extracting method with which feature is exposed
+        if (currentAnnotation.annotationType().getName().equals(GET.class.getName())) {
+            feature.setMethod(HttpMethod.GET);
+        } else if (currentAnnotation.annotationType().getName().equals(POST.class.getName())) {
+            feature.setMethod(HttpMethod.POST);
+        } else if (currentAnnotation.annotationType().getName().equals(OPTIONS.class.getName())) {
+            feature.setMethod(HttpMethod.OPTIONS);
+        } else if (currentAnnotation.annotationType().getName().equals(DELETE.class.getName())) {
+            feature.setMethod(HttpMethod.DELETE);
+        } else if (currentAnnotation.annotationType().getName().equals(PUT.class.getName())) {
+            feature.setMethod(HttpMethod.PUT);
+        }
+        return feature;
+    }
+
+    private Feature processFeatureAnnotation(Feature feature, Method currentMethod) throws Throwable{
+        Method[] featureAnnoMethods = featureAnnotationClazz.getMethods();
+        Annotation featureAnno = currentMethod.getAnnotation(featureAnnotationClazz);
         for (int k = 0; k < featureAnnoMethods.length; k++) {
             switch (featureAnnoMethods[k].getName()) {
             case "name":
@@ -159,49 +231,21 @@ public class AnnotationUtil {
                 break;
             }
         }
-                        //Extracting method with which feature is exposed
+        return feature;
-                        if (annotations[i].annotationType().getName().equals(GET.class.getName())) {
-                            feature.setMethod(HttpMethod.GET);
-                        }
-                        if (annotations[i].annotationType().getName().equals(POST.class.getName())) {
-                            feature.setMethod(HttpMethod.POST);
-                        }
-                        if (annotations[i].annotationType().getName().equals(OPTIONS.class.getName())) {
-                            feature.setMethod(HttpMethod.OPTIONS);
-                        }
-                        if (annotations[i].annotationType().getName().equals(DELETE.class.getName())) {
-                            feature.setMethod(HttpMethod.DELETE);
-                        }
-                        if (annotations[i].annotationType().getName().equals(PUT.class.getName())) {
-                            feature.setMethod(HttpMethod.PUT);
     }
+
+    public String getPathAnnotationValue(Method currentMethod) throws Throwable{
+        String uri = "";
         try {
-                            Class<FormParam> formParamClazz = (Class<FormParam>) classLoader.loadClass(
+            Class<Path> pathClazz = (Class<Path>) classLoader.loadClass(Path.class.getName());
-                                    FormParam.class.getName());
+            Annotation pathAnnno = currentMethod.getAnnotation(pathClazz);
-                            Method[] formMethods = formParamClazz.getMethods();
+            Method[] pathMethods = pathClazz.getMethods();
-                            //Extract method parameter information and store same as feature meta info
+            Method valueMethod = pathMethods[0];
-                            List<Feature.MetadataEntry> metaInfoList = new ArrayList<>();
+            uri =  invokeMethod(valueMethod, pathAnnno, STRING);
-                            Annotation[][] paramAnnotations = method.getParameterAnnotations();
-                            for (int j = 0; j < paramAnnotations.length; j++) {
-                                for (Annotation anno : paramAnnotations[j]) {
-                                    if (anno.annotationType().getName().equals(FormParam.class.getName())) {
-                                        Feature.MetadataEntry metadataEntry = new Feature.MetadataEntry();
-                                        metadataEntry.setId(j);
-                                        metadataEntry.setValue(invokeMethod(formMethods[0], anno, STRING));
-                                        metaInfoList.add(metadataEntry);
-                                    }
-                                }
-                            }
-                            feature.setMetadataEntries(metaInfoList);
         } catch (ClassNotFoundException e) {
-                            log.debug("No Form Param found for class " + featureClazz.getName());
+            log.debug("No Path Param found for class " + featureAnnotationClazz.getName());
-                        }
-                        featureList.add(feature);
         }
-                }
+        return uri;
-            }
-        }
-        return featureList;
     }
 
     /**

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/api/invoker-api.jag

@@ -30,11 +30,13 @@ var result;
 
 if (uriMatcher.match("/{context}/api/invoker/execute/")) {
     var method = request.getContent().actionMethod;
-    var targetURL = devicemgtProps.httpsURL + request.getContent().actionUrl;
+    var targetURL = getTargetUrl(devicemgtProps.httpsURL, request.getContent().actionUrl);
     var payload = request.getContent().actionPayload;
+    var contentType = request.getHeader(constants.CONTENT_TYPE_IDENTIFIER);
+    var acceptType = request.getHeader(constants.ACCEPT_IDENTIFIER);
     if (method == undefined && payload == undefined) {
         method = parse(request.getContent()).actionMethod;
-        targetURL = devicemgtProps.httpsURL + parse(request.getContent()).actionUrl;
+        targetURL = getTargetUrl(devicemgtProps.httpsURL, parse(request.getContent()).actionUrl);
         payload = parse(request.getContent()).actionPayload;
     }
     try {
@@ -48,7 +50,9 @@ if (uriMatcher.match("/{context}/api/invoker/execute/")) {
                         function (responsePayload) {
                             response.status = responsePayload.status;
                             response.content = responsePayload.responseText;
-                        });
+                        },
+                        contentType,
+                        acceptType);
                 break;
             case constants.HTTP_POST:
                 var responseData = serviceInvokers.XMLHttp.post(
@@ -59,7 +63,9 @@ if (uriMatcher.match("/{context}/api/invoker/execute/")) {
                         function (responsePayload) {
                             response.status = responsePayload.status;
                             response.content = responsePayload.responseText;
-                        });
+                        },
+                        contentType,
+                        acceptType);
                 break;
             case constants.HTTP_PUT:
                 var responseData = serviceInvokers.XMLHttp.put(
@@ -70,11 +76,12 @@ if (uriMatcher.match("/{context}/api/invoker/execute/")) {
                         function (responsePayload) {
                             response.status = responsePayload.status;
                             response.content = responsePayload.responseText;
-                        });
+                        },
+                        contentType,
+                        acceptType);
                 break;
             case constants.HTTP_DELETE:
-                var responseData =
+                var responseData = serviceInvokers.XMLHttp.delete(
-                        serviceInvokers.XMLHttp.delete(
                         targetURL, function (responsePayload) {
                             response.status = 200;
                             response.content = responsePayload;
@@ -82,7 +89,9 @@ if (uriMatcher.match("/{context}/api/invoker/execute/")) {
                         function (responsePayload) {
                             response.status = responsePayload.status;
                             response.content = responsePayload.responseText;
-                                });
+                        },
+                        contentType,
+                        acceptType);
                 break;
         }
     } catch (e) {
@@ -90,4 +99,12 @@ if (uriMatcher.match("/{context}/api/invoker/execute/")) {
     }
 }
 
+function getTargetUrl(serverUrl, actionUrl){
+    if(actionUrl == undefined || actionUrl.lastIndexOf("http", 0) === 0){
+        return actionUrl;
+    } else {
+        return serverUrl + actionUrl;
+    }
+}
+
 %>

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/modules/backend-service-invoker.js

@@ -54,11 +54,17 @@ var backendServiceInvoker = function () {
      * @param errorCallback a function to be called if en error is reserved.
      * @param count a counter which hold the number of recursive execution
      */
-    privateMethods.execute = function (method, url, successCallback, errorCallback, payload, count) {
+    privateMethods.execute = function (method, url, successCallback, errorCallback, payload, count, contentType, acceptType) {
         var xmlHttpRequest = new XMLHttpRequest();
         xmlHttpRequest.open(method, url);
-        xmlHttpRequest.setRequestHeader(constants.CONTENT_TYPE_IDENTIFIER, constants.APPLICATION_JSON);
+        if(!contentType){
-        xmlHttpRequest.setRequestHeader(constants.ACCEPT_IDENTIFIER, constants.APPLICATION_JSON);
+            contentType = constants.APPLICATION_JSON;
+        }
+        if(!acceptType){
+            acceptType = constants.APPLICATION_JSON;
+        }
+        xmlHttpRequest.setRequestHeader(constants.CONTENT_TYPE_IDENTIFIER, contentType);
+        xmlHttpRequest.setRequestHeader(constants.ACCEPT_IDENTIFIER, acceptType);
         if (IS_OAUTH_ENABLED) {
             var accessToken = privateMethods.getAccessToken();
             if (!accessToken) {
@@ -98,9 +104,9 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    privateMethods.initiateXMLHTTPRequest = function (method, url, successCallback, errorCallback, payload) {
+    privateMethods.initiateXMLHTTPRequest = function (method, url, successCallback, errorCallback, payload, contentType, acceptType) {
         if (privateMethods.getAccessToken()) {
-            return privateMethods.execute(method, url, successCallback, errorCallback, payload, 0);
+            return privateMethods.execute(method, url, successCallback, errorCallback, payload, 0, contentType, acceptType);
         }
     };
 
@@ -112,7 +118,7 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    privateMethods.initiateHTTPClientRequest = function (method, url, successCallback, errorCallback, payload) {
+    privateMethods.initiateHTTPClientRequest = function (method, url, successCallback, errorCallback, payload, contentType, acceptType) {
         var HttpClient = Packages.org.apache.commons.httpclient.HttpClient;
         var httpMethodObject;
         switch (method) {
@@ -138,11 +144,11 @@ var backendServiceInvoker = function () {
         var Header = Packages.org.apache.commons.httpclient.Header;
         var header = new Header();
         header.setName(constants.CONTENT_TYPE_IDENTIFIER);
-        header.setValue(constants.APPLICATION_JSON);
+        header.setValue(contentType);
         httpMethodObject.addRequestHeader(header);
         header = new Header();
         header.setName(constants.ACCEPT_IDENTIFIER);
-        header.setValue(constants.APPLICATION_JSON);
+        header.setValue(acceptType);
         httpMethodObject.addRequestHeader(header);
         if (IS_OAUTH_ENABLED) {
             var accessToken = privateMethods.getAccessToken();
@@ -226,8 +232,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicXMLHTTPInvokers.get = function (url, successCallback, errorCallback) {
+    publicXMLHTTPInvokers.get = function (url, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_GET, url, successCallback, errorCallback);
+        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_GET, url, successCallback, errorCallback, contentType, acceptType);
     };
 
     /**
@@ -237,8 +243,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicXMLHTTPInvokers.post = function (url, payload, successCallback, errorCallback) {
+    publicXMLHTTPInvokers.post = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_POST, url, successCallback, errorCallback, payload);
+        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_POST, url, successCallback, errorCallback, payload, contentType, acceptType);
     };
 
     /**
@@ -248,8 +254,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicXMLHTTPInvokers.put = function (url, payload, successCallback, errorCallback) {
+    publicXMLHTTPInvokers.put = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_PUT, url, successCallback, errorCallback, payload);
+        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_PUT, url, successCallback, errorCallback, payload, contentType, acceptType);
     };
 
     /**
@@ -258,8 +264,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicXMLHTTPInvokers.delete = function (url, successCallback, errorCallback) {
+    publicXMLHTTPInvokers.delete = function (url, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_DELETE, url, successCallback, errorCallback);
+        return privateMethods.initiateXMLHTTPRequest(constants.HTTP_DELETE, url, successCallback, errorCallback, contentType, acceptType);
     };
 
     /**
@@ -281,8 +287,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.get = function (url, successCallback, errorCallback) {
+    publicHTTPClientInvokers.get = function (url, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateHTTPClientRequest(constants.HTTP_GET, url, successCallback, errorCallback);
+        return privateMethods.initiateHTTPClientRequest(constants.HTTP_GET, url, successCallback, errorCallback, contentType, acceptType);
     };
 
     /**
@@ -292,9 +298,9 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.post = function (url, payload, successCallback, errorCallback) {
+    publicHTTPClientInvokers.post = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
         return privateMethods.
-            initiateHTTPClientRequest(constants.HTTP_POST, url, successCallback, errorCallback, payload);
+            initiateHTTPClientRequest(constants.HTTP_POST, url, successCallback, errorCallback, payload, contentType, acceptType);
     };
 
     /**
@@ -304,8 +310,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.put = function (url, payload, successCallback, errorCallback) {
+    publicHTTPClientInvokers.put = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateHTTPClientRequest(constants.HTTP_PUT, url, successCallback, errorCallback, payload);
+        return privateMethods.initiateHTTPClientRequest(constants.HTTP_PUT, url, successCallback, errorCallback, payload, contentType, acceptType);
     };
 
     /**
@@ -314,8 +320,8 @@ var backendServiceInvoker = function () {
      * @param successCallback a function to be called if the respond if successful.
      * @param errorCallback a function to be called if en error is reserved.
      */
-    publicHTTPClientInvokers.delete = function (url, successCallback, errorCallback) {
+    publicHTTPClientInvokers.delete = function (url, successCallback, errorCallback, contentType, acceptType) {
-        return privateMethods.initiateHTTPClientRequest(constants.HTTP_DELETE, url, successCallback, errorCallback);
+        return privateMethods.initiateHTTPClientRequest(constants.HTTP_DELETE, url, successCallback, errorCallback, contentType, acceptType);
     };
 
     var publicInvokers = {};

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/modules/operation.js

@@ -60,6 +60,7 @@ var operationModule = function () {
                 }
                 feature["operation"] = features[i].code;
                 feature["name"] = features[i].name;
+                feature["method"] = features[i].method;
                 feature["description"] = features[i].description;
                 feature["deviceType"] = deviceType;
                 feature["params"] = [];

components/device-mgt/org.wso2.carbon.device.mgt.ui/src/main/resources/jaggeryapps/devicemgt/app/units/cdmf.unit.lib.service-invoker-utility/public/js/invoker-lib.js

@@ -22,33 +22,42 @@ var invokerUtil = function () {
 
     var END_POINT = window.location.origin+"/devicemgt/api/invoker/execute/";
 
-    module.get = function (url, successCallback, errorCallback) {
+    module.get = function (url, successCallback, errorCallback, contentType, acceptType) {
         var payload = null;
-        execute("GET", url, payload, successCallback, errorCallback);
+        execute("GET", url, payload, successCallback, errorCallback, contentType, acceptType);
     };
-    module.post = function (url, payload, successCallback, errorCallback) {
+    module.post = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
-        execute("POST", url, payload, successCallback, errorCallback);
+        execute("POST", url, payload, successCallback, errorCallback, contentType, acceptType);
     };
-    module.put = function (url, payload, successCallback, errorCallback) {
+    module.put = function (url, payload, successCallback, errorCallback, contentType, acceptType) {
-        execute("PUT", url, payload, successCallback, errorCallback);
+        execute("PUT", url, payload, successCallback, errorCallback, contentType, acceptType);
     };
-    module.delete = function (url, successCallback, errorCallback) {
+    module.delete = function (url, successCallback, errorCallback, contentType, acceptType) {
         var payload = null;
-        execute("DELETE", url, payload, successCallback, errorCallback);
+        execute("DELETE", url, payload, successCallback, errorCallback, contentType, acceptType);
     };
-    function execute (methoad, url, payload, successCallback, errorCallback) {
+    function execute (methoad, url, payload, successCallback, errorCallback, contentType, acceptType) {
+        if(contentType == undefined){
+            contentType = "application/json";
+        }
+        if(acceptType == undefined){
+            acceptType = "application/json";
+        }
         var data = {
             url: END_POINT,
             type: "POST",
-            contentType: "application/json",
+            contentType: contentType,
-            accept: "application/json",
+            accept: acceptType,
             success: successCallback
         };
         console.log(data);
         var paramValue = {};
         paramValue.actionMethod = methoad;
         paramValue.actionUrl = url;
+        paramValue.actionPayload = payload;
+        if(contentType == "application/json"){
             paramValue.actionPayload = JSON.stringify(payload);
+        }
         data.data = JSON.stringify(paramValue);
         $.ajax(data).fail(function (jqXHR) {
             if (jqXHR.status == "401") {