org.wso2.carbon.device.mgt.analytics.dashboard.impl

Class GadgetDataServiceImpl

java.lang.Object

org.wso2.carbon.device.mgt.analytics.dashboard.impl.GadgetDataServiceImpl

All Implemented Interfaces:

GadgetDataService

public class GadgetDataServiceImpl
extends Object
implements GadgetDataService

Implementation class of GadgetDataService.

Constructor Summary

Constructors

Constructor and Description
GadgetDataServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
DeviceCountByGroup	getDeviceCount(ExtendedFilterSet extendedFilterSet, String userName) This method is used to get a count of devices based on a defined filter set.
List<DeviceCountByGroup>	getDeviceCountsByConnectivityStatuses(String userName) This method is used to get device counts classified by connectivity statuses.
List<DeviceCountByGroup>	getDeviceCountsByOwnershipTypes(ExtendedFilterSet extendedFilterSet, String userName) This method is used to get device counts classified by ownership types.
List<DeviceCountByGroup>	getDeviceCountsByPlatforms(ExtendedFilterSet extendedFilterSet, String userName) This method is used to get device counts classified by platforms.
List<DeviceCountByGroup>	getDeviceCountsByPotentialVulnerabilities(String userName) This method is used to get device counts classified by potential vulnerabilities.
org.wso2.carbon.device.mgt.common.PaginationResult	getDevicesWithDetails(ExtendedFilterSet extendedFilterSet, int startIndex, int resultCount, String userName) This method is used to get a paginated list of devices with details, based on a defined filter set.
List<DeviceWithDetails>	getDevicesWithDetails(ExtendedFilterSet extendedFilterSet, String userName) This method is used to get a list of devices with details, based on a defined filter set.
DeviceCountByGroup	getFeatureNonCompliantDeviceCount(String featureCode, BasicFilterSet basicFilterSet, String userName) This method is used to get a count of devices non-compliant upon on a particular feature and a defined filter set.
List<DeviceCountByGroup>	getFeatureNonCompliantDeviceCountsByOwnershipTypes(String featureCode, BasicFilterSet basicFilterSet, String userName) This method is used to get device counts non-compliant upon a particular feature classified by ownership types.
List<DeviceCountByGroup>	getFeatureNonCompliantDeviceCountsByPlatforms(String featureCode, BasicFilterSet basicFilterSet, String userName) This method is used to get device counts non-compliant upon a particular feature classified by platforms.
org.wso2.carbon.device.mgt.common.PaginationResult	getFeatureNonCompliantDevicesWithDetails(String featureCode, BasicFilterSet basicFilterSet, int startIndex, int resultCount, String userName) This method is used to get a paginated list of non-compliant devices with details, upon a particular feature.
List<DeviceWithDetails>	getFeatureNonCompliantDevicesWithDetails(String featureCode, BasicFilterSet basicFilterSet, String userName) This method is used to get a list of non-compliant devices with details, upon a particular feature.
org.wso2.carbon.device.mgt.common.PaginationResult	getNonCompliantDeviceCountsByFeatures(int startIndex, int resultCount, String userName) This method is used to get non-compliant device counts classified by individual features.
DeviceCountByGroup	getTotalDeviceCount(String userName) This method is used to get total count of devices currently enrolled under a particular tenant.

Methods inherited from class java.lang.Object

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

Constructor Detail

GadgetDataServiceImpl

public GadgetDataServiceImpl()

Method Detail

getDeviceCount

public DeviceCountByGroup getDeviceCount(ExtendedFilterSet extendedFilterSet,
                                String userName)
                                  throws InvalidPotentialVulnerabilityValueException,
                                         DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get a count of devices based on a defined filter set.

Specified by:

getDeviceCount in interface GadgetDataService

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device count in the system wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCount

public DeviceCountByGroup getFeatureNonCompliantDeviceCount(String featureCode,
                                                   BasicFilterSet basicFilterSet,
                                                   String userName)
                                                     throws InvalidFeatureCodeValueException,
                                                            DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get a count of devices non-compliant upon on a particular feature and a defined filter set.

Specified by:

getFeatureNonCompliantDeviceCount in interface GadgetDataService

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device count in the system for the given feature-code, wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getTotalDeviceCount

public DeviceCountByGroup getTotalDeviceCount(String userName)
                                       throws DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get total count of devices currently enrolled under a particular tenant.

Specified by:

getTotalDeviceCount in interface GadgetDataService

Returns:

An object of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByConnectivityStatuses

public List<DeviceCountByGroup> getDeviceCountsByConnectivityStatuses(String userName)
                                                               throws DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts classified by connectivity statuses.

Specified by:

getDeviceCountsByConnectivityStatuses in interface GadgetDataService

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByPotentialVulnerabilities

public List<DeviceCountByGroup> getDeviceCountsByPotentialVulnerabilities(String userName)
                                                                   throws DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts classified by potential vulnerabilities.

Specified by:

getDeviceCountsByPotentialVulnerabilities in interface GadgetDataService

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getNonCompliantDeviceCountsByFeatures

public org.wso2.carbon.device.mgt.common.PaginationResult getNonCompliantDeviceCountsByFeatures(int startIndex,
                                                                                       int resultCount,
                                                                                       String userName)
                                                                                         throws InvalidStartIndexValueException,
                                                                                                InvalidResultCountValueException,
                                                                                                DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get non-compliant device counts classified by individual features.

Specified by:

getNonCompliantDeviceCountsByFeatures in interface GadgetDataService

Parameters:

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByPlatforms

