org.wso2.carbon.device.mgt.deviceagent.api

Class DevicesApi

java.lang.Object

org.wso2.carbon.device.mgt.deviceagent.api.DevicesApi

All Implemented Interfaces:

org.wso2.msf4j.Microservice

@Path(value="/api/device-mgt/v1.[\\d]+/devices")
 @Consumes(value="application/json")
 @Produces(value="application/json")
 @ApplicationPath(value="/devices")
public class DevicesApi
extends Object
implements org.wso2.msf4j.Microservice

Constructor Summary

Constructors

Constructor and Description
DevicesApi()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	devicesEnrollTypeDeviceIdDelete(Device device, String deviceId, String type, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesEnrollTypeDeviceIdPut(Device device, String deviceId, String type, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesEnrollTypePost(Device device, String type, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesEventsPublishDataTypeDeviceIdPost(Device device, String type, String deviceId, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesEventsPublishTypeDeviceIdPost(Device device, String deviceId, String type, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesOperationsTypeDeviceIdGet(String type, String deviceId, String status, Integer limit, String offset, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesOperationsTypeDeviceIdOperationIdGet(String type, String deviceId, Integer operationId, org.wso2.msf4j.Request request)
javax.ws.rs.core.Response	devicesOperationsTypeDeviceIdOperationIdPut(Operation operation, String type, String deviceId, String operationId, org.wso2.msf4j.Request request)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DevicesApi

public DevicesApi()

Method Detail

devicesEnrollTypeDeviceIdDelete

@DELETE
 @Path(value="/enroll/{type}/{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesEnrollTypeDeviceIdDelete(Device device,
                                                                                                                                                                                             @PathParam(value="deviceId")
                                                                                                                                                                                             String deviceId,
                                                                                                                                                                                             @PathParam(value="type")
                                                                                                                                                                                             String type,
                                                                                                                                                                                             @Context
                                                                                                                                                                                             org.wso2.msf4j.Request request)
                                                                                                                                                                                      throws NotFoundException

Throws:

NotFoundException

devicesEnrollTypeDeviceIdPut

@PUT
 @Path(value="/enroll/{type}/{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesEnrollTypeDeviceIdPut(Device device,
                                                                                                                                                                                       @PathParam(value="deviceId")
                                                                                                                                                                                       String deviceId,
                                                                                                                                                                                       @PathParam(value="type")
                                                                                                                                                                                       String type,
                                                                                                                                                                                       @Context
                                                                                                                                                                                       org.wso2.msf4j.Request request)
                                                                                                                                                                                throws NotFoundException

Throws:

NotFoundException

devicesEnrollTypePost

@POST
 @Path(value="/enroll/{type}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesEnrollTypePost(Device device,
                                                                                                                                                                      @PathParam(value="type")
                                                                                                                                                                      String type,
                                                                                                                                                                      @Context
                                                                                                                                                                      org.wso2.msf4j.Request request)
                                                                                                                                                               throws NotFoundException

Throws:

NotFoundException

devicesEventsPublishDataTypeDeviceIdPost

@POST
 @Path(value="/events/publish/data/{type}/{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesEventsPublishDataTypeDeviceIdPost(Device device,
                                                                                                                                                                                                                 @PathParam(value="type")
                                                                                                                                                                                                                 String type,
                                                                                                                                                                                                                 @PathParam(value="deviceId")
                                                                                                                                                                                                                 String deviceId,
                                                                                                                                                                                                                 @Context
                                                                                                                                                                                                                 org.wso2.msf4j.Request request)
                                                                                                                                                                                                          throws NotFoundException

Throws:

NotFoundException

devicesEventsPublishTypeDeviceIdPost

@POST
 @Path(value="/events/publish/{type}/{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesEventsPublishTypeDeviceIdPost(Device device,
                                                                                                                                                                                                        @PathParam(value="deviceId")
                                                                                                                                                                                                        String deviceId,
                                                                                                                                                                                                        @PathParam(value="type")
                                                                                                                                                                                                        String type,
                                                                                                                                                                                                        @Context
                                                                                                                                                                                                        org.wso2.msf4j.Request request)
                                                                                                                                                                                                 throws NotFoundException

Throws:

NotFoundException

devicesOperationsTypeDeviceIdGet

@GET
 @Path(value="/operations/{type}/{deviceId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesOperationsTypeDeviceIdGet(@PathParam(value="type")
                                                                                                                                                                                               String type,
                                                                                                                                                                                               @PathParam(value="deviceId")
                                                                                                                                                                                               String deviceId,
                                                                                                                                                                                               @QueryParam(value="status")
                                                                                                                                                                                               String status,
                                                                                                                                                                                               @DefaultValue(value="5") @QueryParam(value="limit")
                                                                                                                                                                                               Integer limit,
                                                                                                                                                                                               @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                                                                                               String offset,
                                                                                                                                                                                               @Context
                                                                                                                                                                                               org.wso2.msf4j.Request request)
                                                                                                                                                                                        throws NotFoundException

Throws:

NotFoundException

devicesOperationsTypeDeviceIdOperationIdGet

@GET
 @Path(value="/operations/{type}/{deviceId}/{operationId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesOperationsTypeDeviceIdOperationIdGet(@PathParam(value="type")
                                                                                                                                                                                                                        String type,
                                                                                                                                                                                                                        @PathParam(value="deviceId")
                                                                                                                                                                                                                        String deviceId,
                                                                                                                                                                                                                        @PathParam(value="operationId")
                                                                                                                                                                                                                        Integer operationId,
                                                                                                                                                                                                                        @Context
                                                                                                                                                                                                                        org.wso2.msf4j.Request request)
                                                                                                                                                                                                                 throws NotFoundException

Throws:

NotFoundException

devicesOperationsTypeDeviceIdOperationIdPut

@PUT
 @Path(value="/operations/{type}/{deviceId}/{operationId}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response devicesOperationsTypeDeviceIdOperationIdPut(Operation operation,
                                                                                                                                                                                                                        @PathParam(value="type")
                                                                                                                                                                                                                        String type,
                                                                                                                                                                                                                        @PathParam(value="deviceId")
                                                                                                                                                                                                                        String deviceId,
                                                                                                                                                                                                                        @PathParam(value="operationId")
                                                                                                                                                                                                                        String operationId,
                                                                                                                                                                                                                        @Context
                                                                                                                                                                                                                        org.wso2.msf4j.Request request)
                                                                                                                                                                                                                 throws NotFoundException

Throws:

NotFoundException