|
|
@ -54,6 +54,18 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
List<Device> getAllDevices(String deviceType) throws DeviceManagementException;
|
|
|
|
List<Device> getAllDevices(String deviceType) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices of a given device type.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceType Device-type of the required devices
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices of given device-type.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getAllDevices(String deviceType, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to retrieve all the devices registered in the system.
|
|
|
|
* Method to retrieve all the devices registered in the system.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -63,6 +75,38 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
List<Device> getAllDevices() throws DeviceManagementException;
|
|
|
|
List<Device> getAllDevices() throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices registered in the system.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of registered devices.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getAllDevices(boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices registered in the system.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param since - Date value where the resource was last modified
|
|
|
|
|
|
|
|
* @return List of registered devices.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getDevices(Date since) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices registered in the system.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of registered devices.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getDevices(Date since, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -73,6 +117,18 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getDevicesByType(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PaginationResult getDevicesByType(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return PaginationResult - Result including the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getDevicesByType(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -83,21 +139,91 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getAllDevices(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PaginationResult getAllDevices(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
void sendEnrolmentInvitation(String templateName, EmailMetaInfo metaInfo) throws DeviceManagementException;
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to retrieve all the devices with pagination support.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return PaginationResult - Result including the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* devices.
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getAllDevices(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
void sendRegistrationEmail(EmailMetaInfo metaInfo) throws DeviceManagementException;
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
FeatureManager getFeatureManager(String deviceType) throws DeviceManagementException;
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDeviceWithTypeProperties(DeviceIdentifier deviceId) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Proxy method to get the tenant configuration of a given platform.
|
|
|
|
* Returns the device of specified id.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @param deviceType Device platform
|
|
|
|
* @param deviceId device Id
|
|
|
|
* @return Tenant configuration settings of the particular tenant and platform.
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
* along with the device data.
|
|
|
|
* configuration.
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PlatformConfiguration getConfiguration(String deviceType) throws DeviceManagementException;
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @param since - Date value where the resource was last modified
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, Date since) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @param since - Date value where the resource was last modified
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, Date since, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id with the given status.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @param status - Status of the device
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, EnrolmentInfo.Status status) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id with the given status.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @param status - Status of the device
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return Device returns null when device is not available.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, EnrolmentInfo.Status status, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the list of devices owned by an user with paging information.
|
|
|
|
* Method to get the list of devices owned by an user with paging information.
|
|
|
@ -109,6 +235,18 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getDevicesOfUser(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PaginationResult getDevicesOfUser(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to get the list of devices owned by an user with paging information.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices owned by a particular user along with the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getDevicesOfUser(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the list of devices filtered by the ownership with paging information.
|
|
|
|
* Method to get the list of devices filtered by the ownership with paging information.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -119,6 +257,18 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getDevicesByOwnership(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PaginationResult getDevicesByOwnership(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to get the list of devices filtered by the ownership with paging information.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices owned by a particular user along with the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getDevicesByOwnership(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the list of devices owned by an user.
|
|
|
|
* Method to get the list of devices owned by an user.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -129,16 +279,42 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
List<Device> getDevicesOfUser(String userName) throws DeviceManagementException;
|
|
|
|
List<Device> getDevicesOfUser(String userName) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to get the list of devices owned by an user.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param userName Username of the user
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices owned by a particular user
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getDevicesOfUser(String userName, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* This method returns the list of device owned by a user of given device type.
|
|
|
|
* This method returns the list of device owned by a user of given device type.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @param userName user name.
|
|
|
|
* @param userName user name.
|
|
|
|
* @param deviceType device type name
|
|
|
|
* @param deviceType device type name
|
|
|
|
* @return
|
|
|
|
* @return List of device owned by the given user and type.
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
List<Device> getDevicesOfUser(String userName, String deviceType) throws DeviceManagementException;
|
|
|
|
List<Device> getDevicesOfUser(String userName, String deviceType) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* This method returns the list of device owned by a user of given device type.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param userName user name.
|
|
|
|
|
|
|
|
* @param deviceType device type name
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of device owned by the given user and type.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getDevicesOfUser(String userName, String deviceType, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the list of devices owned by users of a particular user-role.
|
|
|
|
* Method to get the list of devices owned by users of a particular user-role.
|
|
|
|
*
|
|
|
|
*
|
|
|
@ -150,32 +326,50 @@ public interface DeviceManagementProviderService {
|
|
|
|
List<Device> getAllDevicesOfRole(String roleName) throws DeviceManagementException;
|
|
|
|
List<Device> getAllDevicesOfRole(String roleName) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the device count of user.
|
|
|
|
* Method to get the list of devices owned by users of a particular user-role.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @return device count
|
|
|
|
* @param roleName Role name of the users
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while counting
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
* the devices
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices owned by users of a particular role
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
int getDeviceCount(String username) throws DeviceManagementException;
|
|
|
|
List<Device> getAllDevicesOfRole(String roleName, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the count of all types of devices.
|
|
|
|
* This method is used to retrieve list of devices based on the device status with paging information.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @return device count
|
|
|
|
* @param request PaginationRequest object holding the data for pagination and filter info
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while counting
|
|
|
|
* @return List of devices in given status along with the required parameters necessary to do pagination.
|
|
|
|
* the devices
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
int getDeviceCount() throws DeviceManagementException;
|
|
|
|
PaginationResult getDevicesByStatus(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* This method is used to retrieve list of devices based on the device status with paging information.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination and filter info
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices in given status along with the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getDevicesByStatus(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* Method to get the list of devices that matches with the given device name.
|
|
|
|
* Method to get the list of devices that matches with the given device name.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @param deviceName name of the device
|
|
|
|
* @param request PaginationRequest object holding the data for pagination and filter info
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
* @return List of devices that matches with the given device name.
|
|
|
|
* @return List of devices that matches with the given device name.
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
* device list
|
|
|
|
* device list
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
List<Device> getDevicesByNameAndType(String deviceName, String type, int offset, int limit) throws DeviceManagementException;
|
|
|
|
List<Device> getDevicesByNameAndType(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* This method is used to retrieve list of devices that matches with the given device name with paging information.
|
|
|
|
* This method is used to retrieve list of devices that matches with the given device name with paging information.
|
|
|
@ -187,7 +381,17 @@ public interface DeviceManagementProviderService {
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getDevicesByName(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PaginationResult getDevicesByName(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
void updateDeviceEnrolmentInfo(Device device, EnrolmentInfo.Status active) throws DeviceManagementException;
|
|
|
|
/**
|
|
|
|
|
|
|
|
* This method is used to retrieve list of devices that matches with the given device name with paging information.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices in given status along with the required parameters necessary to do pagination.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
|
|
|
|
* device list
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
PaginationResult getDevicesByName(PaginationRequest request, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* This method is used to retrieve list of devices based on the device status.
|
|
|
|
* This method is used to retrieve list of devices based on the device status.
|
|
|
@ -199,14 +403,53 @@ public interface DeviceManagementProviderService {
|
|
|
|
List<Device> getDevicesByStatus(EnrolmentInfo.Status status) throws DeviceManagementException;
|
|
|
|
List<Device> getDevicesByStatus(EnrolmentInfo.Status status) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* This method is used to retrieve list of devices based on the device status with paging information.
|
|
|
|
* This method is used to retrieve list of devices based on the device status.
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* @param request PaginationRequest object holding the data for pagination
|
|
|
|
* @param status Device status
|
|
|
|
* @return List of devices in given status along with the required parameters necessary to do pagination.
|
|
|
|
* @param requireDeviceInfo - A boolean indicating whether the device-info (location, app-info etc) is also required
|
|
|
|
|
|
|
|
* along with the device data.
|
|
|
|
|
|
|
|
* @return List of devices
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
List<Device> getDevicesByStatus(EnrolmentInfo.Status status, boolean requireDeviceInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to get the device count of user.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @return device count
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while counting
|
|
|
|
|
|
|
|
* the devices
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
int getDeviceCount(String username) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Method to get the count of all types of devices.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @return device count
|
|
|
|
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while counting
|
|
|
|
|
|
|
|
* the devices
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
int getDeviceCount() throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
HashMap<Integer, Device> getTenantedDevice(DeviceIdentifier deviceIdentifier) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void sendEnrolmentInvitation(String templateName, EmailMetaInfo metaInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void sendRegistrationEmail(EmailMetaInfo metaInfo) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FeatureManager getFeatureManager(String deviceType) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Proxy method to get the tenant configuration of a given platform.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceType Device platform
|
|
|
|
|
|
|
|
* @return Tenant configuration settings of the particular tenant and platform.
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
* @throws DeviceManagementException If some unusual behaviour is observed while fetching the
|
|
|
|
* device list
|
|
|
|
* configuration.
|
|
|
|
*/
|
|
|
|
*/
|
|
|
|
PaginationResult getDevicesByStatus(PaginationRequest request) throws DeviceManagementException;
|
|
|
|
PlatformConfiguration getConfiguration(String deviceType) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void updateDeviceEnrolmentInfo(Device device, EnrolmentInfo.Status active) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
/**
|
|
|
|
* This method is used to check whether the device is enrolled with the give user.
|
|
|
|
* This method is used to check whether the device is enrolled with the give user.
|
|
|
@ -247,21 +490,6 @@ public interface DeviceManagementProviderService {
|
|
|
|
|
|
|
|
|
|
|
|
boolean setActive(DeviceIdentifier deviceId, boolean status) throws DeviceManagementException;
|
|
|
|
boolean setActive(DeviceIdentifier deviceId, boolean status) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
|
|
|
* Returns the device of specified id.
|
|
|
|
|
|
|
|
*
|
|
|
|
|
|
|
|
* @param deviceId device Id
|
|
|
|
|
|
|
|
* @return Device returns null when device is not avaialble.
|
|
|
|
|
|
|
|
* @throws DeviceManagementException
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, Date since) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
HashMap<Integer, Device> getTenantedDevice(DeviceIdentifier deviceIdentifier) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Device getDevice(DeviceIdentifier deviceId, EnrolmentInfo.Status status) throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
List<String> getAvailableDeviceTypes() throws DeviceManagementException;
|
|
|
|
List<String> getAvailableDeviceTypes() throws DeviceManagementException;
|
|
|
|
|
|
|
|
|
|
|
|
boolean updateDeviceInfo(DeviceIdentifier deviceIdentifier, Device device) throws DeviceManagementException;
|
|
|
|
boolean updateDeviceInfo(DeviceIdentifier deviceIdentifier, Device device) throws DeviceManagementException;
|
|
|
|