public List<DeviceCountByGroup> getDeviceCountsByPlatforms(ExtendedFilterSet extendedFilterSet,
                                                  String userName)
                                                    throws InvalidPotentialVulnerabilityValueException,
                                                           DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts classified by platforms.

Specified by:

getDeviceCountsByPlatforms in interface GadgetDataService

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device counts per each platform in the system, wrapped by the defined return format.

Returns:

An object of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCountsByPlatforms

public List<DeviceCountByGroup> getFeatureNonCompliantDeviceCountsByPlatforms(String featureCode,
                                                                     BasicFilterSet basicFilterSet,
                                                                     String userName)
                                                                       throws InvalidFeatureCodeValueException,
                                                                              DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts non-compliant upon a particular feature classified by platforms.

Specified by:

getFeatureNonCompliantDeviceCountsByPlatforms in interface GadgetDataService

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device counts per each platform in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDeviceCountsByOwnershipTypes

public List<DeviceCountByGroup> getDeviceCountsByOwnershipTypes(ExtendedFilterSet extendedFilterSet,
                                                       String userName)
                                                         throws InvalidPotentialVulnerabilityValueException,
                                                                DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts classified by ownership types.

Specified by:

getDeviceCountsByOwnershipTypes in interface GadgetDataService

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device counts per each ownership type in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDeviceCountsByOwnershipTypes

public List<DeviceCountByGroup> getFeatureNonCompliantDeviceCountsByOwnershipTypes(String featureCode,
                                                                          BasicFilterSet basicFilterSet,
                                                                          String userName)
                                                                            throws InvalidFeatureCodeValueException,
                                                                                   DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get device counts non-compliant upon a particular feature classified by ownership types.

Specified by:

getFeatureNonCompliantDeviceCountsByOwnershipTypes in interface GadgetDataService

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total non-compliant device counts per each ownership type in the system, wrapped by the defined return format.

Returns:

A list of objects of type DeviceCountByGroup.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getDevicesWithDetails

public org.wso2.carbon.device.mgt.common.PaginationResult getDevicesWithDetails(ExtendedFilterSet extendedFilterSet,
                                                                       int startIndex,
                                                                       int resultCount,
                                                                       String userName)
                                                                         throws InvalidPotentialVulnerabilityValueException,
                                                                                DataAccessLayerException,
                                                                                InvalidStartIndexValueException,
                                                                                InvalidResultCountValueException

Description copied from interface: GadgetDataService

This method is used to get a paginated list of devices with details, based on a defined filter set.

Specified by:

getDevicesWithDetails in interface GadgetDataService

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return a paginated device list in the system specified by result count, starting from specified start index, and wrapped by the defined return format.

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

getFeatureNonCompliantDevicesWithDetails

public org.wso2.carbon.device.mgt.common.PaginationResult getFeatureNonCompliantDevicesWithDetails(String featureCode,
                                                                                          BasicFilterSet basicFilterSet,
                                                                                          int startIndex,
                                                                                          int resultCount,
                                                                                          String userName)
                                                                                            throws InvalidFeatureCodeValueException,
                                                                                                   DataAccessLayerException,
                                                                                                   InvalidStartIndexValueException,
                                                                                                   InvalidResultCountValueException

Description copied from interface: GadgetDataService

This method is used to get a paginated list of non-compliant devices with details, upon a particular feature.

Specified by:

getFeatureNonCompliantDevicesWithDetails in interface GadgetDataService

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return a paginated device list in the system, non-compliant by specified feature-code, result count, starting from specified start index, and wrapped by the defined return format.

startIndex - Starting index of the data set to be retrieved.

resultCount - Total count of the result set retrieved.

Returns:

An object of type PaginationResult.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

InvalidStartIndexValueException - This can occur if startIndex value is lesser than its minimum (0).

InvalidResultCountValueException - This can occur if resultCount value is lesser than its minimum (5).

getDevicesWithDetails

public List<DeviceWithDetails> getDevicesWithDetails(ExtendedFilterSet extendedFilterSet,
                                            String userName)
                                              throws InvalidPotentialVulnerabilityValueException,
                                                     DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get a list of devices with details, based on a defined filter set.

Specified by:

getDevicesWithDetails in interface GadgetDataService

Parameters:

extendedFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total device list in the system wrapped by the defined return format.

Returns:

A list of objects of type DeviceWithDetails.

Throws:

InvalidPotentialVulnerabilityValueException - This can occur if potentialVulnerability value of extendedFilterSet is set with some value other than "NON_COMPLIANT" or "UNMONITORED".

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.

getFeatureNonCompliantDevicesWithDetails

public List<DeviceWithDetails> getFeatureNonCompliantDevicesWithDetails(String featureCode,
                                                               BasicFilterSet basicFilterSet,
                                                               String userName)
                                                                 throws InvalidFeatureCodeValueException,
                                                                        DataAccessLayerException

Description copied from interface: GadgetDataService

This method is used to get a list of non-compliant devices with details, upon a particular feature.

Specified by:

getFeatureNonCompliantDevicesWithDetails in interface GadgetDataService

Parameters:

featureCode - Code name of the non-compliant feature.

basicFilterSet - An abstract representation of possible filtering options. if this value is simply "null" or no values are set for the defined filtering options, this method would return total set of non-compliant devices in the system upon given feature-code, wrapped by the defined return format.

Returns:

A list of objects of type DeviceWithDetails.

Throws:

InvalidFeatureCodeValueException - This can occur if featureCode is set to null or empty.

DataAccessLayerException - This can occur due to errors connecting to database, executing SQL query and retrieving data.