@ -1,4 +1,4 @@
package $ { groupId } . $ { rootArtifactId } . manager . api ;
/ *
* Copyright ( c ) 2016 , WSO2 Inc . ( http : //www.wso2.org) All Rights Reserved.
*
@ -16,17 +16,25 @@ package ${groupId}.${rootArtifactId}.manager.api;
* specific language governing permissions and limitations
* under the License .
* /
package $ { groupId } . $ { rootArtifactId } . manager . api ;
import java.util.ArrayList ;
import java.util.Date ;
import java.util.List ;
import org.apache.commons.httpclient.HttpStatus ;
import org.apache.commons.io.FileUtils ;
import org.apache.commons.logging.Log ;
import org.apache.commons.logging.LogFactory ;
import $ { groupId } . $ { rootArtifactId } . plugin . constants . DeviceTypeConstants ;
import $ { groupId } . $ { rootArtifactId } . manager . api . util . APIUtil ;
import $ { groupId } . $ { rootArtifactId } . manager . api . util . ResponsePayload ;
import org.wso2.carbon.apimgt.annotations.device.DeviceType ;
import org.wso2.carbon.apimgt.webapp.publisher.KeyGenerationUtil ;
import org.wso2.carbon.device.mgt.common.Device ;
import org.wso2.carbon.device.mgt.common.DeviceIdentifier ;
import org.wso2.carbon.device.mgt.common.DeviceManagementException ;
import org.wso2.carbon.device.mgt.common.EnrolmentInfo ;
import org.wso2.carbon.device.mgt.iot.DeviceManagement ;
import org.wso2.carbon.device.mgt.iot.apimgt.AccessTokenInfo ;
import org.wso2.carbon.device.mgt.iot.apimgt.TokenClient ;
import org.wso2.carbon.device.mgt.iot.exception.AccessTokenException ;
@ -35,45 +43,49 @@ import org.wso2.carbon.device.mgt.iot.util.ZipArchive;
import org.wso2.carbon.device.mgt.iot.util.ZipUtil ;
import javax.servlet.http.HttpServletResponse ;
import javax.ws.rs.* ;
import javax.ws.rs.Consumes ;
import javax.ws.rs.DELETE ;
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.Context ;
import javax.ws.rs.core.MediaType ;
import javax.ws.rs.core.Response ;
import java.io.IOException ;
import java.nio.ByteBuffer ;
import java.nio.charset.StandardCharsets ;
import java.util.Date ;
import java.util.UUID ;
@SuppressWarnings ( "NonJaxWsWebServices" )
@DeviceType ( value = "${deviceType}" )
public class ManagerService {
private static Log log = LogFactory . getLog ( ManagerService . class ) ;
//TODO; replace this tenant domain
private final String SUPER_TENANT = "carbon.super" ;
@Context //injected response proxy supporting multiple thread
private HttpServletResponse response ;
/ * *
* Register new devcie into IoTS
* Register new device into IoT Server
*
* @param deviceId unique identifier for device
* @param name name of new device
* @param owner owner of the device
* @return
* @param name name of new device
* @return registration status
* /
@Path ( "manager/device/register" )
@PUT
public boolean register ( @QueryParam ( "deviceId" ) String deviceId ,
@QueryParam ( "name" ) String name , @QueryParam ( "owner" ) String owner ) {
DeviceManagement deviceManagement = new DeviceManagement ( SUPER_TENANT ) ;
@QueryParam ( "name" ) String name ) {
DeviceIdentifier deviceIdentifier = new DeviceIdentifier ( ) ;
deviceIdentifier . setId ( deviceId ) ;
deviceIdentifier . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
try {
if ( deviceManagement . getDeviceManagementService ( ) . isEnrolled ( deviceIdentifier ) ) {
if ( APIUtil . getDeviceManagementService ( ) . isEnrolled ( deviceIdentifier ) ) {
response . setStatus ( Response . Status . CONFLICT . getStatusCode ( ) ) ;
return false ;
}
String owner = APIUtil . getAuthenticatedUser ( ) ;
Device device = new Device ( ) ;
device . setDeviceIdentifier ( deviceId ) ;
EnrolmentInfo enrolmentInfo = new EnrolmentInfo ( ) ;
@ -84,7 +96,25 @@ public class ManagerService {
device . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
enrolmentInfo . setOwner ( owner ) ;
device . setEnrolmentInfo ( enrolmentInfo ) ;
boolean added = deviceManagement . getDeviceManagementService ( ) . enrollDevice ( device ) ;
KeyGenerationUtil . createApplicationKeys ( DeviceTypeConstants . DEVICE_TYPE ) ;
TokenClient accessTokenClient = new TokenClient ( DeviceTypeConstants . DEVICE_TYPE ) ;
AccessTokenInfo accessTokenInfo = accessTokenClient . getAccessToken ( owner , deviceId ) ;
//create token
String accessToken = accessTokenInfo . getAccess_token ( ) ;
String refreshToken = accessTokenInfo . getRefresh_token ( ) ;
List < Device . Property > properties = new ArrayList < > ( ) ;
Device . Property accessTokenProperty = new Device . Property ( ) ;
accessTokenProperty . setName ( "accessToken" ) ;
accessTokenProperty . setValue ( accessToken ) ;
Device . Property refreshTokenProperty = new Device . Property ( ) ;
refreshTokenProperty . setName ( "refreshToken" ) ;
refreshTokenProperty . setValue ( refreshToken ) ;
properties . add ( accessTokenProperty ) ;
properties . add ( refreshTokenProperty ) ;
device . setProperties ( properties ) ;
boolean added = APIUtil . getDeviceManagementService ( ) . enrollDevice ( device ) ;
if ( added ) {
response . setStatus ( Response . Status . OK . getStatusCode ( ) ) ;
} else {
@ -93,27 +123,30 @@ public class ManagerService {
return added ;
} catch ( DeviceManagementException e ) {
response . setStatus ( Response . Status . INTERNAL_SERVER_ERROR . getStatusCode ( ) ) ;
log . error ( e . getErrorMessage ( ) , e ) ;
return false ;
} catch ( AccessTokenException e ) {
response . setStatus ( Response . Status . INTERNAL_SERVER_ERROR . getStatusCode ( ) ) ;
log . error ( "Unable to obtain access token" , e ) ;
return false ;
} finally {
deviceManagement . endTenantFlow ( ) ;
}
}
/ * *
* Remove installed device
*
* @param deviceId unique identifier for device
* @param response
* @param response to request
* /
@Path ( "manager/device/remove/{device_id}" )
@DELETE
public void removeDevice ( @PathParam ( "device_id" ) String deviceId ,
@Context HttpServletResponse response ) {
DeviceManagement deviceManagement = new DeviceManagement ( SUPER_TENANT ) ;
DeviceIdentifier deviceIdentifier = new DeviceIdentifier ( ) ;
deviceIdentifier . setId ( deviceId ) ;
deviceIdentifier . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
try {
boolean removed = deviceManagement . getDeviceManagementService ( ) . disenrollDevice (
boolean removed = APIUtil . getDeviceManagementService ( ) . disenrollDevice (
deviceIdentifier ) ;
if ( removed ) {
response . setStatus ( Response . Status . OK . getStatusCode ( ) ) ;
@ -122,33 +155,32 @@ public class ManagerService {
}
} catch ( DeviceManagementException e ) {
response . setStatus ( Response . Status . INTERNAL_SERVER_ERROR . getStatusCode ( ) ) ;
} finally {
deviceManagement . endTenantFlow ( ) ;
}
}
/ * *
* Update device name
*
* @param deviceId unique identifier for device
* @param name new name of the device
* @param response
* @return
* @param name new name of the device
* @param response to request
* @return update status
* /
@Path ( "manager/device/update/{device_id}" )
@POST
public boolean updateDevice ( @PathParam ( "device_id" ) String deviceId , @QueryParam ( "name" ) String name ,
public boolean updateDevice ( @PathParam ( "device_id" ) String deviceId ,
@QueryParam ( "name" ) String name ,
@Context HttpServletResponse response ) {
DeviceManagement deviceManagement = new DeviceManagement ( SUPER_TENANT ) ;
DeviceIdentifier deviceIdentifier = new DeviceIdentifier ( ) ;
deviceIdentifier . setId ( deviceId ) ;
deviceIdentifier . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
try {
Device device = deviceManagement . getDeviceManagementService ( ) . getDevice ( deviceIdentifier ) ;
Device device = APIUtil . getDeviceManagementService ( ) . getDevice ( deviceIdentifier ) ;
device . setDeviceIdentifier ( deviceId ) ;
device . getEnrolmentInfo ( ) . setDateOfLastUpdate ( new Date ( ) . getTime ( ) ) ;
device . setName ( name ) ;
device . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
boolean updated = deviceManagement . getDeviceManagementService ( ) . modifyEnrollment ( device ) ;
boolean updated = APIUtil . getDeviceManagementService ( ) . modifyEnrollment ( device ) ;
if ( updated ) {
response . setStatus ( Response . Status . OK . getStatusCode ( ) ) ;
} else {
@ -158,49 +190,45 @@ public class ManagerService {
} catch ( DeviceManagementException e ) {
log . error ( e . getErrorMessage ( ) ) ;
return false ;
} finally {
deviceManagement . endTenantFlow ( ) ;
}
}
/ * *
* Get device information
*
* @param deviceId unique identifier for device
* @return
* @return device
* /
@Path ( "manager/device/{device_id}" )
@GET
@Consumes ( MediaType . APPLICATION_JSON )
@Produces ( MediaType . APPLICATION_JSON )
public Device getDevice ( @PathParam ( "device_id" ) String deviceId ) {
DeviceManagement deviceManagement = new DeviceManagement ( SUPER_TENANT ) ;
DeviceIdentifier deviceIdentifier = new DeviceIdentifier ( ) ;
deviceIdentifier . setId ( deviceId ) ;
deviceIdentifier . setType ( DeviceTypeConstants . DEVICE_TYPE ) ;
try {
return deviceManagement . getDeviceManagementService ( ) . getDevice ( deviceIdentifier ) ;
return APIUtil . getDeviceManagementService ( ) . getDevice ( deviceIdentifier ) ;
} catch ( DeviceManagementException ex ) {
log . error ( "Error occurred while retrieving device with Id " + deviceId + "\n" + ex ) ;
return null ;
} finally {
deviceManagement . endTenantFlow ( ) ;
}
}
/ * *
* This will download the agent for given device type
* @param owner owner of the device
*
* @param deviceName name of the device which is to be created
* @param sketchType name of sketch type
* @return
* @return agent archive
* /
@Path ( "manager/device/{sketch_type}/download" )
@GET
@Produces ( MediaType . APPLICATION_JSON )
public Response downloadSketch ( @QueryParam ( " owner") String owner , @QueryParam ( " deviceName") String deviceName ,
public Response downloadSketch ( @QueryParam ( " deviceName") String deviceName ,
@PathParam ( "sketch_type" ) String sketchType ) {
try {
ZipArchive zipFile = createDownloadFile ( owner , deviceName , sketchType ) ;
ZipArchive zipFile = createDownloadFile ( APIUtil. getAuthenticatedUser ( ) , deviceName , sketchType ) ;
Response . ResponseBuilder response = Response . ok ( FileUtils . readFileToByteArray ( zipFile . getZipFile ( ) ) ) ;
response . type ( "application/zip" ) ;
response . header ( "Content-Disposition" , "attachment; filename=\"" + zipFile . getFileName ( ) + "\"" ) ;
@ -218,12 +246,47 @@ public class ManagerService {
}
}
/ * *
* This will give link to generated agent
*
* @param deviceName name of the device which is to be created
* @param sketchType name of sketch type
* @return link to generated agent
* /
@Path ( "manager/device/{sketch_type}/generate_link" )
@GET
public Response generateSketchLink ( @QueryParam ( "deviceName" ) String deviceName ,
@PathParam ( "sketch_type" ) String sketchType ) {
try {
ZipArchive zipFile = createDownloadFile ( APIUtil . getAuthenticatedUser ( ) , deviceName , sketchType ) ;
ResponsePayload responsePayload = new ResponsePayload ( ) ;
responsePayload . setStatusCode ( HttpStatus . SC_OK ) ;
responsePayload . setMessageFromServer ( "Sending Requested sketch by type: " + sketchType +
" and id: " + zipFile . getDeviceId ( ) + "." ) ;
responsePayload . setResponseContent ( zipFile . getDeviceId ( ) ) ;
return Response . status ( HttpStatus . SC_OK ) . entity ( responsePayload ) . build ( ) ;
} catch ( IllegalArgumentException ex ) {
return Response . status ( HttpStatus . SC_BAD_REQUEST ) . entity ( ex . getMessage ( ) ) . build ( ) ;
} catch ( DeviceManagementException ex ) {
log . error ( "Error occurred while creating device with name " + deviceName + "\n" , ex ) ;
return Response . status ( HttpStatus . SC_INTERNAL_SERVER_ERROR ) . entity ( ex . getMessage ( ) ) . build ( ) ;
} catch ( AccessTokenException ex ) {
log . error ( ex . getMessage ( ) , ex ) ;
return Response . status ( HttpStatus . SC_INTERNAL_SERVER_ERROR ) . entity ( ex . getMessage ( ) ) . build ( ) ;
} catch ( DeviceControllerException ex ) {
log . error ( ex . getMessage ( ) , ex ) ;
return Response . status ( HttpStatus . SC_INTERNAL_SERVER_ERROR ) . entity ( ex . getMessage ( ) ) . build ( ) ;
}
}
/ * *
* Make zip file which include all the agent source codes and configuration file
* @param owner owner of the device
*
* @param owner owner of the device
* @param deviceName name of device
* @param sketchType name of sketch type
* @return
* @return zip archive file
* @throws DeviceManagementException
* @throws AccessTokenException
* @throws DeviceControllerException
@ -234,7 +297,7 @@ public class ManagerService {
throw new IllegalArgumentException ( "Error on createDownloadFile() Owner is null!" ) ;
}
//create new device id
String deviceId = ( ) ;
String deviceId = APIUtil. shortUUID( ) ;
KeyGenerationUtil . createApplicationKeys ( DeviceTypeConstants . DEVICE_TYPE ) ;
TokenClient accessTokenClient = new TokenClient ( DeviceTypeConstants . DEVICE_TYPE ) ;
AccessTokenInfo accessTokenInfo = accessTokenClient . getAccessToken ( owner , deviceId ) ;
@ -244,26 +307,15 @@ public class ManagerService {
//adding registering data
boolean status ;
//Register the device with CDMF
status = register ( deviceId , deviceName , owner );
status = register ( deviceId , deviceName ;
if ( ! status ) {
String msg = "Error occurred while registering the device with " + "id: " + deviceId + " owner:" + owner ;
throw new DeviceManagementException ( msg ) ;
}
ZipUtil ziputil = new ZipUtil ( ) ;
ZipArchive zipFile = ziputil . createZipFile ( owner , SUPER_TENANT , sketchType , deviceId , deviceName , accessToken ,
) ;
ZipArchive zipFile = ziputil . createZipFile ( owner , APIUtil. getTenantDomainOfUser ( ) , sketchType , deviceId ,
deviceName, accessToken , refreshToken) ;
zipFile . setDeviceId ( deviceId ) ;
return zipFile ;
}
/ * *
* Generate UUID
* @return
* /
private static String shortUUID ( ) {
UUID uuid = UUID . randomUUID ( ) ;
long l = ByteBuffer . wrap ( uuid . toString ( ) . getBytes ( StandardCharsets . UTF_8 ) ) . getLong ( ) ;
return Long . toString ( l , Character . MAX_RADIX ) ;
}
}
GPrathap
9 years ago