org.jboss.aerogear.unifiedpush.dao

Interface InstallationDao

All Superinterfaces:

GenericBaseDao<Installation,String>

public interface InstallationDao
extends GenericBaseDao<Installation,String>

Method Summary

Modifier and Type	Method and Description
Set<String>	findAllDeviceTokenForVariantID(String variantID)
ResultsStream.QueryBuilder<String>	findAllDeviceTokenForVariantIDByCriteria(String variantID, List<String> categories, List<String> aliases, List<String> deviceTypes, int maxResults, String lastTokenFromPreviousBatch, boolean oldGCM) Sender API for installations: Query all tokens for the given variant, by respecting a few criteria arguments (categories, aliases and deviceTypes)
Installation	findInstallationForVariantByDeviceToken(String variantID, String deviceToken) Loads a specific installation for the given Variant, specified by the device token.
PageResult<Installation,Count>	findInstallationsByVariant(String variantID, Integer page, Integer pageSize, String search) Find all installations for the variant specified (used for admin role)
PageResult<Installation,Count>	findInstallationsByVariantForDeveloper(String variantID, String developer, Integer page, Integer pageSize, String search) Find all installations for the variant specified and for the authneticated user.
List<Installation>	findInstallationsForVariantByDeviceTokens(String variantID, Set<String> deviceTokens) Loads all installations matching the Set of deviceTokens, for the given Variant.
long	getNumberOfDevicesForLoginName(String loginName) Counts the total number of registered devices/clients for the give List of variantIDs
long	getNumberOfDevicesForVariantID(String variantId) Counts the number of registered devices/clients for the given variant ID
long	getTotalNumberOfDevices() Counts the total number of all registered devices/clients

Methods inherited from interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao

create, delete, find, flushAndClear, lock, update

Method Detail

findInstallationForVariantByDeviceToken

Installation findInstallationForVariantByDeviceToken(String variantID,
                                                     String deviceToken)

Loads a specific installation for the given Variant, specified by the device token.

Parameters:

variantID - the variantID for the filter

deviceToken - the deviceToken for the filter

Returns:

intallation object or null.

findInstallationsForVariantByDeviceTokens

List<Installation> findInstallationsForVariantByDeviceTokens(String variantID,
                                                             Set<String> deviceTokens)

Loads all installations matching the Set of deviceTokens, for the given Variant.

Parameters:

variantID - the variantID for the filter

deviceTokens - the deviceTokens for the filter

Returns:

list of intallation objects.

findAllDeviceTokenForVariantIDByCriteria

ResultsStream.QueryBuilder<String> findAllDeviceTokenForVariantIDByCriteria(String variantID,
                                                                            List<String> categories,
                                                                            List<String> aliases,
                                                                            List<String> deviceTypes,
                                                                            int maxResults,
                                                                            String lastTokenFromPreviousBatch,
                                                                            boolean oldGCM)

Sender API for installations: Query all tokens for the given variant, by respecting a few criteria arguments (categories, aliases and deviceTypes)

Parameters:

variantID - the variantID for the filter

categories - applied categories for the filter

aliases - applied aliases for the filter

deviceTypes - applied deviceTypes for the filter

maxResults - number of maxResults for the filter

lastTokenFromPreviousBatch - identifier of the last fetched token

oldGCM - if true only old GCM tokens (not containing a :) are load

Returns:

list of device tokens that matches this filter

findAllDeviceTokenForVariantID

Set<String> findAllDeviceTokenForVariantID(String variantID)

findInstallationsByVariantForDeveloper

PageResult<Installation,Count> findInstallationsByVariantForDeveloper(String variantID,
                                                                      String developer,
                                                                      Integer page,
                                                                      Integer pageSize,
                                                                      String search)

Find all installations for the variant specified and for the authneticated user.

Parameters:

variantID - the id of the variant to find the installations for

developer - the developer

page - the page number

pageSize - the size of the pages

search - any value of the device metadata

Returns:

all installations found or empty list + the total count of results

findInstallationsByVariant

PageResult<Installation,Count> findInstallationsByVariant(String variantID,
                                                          Integer page,
                                                          Integer pageSize,
                                                          String search)

Find all installations for the variant specified (used for admin role)

Parameters:

variantID - the id of the variant to find the installations for

page - the page number

pageSize - the size of the pages

search - any value of the device metadata

Returns:

all installations found or empty list + the total count of results

getNumberOfDevicesForLoginName

long getNumberOfDevicesForLoginName(String loginName)

Counts the total number of registered devices/clients for the give List of variantIDs

Parameters:

loginName - name of the current user

Returns:

number of devices for user

getTotalNumberOfDevices

long getTotalNumberOfDevices()

Counts the total number of all registered devices/clients

Returns:

number of devices for admin

getNumberOfDevicesForVariantID

long getNumberOfDevicesForVariantID(String variantId)

Counts the number of registered devices/clients for the given variant ID

Parameters:

variantId - the variant ID

Returns:

number of devices for given variant