From 36c3a057dc2cb1232193aa8df8926f068026abfa Mon Sep 17 00:00:00 2001 From: Madhawa Date: Thu, 12 May 2016 11:25:20 +0530 Subject: [PATCH] created interfaces for the api classes in order add swagger definitions --- .../device/mgt/jaxrs/api/Authentication.java | 2 +- .../device/mgt/jaxrs/api/Configuration.java | 2 +- .../carbon/device/mgt/jaxrs/api/Device.java | 14 ++--- .../mgt/jaxrs/api/DeviceNotification.java | 2 +- .../carbon/device/mgt/jaxrs/api/Feature.java | 4 +- .../carbon/device/mgt/jaxrs/api/License.java | 6 +-- .../carbon/device/mgt/jaxrs/api/User.java | 2 +- .../src/main/webapp/META-INF/permissions.xml | 52 +++++++++---------- .../webapp/META-INF/webapp-classloading.xml | 14 ++--- 9 files changed, 49 insertions(+), 49 deletions(-) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java index 23e03ccfdaf..e28de808a09 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Authentication.java @@ -24,7 +24,7 @@ import javax.ws.rs.Consumes; import javax.ws.rs.Produces; /** - * AuthenticationImpl related REST-API interface. + * Authentication related REST-API interface. */ @Api(value = "Authentication") @Produces({ "application/json", "application/xml" }) diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java index 115d86797c3..a1602eada3d 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Configuration.java @@ -25,7 +25,7 @@ import javax.ws.rs.*; import javax.ws.rs.core.Response; /** - * General Tenant ConfigurationImpl REST-API implementation. + * General Tenant Configuration REST-API implementation. * All end points support JSON, XMl with content negotiation. */ @Api(value = "Configuration", description = "General Tenant Configuration implementation") diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java index 949f40e4b7c..e3d3d9e7459 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Device.java @@ -36,7 +36,7 @@ public interface Device { * Get all devices. We have to use accept all the necessary query parameters sent by datatable. * Hence had to put lot of query params here. * - * @return DeviceImpl List + * @return Device List */ @GET @ApiOperation( @@ -63,7 +63,7 @@ public interface Device { /** * Fetch device details for a given device type and device Id. * - * @return DeviceImpl wrapped inside Response + * @return Device wrapped inside Response */ @GET @ApiOperation( @@ -81,8 +81,8 @@ public interface Device { /** * Fetch device details of a given user. * - * @param user UserImpl Name - * @return DeviceImpl + * @param user User Name + * @return Device */ @GET @Path("user/{user}") @@ -91,8 +91,8 @@ public interface Device { /** * Fetch device count of a given user. * - * @param user UserImpl Name - * @return DeviceImpl + * @param user User Name + * @return Device */ @GET @Path("user/{user}/count") @@ -117,7 +117,7 @@ public interface Device { /** * Get the list of devices that matches with the given name. * - * @param deviceName DeviceImpl name + * @param deviceName Device name * @param tenantDomain Callee tenant domain * @return list of devices. */ diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java index a9dbc345875..62c2bcdaa38 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/DeviceNotification.java @@ -31,7 +31,7 @@ import javax.ws.rs.Produces; import javax.ws.rs.core.Response; /** - * DeviceNotificationImpl management REST-API implementation. + * DeviceNotification management REST-API implementation. * All end points support JSON, XMl with content negotiation. */ @Api(value = "DeviceNotification") diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java index 37765cb3772..cafd085015a 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/Feature.java @@ -37,9 +37,9 @@ import javax.ws.rs.core.Response; public interface Feature { /** - * Get all features for Mobile DeviceImpl Type + * Get all features for Mobile Device Type * - * @return FeatureImpl + * @return Feature */ @GET @Path("/{type}") diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java index c5320703b5c..fe07dce2e32 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/License.java @@ -34,7 +34,7 @@ public interface License { /** * This method returns the license text related to a given device type and language code. * - * @param deviceType DeviceImpl type, ex: android, ios + * @param deviceType Device type, ex: android, ios * @param languageCode Language code, ex: en_US * @return Returns the license text */ @@ -47,8 +47,8 @@ public interface License { /** * This method is used to add license to a specific device type. * - * @param deviceType DeviceImpl type, ex: android, ios - * @param license LicenseImpl object + * @param deviceType Device type, ex: android, ios + * @param license License object * @return Returns the acknowledgement for the action */ @POST diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java index c65eeb29d58..e55a2bcb329 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/java/org/wso2/carbon/device/mgt/jaxrs/api/User.java @@ -36,7 +36,7 @@ import javax.ws.rs.core.Response; import java.util.List; /** - * This represents the JAX-RS services of UserImpl related functionality. + * This represents the JAX-RS services of User related functionality. */ @Api(value = "User") public interface User { diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml index 54e0e96a4ae..89aa3f02f24 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/permissions.xml @@ -2,19 +2,19 @@ - + Device Management @@ -262,7 +262,7 @@ /devices/user/* GET - + @@ -373,7 +373,7 @@ - + @@ -381,7 +381,7 @@ - + List policies /device-mgt/admin/policies/list @@ -410,9 +410,9 @@ GET - + - + List roles /device-mgt/admin/roles/list @@ -504,9 +504,9 @@ /roles/count GET - + - + List users /device-mgt/admin/users/list @@ -660,9 +660,9 @@ /users/authorize POST - + - + Add Policy /device-mgt/admin/policies/add @@ -816,9 +816,9 @@ /policies/*/* GET - + - + Add policy /device-mgt/admin/policies/add @@ -839,7 +839,7 @@ /profiles/* DELETE - + @@ -860,7 +860,7 @@ - + @@ -875,9 +875,9 @@ - + - + View configuration /device-mgt/admin/platform-configs/view @@ -899,9 +899,9 @@ PUT - + - + Save certificate in the database /device-mgt/android/certificate/save @@ -920,7 +920,7 @@ /certificates/* DELETE - + diff --git a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml index 99ff01249f3..ed2ed216247 100644 --- a/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml +++ b/components/device-mgt/org.wso2.carbon.device.mgt.api/src/main/webapp/META-INF/webapp-classloading.xml @@ -3,19 +3,19 @@