mirror of
https://repository.entgra.net/community/device-mgt-core.git
synced 2025-10-06 02:01:45 +00:00
Improving swagger annotations
This commit is contained in:
parent
17f3a10ec4
commit
9e4b4d2205
@ -207,6 +207,24 @@
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>io.swagger</groupId>
|
<groupId>io.swagger</groupId>
|
||||||
<artifactId>swagger-annotations</artifactId>
|
<artifactId>swagger-annotations</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.swagger</groupId>
|
||||||
|
<artifactId>swagger-core</artifactId>
|
||||||
|
<exclusions>
|
||||||
|
<exclusion>
|
||||||
|
<groupId>org.slf4j</groupId>
|
||||||
|
<artifactId>slf4j-api</artifactId>
|
||||||
|
</exclusion>
|
||||||
|
</exclusions>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.swagger</groupId>
|
||||||
|
<artifactId>swagger-jaxrs</artifactId>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>javax.servlet</groupId>
|
||||||
|
<artifactId>servlet-api</artifactId>
|
||||||
<scope>provided</scope>
|
<scope>provided</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|||||||
@ -0,0 +1,44 @@
|
|||||||
|
/*
|
||||||
|
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
* specific language governing permissions and limitations
|
||||||
|
* under the License.
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
package org.wso2.carbon.device.mgt.jaxrs;
|
||||||
|
|
||||||
|
import javax.servlet.*;
|
||||||
|
import javax.servlet.http.HttpServletResponse;
|
||||||
|
import java.io.IOException;
|
||||||
|
|
||||||
|
public class ApiOriginFilter implements Filter {
|
||||||
|
|
||||||
|
public void doFilter(ServletRequest request, ServletResponse response,
|
||||||
|
FilterChain chain) throws IOException, ServletException {
|
||||||
|
HttpServletResponse res = (HttpServletResponse) response;
|
||||||
|
res.addHeader("Access-Control-Allow-Origin", "*");
|
||||||
|
res.addHeader("Access-Control-Allow-Methods", "GET, POST, DELETE, PUT");
|
||||||
|
res.addHeader("Access-Control-Allow-Headers", "Content-Type");
|
||||||
|
chain.doFilter(request, response);
|
||||||
|
}
|
||||||
|
|
||||||
|
public void destroy() {
|
||||||
|
//do nothing
|
||||||
|
}
|
||||||
|
|
||||||
|
public void init(FilterConfig filterConfig) throws ServletException {
|
||||||
|
//do nothing
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
@ -1,34 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
|
|
||||||
*
|
|
||||||
* 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
|
|
||||||
*
|
|
||||||
* 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
|
|
||||||
* specific language governing permissions and limitations
|
|
||||||
* under the License.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.wso2.carbon.device.mgt.jaxrs.api;
|
|
||||||
|
|
||||||
import io.swagger.annotations.Api;
|
|
||||||
|
|
||||||
import javax.ws.rs.Consumes;
|
|
||||||
import javax.ws.rs.Produces;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Authentication related REST-API interface.
|
|
||||||
*/
|
|
||||||
@Api(value = "Authentication")
|
|
||||||
@Produces({ "application/json", "application/xml" })
|
|
||||||
@Consumes({ "application/json", "application/xml" })
|
|
||||||
public interface Authentication {
|
|
||||||
|
|
||||||
}
|
|
||||||
@ -36,8 +36,9 @@ import javax.ws.rs.core.Response;
|
|||||||
/**
|
/**
|
||||||
* All the certificate related tasks such as saving certificates, can be done through this endpoint.
|
* All the certificate related tasks such as saving certificates, can be done through this endpoint.
|
||||||
*/
|
*/
|
||||||
@Api(value = "Certificate", description = "certificate related tasks such as saving certificates")
|
@Api(value = "Certificate", description = "Certificate related tasks such as saving certificates")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
|
@Path("/certificates")
|
||||||
@Produces({ "application/json", "application/xml" })
|
@Produces({ "application/json", "application/xml" })
|
||||||
@Consumes({ "application/json", "application/xml" })
|
@Consumes({ "application/json", "application/xml" })
|
||||||
public interface Certificate {
|
public interface Certificate {
|
||||||
|
|||||||
@ -35,6 +35,7 @@ import javax.ws.rs.core.Response;
|
|||||||
* All end points support JSON, XMl with content negotiation.
|
* All end points support JSON, XMl with content negotiation.
|
||||||
*/
|
*/
|
||||||
@Api(value = "Configuration", description = "General Tenant Configuration implementation")
|
@Api(value = "Configuration", description = "General Tenant Configuration implementation")
|
||||||
|
@Path("/configuration")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
@Produces({ "application/json", "application/xml" })
|
@Produces({ "application/json", "application/xml" })
|
||||||
@Consumes({ "application/json", "application/xml" })
|
@Consumes({ "application/json", "application/xml" })
|
||||||
|
|||||||
@ -29,7 +29,8 @@ import javax.ws.rs.core.Response;
|
|||||||
/**
|
/**
|
||||||
* Device related operations such as get all the available devices, etc.
|
* Device related operations such as get all the available devices, etc.
|
||||||
*/
|
*/
|
||||||
@Api(value = "Devices")
|
@Api(value = "Devices", description = "")
|
||||||
|
@Path("/devices")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
public interface Device {
|
public interface Device {
|
||||||
|
|
||||||
@ -40,6 +41,7 @@ public interface Device {
|
|||||||
* @return Device List
|
* @return Device List
|
||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
|
@Path("devices")
|
||||||
@ApiOperation(
|
@ApiOperation(
|
||||||
consumes = MediaType.APPLICATION_JSON,
|
consumes = MediaType.APPLICATION_JSON,
|
||||||
produces = MediaType.APPLICATION_JSON,
|
produces = MediaType.APPLICATION_JSON,
|
||||||
@ -94,7 +96,7 @@ public interface Device {
|
|||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("user/{user}")
|
@Path("user/{user}")
|
||||||
Response getDevice(@PathParam("user") String user);
|
Response getDeviceOfUser(@PathParam("user") String user);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Fetch device count of a given user.
|
* Fetch device count of a given user.
|
||||||
@ -104,7 +106,7 @@ public interface Device {
|
|||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("user/{user}/count")
|
@Path("user/{user}/count")
|
||||||
Response getDeviceCount(@PathParam("user") String user);
|
Response getDeviceCountOfUser(@PathParam("user") String user);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get current device count
|
* Get current device count
|
||||||
|
|||||||
@ -37,6 +37,7 @@ import javax.ws.rs.core.Response;
|
|||||||
* Device information related operations.
|
* Device information related operations.
|
||||||
*/
|
*/
|
||||||
@Api(value = "DeviceInfo")
|
@Api(value = "DeviceInfo")
|
||||||
|
@Path("/information")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
public interface DeviceInformation {
|
public interface DeviceInformation {
|
||||||
|
|
||||||
|
|||||||
@ -42,6 +42,7 @@ import javax.ws.rs.core.Response;
|
|||||||
*/
|
*/
|
||||||
@Api(value = "DeviceNotification")
|
@Api(value = "DeviceNotification")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
|
@Path("/notifications")
|
||||||
@Produces({"application/json", "application/xml"})
|
@Produces({"application/json", "application/xml"})
|
||||||
@Consumes({ "application/json", "application/xml" })
|
@Consumes({ "application/json", "application/xml" })
|
||||||
public interface DeviceNotification {
|
public interface DeviceNotification {
|
||||||
|
|||||||
@ -28,6 +28,7 @@ import org.wso2.carbon.device.mgt.common.device.details.DeviceWrapper;
|
|||||||
import org.wso2.carbon.device.mgt.common.search.SearchContext;
|
import org.wso2.carbon.device.mgt.common.search.SearchContext;
|
||||||
|
|
||||||
import javax.ws.rs.GET;
|
import javax.ws.rs.GET;
|
||||||
|
import javax.ws.rs.Path;
|
||||||
import javax.ws.rs.core.MediaType;
|
import javax.ws.rs.core.MediaType;
|
||||||
import javax.ws.rs.core.Response;
|
import javax.ws.rs.core.Response;
|
||||||
|
|
||||||
@ -35,6 +36,7 @@ import javax.ws.rs.core.Response;
|
|||||||
* Device search related operations such as getting device information.
|
* Device search related operations such as getting device information.
|
||||||
*/
|
*/
|
||||||
@Api(value = "DeviceSearch")
|
@Api(value = "DeviceSearch")
|
||||||
|
@Path("/search")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
public interface DeviceSearch {
|
public interface DeviceSearch {
|
||||||
|
|
||||||
@ -50,6 +52,6 @@ public interface DeviceSearch {
|
|||||||
@ApiResponse(code = 200, message = "OK"),
|
@ApiResponse(code = 200, message = "OK"),
|
||||||
@ApiResponse(code = 500, message = "Error occurred while searching the device information")
|
@ApiResponse(code = 500, message = "Error occurred while searching the device information")
|
||||||
})
|
})
|
||||||
Response getDeviceInfo(@ApiParam(name = "enrollmentCertificates", value = "List of search conditions",
|
Response getFilteredDeviceInfo(@ApiParam(name = "enrollmentCertificates", value = "List of search conditions",
|
||||||
required = true) SearchContext searchContext);
|
required = true) SearchContext searchContext);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -33,6 +33,7 @@ import javax.ws.rs.core.Response;
|
|||||||
*/
|
*/
|
||||||
@Api(value = "Feature")
|
@Api(value = "Feature")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
|
@Path("/features")
|
||||||
@Produces({"application/json", "application/xml"})
|
@Produces({"application/json", "application/xml"})
|
||||||
@Consumes({"application/json", "application/xml"})
|
@Consumes({"application/json", "application/xml"})
|
||||||
public interface Feature {
|
public interface Feature {
|
||||||
|
|||||||
@ -28,6 +28,7 @@ import javax.ws.rs.core.Response;
|
|||||||
* This class represents license related operations.
|
* This class represents license related operations.
|
||||||
*/
|
*/
|
||||||
@Api(value = "License")
|
@Api(value = "License")
|
||||||
|
@Path("/license")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
public interface License {
|
public interface License {
|
||||||
|
|
||||||
|
|||||||
@ -37,6 +37,7 @@ import javax.ws.rs.core.Response;
|
|||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@Api(value = "Operation")
|
@Api(value = "Operation")
|
||||||
|
@Path("/operations")
|
||||||
public interface Operation {
|
public interface Operation {
|
||||||
|
|
||||||
/* @deprecated */
|
/* @deprecated */
|
||||||
@ -49,7 +50,7 @@ public interface Operation {
|
|||||||
consumes = MediaType.APPLICATION_JSON + ", " + MediaType.APPLICATION_XML,
|
consumes = MediaType.APPLICATION_JSON + ", " + MediaType.APPLICATION_XML,
|
||||||
produces = MediaType.APPLICATION_JSON + ", " + MediaType.APPLICATION_XML,
|
produces = MediaType.APPLICATION_JSON + ", " + MediaType.APPLICATION_XML,
|
||||||
httpMethod = "GET",
|
httpMethod = "GET",
|
||||||
value = "Getting Pagination Details for Operations on a Device.",
|
value = "Getting Paginated Details for Operations on a Device.",
|
||||||
notes = "You will carry out many operations on a device. In a situation where you wish to view the all" +
|
notes = "You will carry out many operations on a device. In a situation where you wish to view the all" +
|
||||||
" the operations carried out on a device it is not feasible to show all the details on one page" +
|
" the operations carried out on a device it is not feasible to show all the details on one page" +
|
||||||
" therefore the details are paginated." +
|
" therefore the details are paginated." +
|
||||||
@ -89,7 +90,7 @@ public interface Operation {
|
|||||||
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of Operations on a device."),
|
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of Operations on a device."),
|
||||||
@ApiResponse(code = 500, message = "Error occurred while fetching the operations for the " +
|
@ApiResponse(code = 500, message = "Error occurred while fetching the operations for the " +
|
||||||
"device.") })
|
"device.") })
|
||||||
Response getDeviceOperations(@ApiParam(name = "type", value = "Define the device type as the value for {type}. " +
|
Response getAllDeviceOperations(@ApiParam(name = "type", value = "Define the device type as the value for {type}. " +
|
||||||
"Example: ios, android or windows.",
|
"Example: ios, android or windows.",
|
||||||
required = true) @PathParam("type") String type,
|
required = true) @PathParam("type") String type,
|
||||||
@ApiParam(name = "id", value = "Define the device ID",
|
@ApiParam(name = "id", value = "Define the device ID",
|
||||||
|
|||||||
@ -39,6 +39,7 @@ import java.util.List;
|
|||||||
*
|
*
|
||||||
*/
|
*/
|
||||||
@Api(value = "Policy")
|
@Api(value = "Policy")
|
||||||
|
@Path("/policies")
|
||||||
public interface Policy {
|
public interface Policy {
|
||||||
|
|
||||||
@POST
|
@POST
|
||||||
|
|||||||
@ -30,6 +30,7 @@ import javax.ws.rs.core.Response;
|
|||||||
* These end points provide profile related operations.
|
* These end points provide profile related operations.
|
||||||
*/
|
*/
|
||||||
@Api(value = "Profile")
|
@Api(value = "Profile")
|
||||||
|
@Path("/profiles")
|
||||||
@SuppressWarnings("NonJaxWsWebServices")
|
@SuppressWarnings("NonJaxWsWebServices")
|
||||||
public interface Profile {
|
public interface Profile {
|
||||||
|
|
||||||
|
|||||||
@ -19,27 +19,16 @@
|
|||||||
package org.wso2.carbon.device.mgt.jaxrs.api;
|
package org.wso2.carbon.device.mgt.jaxrs.api;
|
||||||
|
|
||||||
import io.swagger.annotations.*;
|
import io.swagger.annotations.*;
|
||||||
import org.wso2.carbon.device.mgt.common.app.mgt.Application;
|
|
||||||
import org.wso2.carbon.device.mgt.jaxrs.api.util.ResponsePayload;
|
|
||||||
import org.wso2.carbon.device.mgt.jaxrs.beans.RoleWrapper;
|
import org.wso2.carbon.device.mgt.jaxrs.beans.RoleWrapper;
|
||||||
import org.wso2.carbon.user.mgt.common.UIPermissionNode;
|
import org.wso2.carbon.user.mgt.common.UIPermissionNode;
|
||||||
|
|
||||||
import javax.ws.rs.DELETE;
|
import javax.ws.rs.*;
|
||||||
import javax.ws.rs.GET;
|
|
||||||
import javax.ws.rs.POST;
|
|
||||||
import javax.ws.rs.PUT;
|
|
||||||
import javax.ws.rs.Path;
|
|
||||||
import javax.ws.rs.PathParam;
|
|
||||||
import javax.ws.rs.Produces;
|
|
||||||
import javax.ws.rs.QueryParam;
|
|
||||||
import javax.ws.rs.core.MediaType;
|
import javax.ws.rs.core.MediaType;
|
||||||
import javax.ws.rs.core.Response;
|
import javax.ws.rs.core.Response;
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
/**
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
@Api(value = "Role")
|
@Api(value = "Role")
|
||||||
|
@Path("/roles")
|
||||||
public interface Role {
|
public interface Role {
|
||||||
|
|
||||||
@GET
|
@GET
|
||||||
@ -54,7 +43,7 @@ public interface Role {
|
|||||||
response = String.class)
|
response = String.class)
|
||||||
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of available roles"),
|
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of available roles"),
|
||||||
@ApiResponse(code = 500, message = "Error occurred while fetching the role list.") })
|
@ApiResponse(code = 500, message = "Error occurred while fetching the role list.") })
|
||||||
Response getRoles();
|
Response getAllRoles();
|
||||||
|
|
||||||
@GET
|
@GET
|
||||||
@Path("{userStore}")
|
@Path("{userStore}")
|
||||||
@ -69,7 +58,7 @@ public interface Role {
|
|||||||
response = String.class)
|
response = String.class)
|
||||||
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of available roles"),
|
@ApiResponses(value = { @ApiResponse(code = 200, message = "List of available roles"),
|
||||||
@ApiResponse(code = 500, message = "Error occurred while fetching the role list.") })
|
@ApiResponse(code = 500, message = "Error occurred while fetching the role list.") })
|
||||||
Response getRoles(@ApiParam(name = "userStore", value = "Provide the name of the UserStore you wish to get the" +
|
Response getRolesOfUserStore(@ApiParam(name = "userStore", value = "Provide the name of the UserStore you wish to get the" +
|
||||||
" details from ",
|
" details from ",
|
||||||
required = true) @PathParam("userStore") String userStore);
|
required = true) @PathParam("userStore") String userStore);
|
||||||
|
|
||||||
@ -208,4 +197,5 @@ public interface Role {
|
|||||||
@ApiResponses(value = { @ApiResponse(code = 200, message = "Retrieved the role count."),
|
@ApiResponses(value = { @ApiResponse(code = 200, message = "Retrieved the role count."),
|
||||||
@ApiResponse(code = 500, message = "Error occurred while retrieving the role count.") })
|
@ApiResponse(code = 500, message = "Error occurred while retrieving the role count.") })
|
||||||
Response getRoleCount();
|
Response getRoleCount();
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -45,6 +45,7 @@ import java.util.List;
|
|||||||
* This represents the JAX-RS services of User related functionality.
|
* This represents the JAX-RS services of User related functionality.
|
||||||
*/
|
*/
|
||||||
@Api(value = "User")
|
@Api(value = "User")
|
||||||
|
@Path("/users")
|
||||||
public interface User {
|
public interface User {
|
||||||
|
|
||||||
@POST
|
@POST
|
||||||
@ -139,7 +140,7 @@ public interface User {
|
|||||||
@ApiResponse(code = 400, message = "User by username: 'username' does not exist for role retrieval"),
|
@ApiResponse(code = 400, message = "User by username: 'username' does not exist for role retrieval"),
|
||||||
@ApiResponse(code = 500, message = "Exception in trying to retrieve roles for user by username: 'username'")
|
@ApiResponse(code = 500, message = "Exception in trying to retrieve roles for user by username: 'username'")
|
||||||
})
|
})
|
||||||
Response getRoles(@ApiParam(name = "username", value = "Provide the user name of the user you wish to get"
|
Response getRolesOfUser(@ApiParam(name = "username", value = "Provide the user name of the user you wish to get"
|
||||||
+ " the role details", required = true) @QueryParam("username") String username);
|
+ " the role details", required = true) @QueryParam("username") String username);
|
||||||
|
|
||||||
@GET
|
@GET
|
||||||
@ -264,7 +265,7 @@ public interface User {
|
|||||||
@PUT
|
@PUT
|
||||||
@Path("{roleName}/users")
|
@Path("{roleName}/users")
|
||||||
@Produces({MediaType.APPLICATION_JSON})
|
@Produces({MediaType.APPLICATION_JSON})
|
||||||
Response updateRoles(@PathParam("username") String username, List<String> userList);
|
Response updateRoles(@PathParam("roleName") String roleName, List<String> userList);
|
||||||
|
|
||||||
@POST
|
@POST
|
||||||
@Path("change-password")
|
@Path("change-password")
|
||||||
|
|||||||
@ -1,36 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2016, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
|
|
||||||
*
|
|
||||||
* 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
|
|
||||||
*
|
|
||||||
* 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
|
|
||||||
* specific language governing permissions and limitations
|
|
||||||
* under the License.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package org.wso2.carbon.device.mgt.jaxrs.api.impl;
|
|
||||||
|
|
||||||
import org.apache.commons.logging.Log;
|
|
||||||
import org.apache.commons.logging.LogFactory;
|
|
||||||
|
|
||||||
import javax.ws.rs.Consumes;
|
|
||||||
import javax.ws.rs.Produces;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Authentication related REST-API implementation.
|
|
||||||
*/
|
|
||||||
@Produces({ "application/json", "application/xml" })
|
|
||||||
@Consumes({ "application/json", "application/xml" })
|
|
||||||
public class AuthenticationImpl {
|
|
||||||
|
|
||||||
private static Log log = LogFactory.getLog(AuthenticationImpl.class);
|
|
||||||
}
|
|
||||||
|
|
||||||
@ -142,7 +142,7 @@ public class DeviceImpl implements Device{
|
|||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("user/{user}")
|
@Path("user/{user}")
|
||||||
public Response getDevice(@PathParam("user") String user) {
|
public Response getDeviceOfUser(@PathParam("user") String user) {
|
||||||
List<org.wso2.carbon.device.mgt.common.Device> devices;
|
List<org.wso2.carbon.device.mgt.common.Device> devices;
|
||||||
try {
|
try {
|
||||||
devices = DeviceMgtAPIUtils.getDeviceManagementService().getDevicesOfUser(user);
|
devices = DeviceMgtAPIUtils.getDeviceManagementService().getDevicesOfUser(user);
|
||||||
@ -165,7 +165,7 @@ public class DeviceImpl implements Device{
|
|||||||
*/
|
*/
|
||||||
@GET
|
@GET
|
||||||
@Path("user/{user}/count")
|
@Path("user/{user}/count")
|
||||||
public Response getDeviceCount(@PathParam("user") String user) {
|
public Response getDeviceCountOfUser(@PathParam("user") String user) {
|
||||||
try {
|
try {
|
||||||
Integer count = DeviceMgtAPIUtils.getDeviceManagementService().getDeviceCount(user);
|
Integer count = DeviceMgtAPIUtils.getDeviceManagementService().getDeviceCount(user);
|
||||||
return Response.status(Response.Status.OK).entity(count).build();
|
return Response.status(Response.Status.OK).entity(count).build();
|
||||||
|
|||||||
@ -38,7 +38,7 @@ public class DeviceSearchImpl implements DeviceSearch {
|
|||||||
private static Log log = LogFactory.getLog(DeviceSearchImpl.class);
|
private static Log log = LogFactory.getLog(DeviceSearchImpl.class);
|
||||||
|
|
||||||
@GET
|
@GET
|
||||||
public Response getDeviceInfo(SearchContext searchContext) {
|
public Response getFilteredDeviceInfo(SearchContext searchContext) {
|
||||||
SearchManagerService searchManagerService;
|
SearchManagerService searchManagerService;
|
||||||
List<DeviceWrapper> devices;
|
List<DeviceWrapper> devices;
|
||||||
try {
|
try {
|
||||||
|
|||||||
@ -103,7 +103,7 @@ public class OperationImpl implements org.wso2.carbon.device.mgt.jaxrs.api.Opera
|
|||||||
@Override
|
@Override
|
||||||
@GET
|
@GET
|
||||||
@Path("{type}/{id}")
|
@Path("{type}/{id}")
|
||||||
public Response getDeviceOperations(@PathParam("type") String type, @PathParam("id") String id) {
|
public Response getAllDeviceOperations(@PathParam("type") String type, @PathParam("id") String id) {
|
||||||
List<? extends org.wso2.carbon.device.mgt.common.operation.mgt.Operation> operations;
|
List<? extends org.wso2.carbon.device.mgt.common.operation.mgt.Operation> operations;
|
||||||
DeviceManagementProviderService dmService;
|
DeviceManagementProviderService dmService;
|
||||||
DeviceIdentifier deviceIdentifier = new DeviceIdentifier();
|
DeviceIdentifier deviceIdentifier = new DeviceIdentifier();
|
||||||
|
|||||||
@ -65,7 +65,7 @@ public class RoleImpl implements org.wso2.carbon.device.mgt.jaxrs.api.Role {
|
|||||||
@Override
|
@Override
|
||||||
@GET
|
@GET
|
||||||
@Produces({MediaType.APPLICATION_JSON})
|
@Produces({MediaType.APPLICATION_JSON})
|
||||||
public Response getRoles() {
|
public Response getAllRoles() {
|
||||||
List<String> filteredRoles;
|
List<String> filteredRoles;
|
||||||
try {
|
try {
|
||||||
filteredRoles = getRolesFromUserStore();
|
filteredRoles = getRolesFromUserStore();
|
||||||
@ -89,7 +89,7 @@ public class RoleImpl implements org.wso2.carbon.device.mgt.jaxrs.api.Role {
|
|||||||
@GET
|
@GET
|
||||||
@Path("{userStore}")
|
@Path("{userStore}")
|
||||||
@Produces({MediaType.APPLICATION_JSON})
|
@Produces({MediaType.APPLICATION_JSON})
|
||||||
public Response getRoles(@PathParam("userStore") String userStore) {
|
public Response getRolesOfUserStore(@PathParam("userStore") String userStore) {
|
||||||
String[] roles;
|
String[] roles;
|
||||||
try {
|
try {
|
||||||
AbstractUserStoreManager abstractUserStoreManager =
|
AbstractUserStoreManager abstractUserStoreManager =
|
||||||
|
|||||||
@ -371,7 +371,7 @@ public class UserImpl implements org.wso2.carbon.device.mgt.jaxrs.api.User {
|
|||||||
@GET
|
@GET
|
||||||
@Path("roles")
|
@Path("roles")
|
||||||
@Produces({MediaType.APPLICATION_JSON})
|
@Produces({MediaType.APPLICATION_JSON})
|
||||||
public Response getRoles(@QueryParam("username") String username) {
|
public Response getRolesOfUser(@QueryParam("username") String username) {
|
||||||
ResponsePayload responsePayload = new ResponsePayload();
|
ResponsePayload responsePayload = new ResponsePayload();
|
||||||
try {
|
try {
|
||||||
UserStoreManager userStoreManager = DeviceMgtAPIUtils.getUserStoreManager();
|
UserStoreManager userStoreManager = DeviceMgtAPIUtils.getUserStoreManager();
|
||||||
@ -716,7 +716,7 @@ public class UserImpl implements org.wso2.carbon.device.mgt.jaxrs.api.User {
|
|||||||
@PUT
|
@PUT
|
||||||
@Path("{roleName}/users")
|
@Path("{roleName}/users")
|
||||||
@Produces({MediaType.APPLICATION_JSON})
|
@Produces({MediaType.APPLICATION_JSON})
|
||||||
public Response updateRoles(@PathParam("username") String username, List<String> userList) {
|
public Response updateRoles(@PathParam("roleName") String username, List<String> userList) {
|
||||||
try {
|
try {
|
||||||
final UserStoreManager userStoreManager = DeviceMgtAPIUtils.getUserStoreManager();
|
final UserStoreManager userStoreManager = DeviceMgtAPIUtils.getUserStoreManager();
|
||||||
if (log.isDebugEnabled()) {
|
if (log.isDebugEnabled()) {
|
||||||
|
|||||||
@ -24,145 +24,46 @@
|
|||||||
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
|
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
|
||||||
http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">
|
http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd">
|
||||||
|
|
||||||
<jaxrs:server id="operationService" address="/operations">
|
<jaxrs:server id="services" address="/">
|
||||||
<jaxrs:serviceBeans>
|
<jaxrs:serviceBeans>
|
||||||
<ref bean="operationServiceBean"/>
|
<ref bean="operationServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="featureService" address="/features">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="featureServiceBean"/>
|
<ref bean="featureServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="deviceService" address="/devices">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="deviceServiceBean"/>
|
<ref bean="deviceServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="deviceGroupService" address="/groups">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="groupServiceBean"/>
|
<ref bean="groupServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="userService" address="/users">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="userServiceBean"/>
|
<ref bean="userServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="roleService" address="/roles">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="roleServiceBean"/>
|
<ref bean="roleServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="policyService" address="/policies">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="policyServiceBean"/>
|
<ref bean="policyServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="profileService" address="/profiles">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="profileServiceBean"/>
|
<ref bean="profileServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="configurationService" address="/configuration">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="configurationServiceBean"/>
|
<ref bean="configurationServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="licenseService" address="/license">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="licenseServiceBean"/>
|
<ref bean="licenseServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="certificateService" address="/certificates">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="certificateServiceBean"/>
|
<ref bean="certificateServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
<jaxrs:server id="notificationService" address="/notifications">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="notificationServiceBean"/>
|
<ref bean="notificationServiceBean"/>
|
||||||
</jaxrs:serviceBeans>
|
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
|
|
||||||
<jaxrs:server id="informationService" address="/information">
|
|
||||||
<jaxrs:serviceBeans>
|
|
||||||
<ref bean="informationServiceBean"/>
|
<ref bean="informationServiceBean"/>
|
||||||
|
<ref bean="searchingServiceBean"/>
|
||||||
|
<ref bean="swaggerResource"/>
|
||||||
</jaxrs:serviceBeans>
|
</jaxrs:serviceBeans>
|
||||||
<jaxrs:providers>
|
<jaxrs:providers>
|
||||||
<ref bean="jsonProvider"/>
|
<ref bean="jsonProvider"/>
|
||||||
<ref bean="errorHandler"/>
|
<ref bean="errorHandler"/>
|
||||||
|
<ref bean="swaggerWriter"/>
|
||||||
</jaxrs:providers>
|
</jaxrs:providers>
|
||||||
</jaxrs:server>
|
</jaxrs:server>
|
||||||
|
|
||||||
<jaxrs:server id="searchService" address="/search">
|
<bean id="swaggerWriter" class="io.swagger.jaxrs.listing.SwaggerSerializers" />
|
||||||
<jaxrs:serviceBeans>
|
<bean id="swaggerResource" class="io.swagger.jaxrs.listing.ApiListingResource" />
|
||||||
<ref bean="searchingServiceBean"/>
|
|
||||||
</jaxrs:serviceBeans>
|
<bean id="swaggerConfig" class="io.swagger.jaxrs.config.BeanConfig">
|
||||||
<jaxrs:providers>
|
<property name="resourcePackage" value="org.wso2.carbon.device.mgt.jaxrs"/>
|
||||||
<ref bean="jsonProvider"/>
|
<property name="version" value="1.0.0"/>
|
||||||
<ref bean="errorHandler"/>
|
<property name="host" value="localhost:9443"/>
|
||||||
</jaxrs:providers>
|
<property name="basePath" value="/"/>
|
||||||
</jaxrs:server>
|
<property name="title" value="Device Management Admin Service API Definitions"/>
|
||||||
<!--
|
<property name="contact" value="dev@wso2.org"/>
|
||||||
<jaxrs:server id="authenticationService" address="/authentication">
|
<property name="license" value="Apache 2.0"/>
|
||||||
<jaxrs:serviceBeans>
|
<property name="licenseUrl" value="http://www.apache.org/licenses/LICENSE-2.0.html"/>
|
||||||
<ref bean="authenticationServiceBean"/>
|
<property name="scan" value="true"/>
|
||||||
</jaxrs:serviceBeans>
|
</bean>
|
||||||
<jaxrs:providers>
|
|
||||||
<ref bean="jsonProvider"/>
|
|
||||||
<ref bean="errorHandler"/>
|
|
||||||
</jaxrs:providers>
|
|
||||||
</jaxrs:server>
|
|
||||||
-->
|
|
||||||
<bean id="operationServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.OperationImpl"/>
|
<bean id="operationServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.OperationImpl"/>
|
||||||
<bean id="deviceServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceImpl"/>
|
<bean id="deviceServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceImpl"/>
|
||||||
<bean id="groupServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.GroupImpl"/>
|
<bean id="groupServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.GroupImpl"/>
|
||||||
@ -175,9 +76,6 @@
|
|||||||
<bean id="certificateServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.CertificateImpl"/>
|
<bean id="certificateServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.CertificateImpl"/>
|
||||||
<bean id="informationServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceInformationImpl"/>
|
<bean id="informationServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceInformationImpl"/>
|
||||||
<bean id="searchingServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceSearchImpl"/>
|
<bean id="searchingServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.DeviceSearchImpl"/>
|
||||||
<!--
|
|
||||||
<bean id="authenticationServiceBean" class="AuthenticationImpl"/>
|
|
||||||
-->
|
|
||||||
<bean id="policyServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.PolicyImpl"/>
|
<bean id="policyServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.PolicyImpl"/>
|
||||||
<bean id="profileServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.ProfileImpl"/>
|
<bean id="profileServiceBean" class="org.wso2.carbon.device.mgt.jaxrs.api.impl.ProfileImpl"/>
|
||||||
<bean id="jsonProvider" class="org.wso2.carbon.device.mgt.jaxrs.common.GsonMessageBodyHandler"/>
|
<bean id="jsonProvider" class="org.wso2.carbon.device.mgt.jaxrs.common.GsonMessageBodyHandler"/>
|
||||||
|
|||||||
@ -25,6 +25,16 @@
|
|||||||
<servlet-class>
|
<servlet-class>
|
||||||
org.apache.cxf.transport.servlet.CXFServlet
|
org.apache.cxf.transport.servlet.CXFServlet
|
||||||
</servlet-class>
|
</servlet-class>
|
||||||
|
<!--<init-param>-->
|
||||||
|
<!--<param-name>swagger.api.basepath</param-name>-->
|
||||||
|
<!--<param-value>http://localhost:9763/test</param-value>-->
|
||||||
|
<!--</init-param>-->
|
||||||
|
|
||||||
|
<!-- configure a security filter -->
|
||||||
|
<init-param>
|
||||||
|
<param-name>swagger.security.filter</param-name>
|
||||||
|
<param-value>ApiAuthorizationFilterImpl</param-value>
|
||||||
|
</init-param>
|
||||||
<load-on-startup>1</load-on-startup>
|
<load-on-startup>1</load-on-startup>
|
||||||
</servlet>
|
</servlet>
|
||||||
<servlet-mapping>
|
<servlet-mapping>
|
||||||
@ -41,7 +51,7 @@
|
|||||||
</context-param>
|
</context-param>
|
||||||
<context-param>
|
<context-param>
|
||||||
<param-name>doAuthentication</param-name>
|
<param-name>doAuthentication</param-name>
|
||||||
<param-value>true</param-value>
|
<param-value>false</param-value>
|
||||||
</context-param>
|
</context-param>
|
||||||
<!--context-param>
|
<!--context-param>
|
||||||
<param-name>managed-api-enabled</param-name>
|
<param-name>managed-api-enabled</param-name>
|
||||||
@ -71,4 +81,13 @@
|
|||||||
</user-data-constraint>
|
</user-data-constraint>
|
||||||
</security-constraint>
|
</security-constraint>
|
||||||
|
|
||||||
|
<filter>
|
||||||
|
<filter-name>ApiOriginFilter</filter-name>
|
||||||
|
<filter-class>org.wso2.carbon.device.mgt.jaxrs.ApiOriginFilter</filter-class>
|
||||||
|
</filter>
|
||||||
|
<filter-mapping>
|
||||||
|
<filter-name>ApiOriginFilter</filter-name>
|
||||||
|
<url-pattern>/*</url-pattern>
|
||||||
|
</filter-mapping>
|
||||||
|
|
||||||
</web-app>
|
</web-app>
|
||||||
|
|||||||
19
pom.xml
19
pom.xml
@ -1456,10 +1456,23 @@
|
|||||||
<artifactId>swagger-annotations</artifactId>
|
<artifactId>swagger-annotations</artifactId>
|
||||||
<version>${swagger.version}</version>
|
<version>${swagger.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.swagger</groupId>
|
||||||
|
<artifactId>swagger-core</artifactId>
|
||||||
|
<version>${swagger.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>io.swagger</groupId>
|
||||||
|
<artifactId>swagger-jaxrs</artifactId>
|
||||||
|
<version>${swagger.version}</version>
|
||||||
|
</dependency>
|
||||||
|
|
||||||
|
<dependency>
|
||||||
|
<groupId>javax.servlet</groupId>
|
||||||
|
<artifactId>servlet-api</artifactId>
|
||||||
|
<version>${servlet-api.version}</version>
|
||||||
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</dependencyManagement>
|
</dependencyManagement>
|
||||||
|
|
||||||
<scm>
|
<scm>
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user