org.jboss.aerogear.unifiedpush.service

Interface ClientInstallationService

All Known Implementing Classes:

ClientInstallationServiceImpl

public interface ClientInstallationService

Service class used by the Server to work with Installations for the different Variants.

Method Summary

Modifier and Type	Method and Description
void	addInstallation(org.jboss.aerogear.unifiedpush.api.Variant variant, org.jboss.aerogear.unifiedpush.api.Installation installation) Store a new Installation object on the database.
void	addInstallations(org.jboss.aerogear.unifiedpush.api.Variant variant, List<org.jboss.aerogear.unifiedpush.api.Installation> installations) Add new Installations objects, for importing devices on the database.
org.jboss.aerogear.unifiedpush.dao.ResultsStream.QueryBuilder<String>	findAllDeviceTokenForVariantIDByCriteria(String variantID, List<String> categories, List<String> aliases, List<String> deviceTypes, int maxResults, String lastTokenFromPreviousBatch) Used for (Android/iOS) Sender API.
org.jboss.aerogear.unifiedpush.dao.ResultsStream.QueryBuilder<String>	findAllOldGoogleCloudMessagingDeviceTokenForVariantIDByCriteria(String variantID, List<String> categories, List<String> aliases, List<String> deviceTypes, int maxResults, String lastTokenFromPreviousBatch) Used to query all old GCM tokens, which do not contain a ':' char.
org.jboss.aerogear.unifiedpush.api.Installation	findById(String primaryKey) Returns the Installation entity, matching the given primaryKey.
org.jboss.aerogear.unifiedpush.api.Installation	findInstallationForVariantByDeviceToken(String variantID, String deviceToken) Used for "Device Registration": Finder that returns the actual client installation, identified by its device-token, for the given variant.
void	removeInstallation(org.jboss.aerogear.unifiedpush.api.Installation installation) Removes the given installation entity.
void	removeInstallationForVariantByDeviceToken(String variantID, String deviceToken) Used to remove single device token from UPS.
void	removeInstallations(List<org.jboss.aerogear.unifiedpush.api.Installation> installations) Removes all the installation entities in the List.
void	removeInstallationsForVariantByDeviceTokens(String variantID, Set<String> deviceTokens) Used for "feedback service": Collects the invalid Installations for a Variant, based on the identifier tokens.
void	unsubscribeOldTopics(org.jboss.aerogear.unifiedpush.api.Installation installation) Used for Android installations which have less/other categories on repeated registration
void	updateInstallation(org.jboss.aerogear.unifiedpush.api.Installation installation) Performs an update/merge on the given entity.
void	updateInstallation(org.jboss.aerogear.unifiedpush.api.Installation toUpdate, org.jboss.aerogear.unifiedpush.api.Installation postedInstallation) Updates the first argument with the values from the second, and returns the updated entity.

Method Detail

addInstallation

void addInstallation(org.jboss.aerogear.unifiedpush.api.Variant variant,
                     org.jboss.aerogear.unifiedpush.api.Installation installation)

Store a new Installation object on the database.

Parameters:

variant - the variant to store on

installation - the installation

addInstallations

void addInstallations(org.jboss.aerogear.unifiedpush.api.Variant variant,
                      List<org.jboss.aerogear.unifiedpush.api.Installation> installations)

Add new Installations objects, for importing devices on the database.

Parameters:

variant - the variant to store on

installations - list of installations

updateInstallation

void updateInstallation(org.jboss.aerogear.unifiedpush.api.Installation installation)

Performs an update/merge on the given entity.

Parameters:

installation - the installation

updateInstallation

void updateInstallation(org.jboss.aerogear.unifiedpush.api.Installation toUpdate,
                        org.jboss.aerogear.unifiedpush.api.Installation postedInstallation)

Updates the first argument with the values from the second, and returns the updated entity.

Parameters:

toUpdate - entity to be updated

postedInstallation - entity where we read the "updateable" values from.

findById

org.jboss.aerogear.unifiedpush.api.Installation findById(String primaryKey)

Returns the Installation entity, matching the given primaryKey.

Parameters:

primaryKey - the PK for the installation

Returns:

the installation entity

removeInstallation

void removeInstallation(org.jboss.aerogear.unifiedpush.api.Installation installation)

Removes the given installation entity.

Parameters:

installation - the installation

removeInstallations

void removeInstallations(List<org.jboss.aerogear.unifiedpush.api.Installation> installations)

Removes all the installation entities in the List.

Parameters:

installations - list of installations

removeInstallationsForVariantByDeviceTokens

void removeInstallationsForVariantByDeviceTokens(String variantID,
                                                 Set<String> deviceTokens)

Used for "feedback service": Collects the invalid Installations for a Variant, based on the identifier tokens.

Parameters:

variantID - id of the variant

deviceTokens - list of tokens

removeInstallationForVariantByDeviceToken

void removeInstallationForVariantByDeviceToken(String variantID,
                                               String deviceToken)

Used to remove single device token from UPS. Used for error handling of specific tokens

Parameters:

variantID - id of the variant

deviceToken - one tokens

findInstallationForVariantByDeviceToken

org.jboss.aerogear.unifiedpush.api.Installation findInstallationForVariantByDeviceToken(String variantID,
                                                                                        String deviceToken)

Used for "Device Registration": Finder that returns the actual client installation, identified by its device-token, for the given variant.

Parameters:

variantID - id of the variant

deviceToken - one tokens

Returns:

the installation entity

unsubscribeOldTopics

void unsubscribeOldTopics(org.jboss.aerogear.unifiedpush.api.Installation installation)

Used for Android installations which have less/other categories on repeated registration

Parameters:

installation - Installation object containing correct variant property of AndroidVariant class

findAllDeviceTokenForVariantIDByCriteria

org.jboss.aerogear.unifiedpush.dao.ResultsStream.QueryBuilder<String> findAllDeviceTokenForVariantIDByCriteria(String variantID,
                                                                                                               List<String> categories,
                                                                                                               List<String> aliases,
                                                                                                               List<String> deviceTypes,
                                                                                                               int maxResults,
                                                                                                               String lastTokenFromPreviousBatch)

Used for (Android/iOS) Sender API. Queries the available device-tokens for a given variant, based on provided criteria.

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

Returns:

list of device tokens that matches this filter

findAllOldGoogleCloudMessagingDeviceTokenForVariantIDByCriteria

org.jboss.aerogear.unifiedpush.dao.ResultsStream.QueryBuilder<String> findAllOldGoogleCloudMessagingDeviceTokenForVariantIDByCriteria(String variantID,
                                                                                                                                      List<String> categories,
                                                                                                                                      List<String> aliases,
                                                                                                                                      List<String> deviceTypes,
                                                                                                                                      int maxResults,
                                                                                                                                      String lastTokenFromPreviousBatch)

Used to query all old GCM tokens, which do not contain a ':' char. Queries the available device-tokens for a given variant, based on provided criteria.

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

Returns:

list of old GCM device tokens that matches this filter