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

Methods

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.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	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.

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.

updateInstallation

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

Performs an update/merge on the given entity.

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.

removeInstallation

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

Removes the given installation entity.

removeInstallations

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

Removes all the installation entities in the List.

removeInstallationsForVariantByDeviceTokens

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

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

removeInstallationForVariantByDeviceToken

void removeInstallationForVariantByDeviceToken(String variantID,
                                             String deviceToken)

Used to remove single device token from UPS. Used for error handling of specific 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.

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