UnifiedPush Server Model API 1.0.3
A B C D E F G H I O P S T U V W 

A

AeroGearLogger - Class in org.jboss.aerogear.unifiedpush.utils
Responsible for Logging on UPS and prevent log forgery This class could be easily replaced by Log4j or SLF4J or any other logging framework The motivation behind this implementation is to fix a security issue while AGPUSH-1086 is not solved.
AndroidVariant - Class in org.jboss.aerogear.unifiedpush.api
The Android variant class encapsulates GCM specific behavior.
AndroidVariant() - Constructor for class org.jboss.aerogear.unifiedpush.api.AndroidVariant
 

B

BaseModel - Class in org.jboss.aerogear.unifiedpush.api
 
BaseModel() - Constructor for class org.jboss.aerogear.unifiedpush.api.BaseModel
 

C

calculatePastDate(int) - Static method in class org.jboss.aerogear.unifiedpush.utils.DateUtils
Returns date in history: Today - the given number of days
Category - Class in org.jboss.aerogear.unifiedpush.api
A category of a specific installation.
Category() - Constructor for class org.jboss.aerogear.unifiedpush.api.Category
 
Category(String) - Constructor for class org.jboss.aerogear.unifiedpush.api.Category
 
CategoryDao - Interface in org.jboss.aerogear.unifiedpush.dao
 
ChromePackagedAppVariant - Class in org.jboss.aerogear.unifiedpush.api
 
ChromePackagedAppVariant() - Constructor for class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
 
countInstallationsByType(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
 
create(O) - Method in interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao
 

D

DateUtils - Class in org.jboss.aerogear.unifiedpush.utils
 
delete(O) - Method in interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao
 
deletePushInformationOlderThan(Date) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Delete all Push Message Information entries that are older than the given date
DeviceTokenCheck - Annotation Type in org.jboss.aerogear.unifiedpush.api.validation
 
DeviceTokenValidator - Class in org.jboss.aerogear.unifiedpush.api.validation
Validator that will validate if the device token matches to VariantType specific pattern.
DeviceTokenValidator() - Constructor for class org.jboss.aerogear.unifiedpush.api.validation.DeviceTokenValidator
 

E

equals(Object) - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
existsVariantIDForAdmin(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.VariantDao
 
existsVariantIDForDeveloper(String, String) - Method in interface org.jboss.aerogear.unifiedpush.dao.VariantDao
Checks if variant exists for this developer

F

find(K) - Method in interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao
 
findAll(Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
 
findAllByPushApplicationID(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Finder that returns an actual PushApplicationEntity, identified by its ID and its owner/developer.
findAllDeviceTokenForVariantIDByCriteria(String, List<String>, List<String>, List<String>) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Sender API for installations: Query all tokens for the given variant, by respecting a few criteria arguments (categories, aliases and deviceTypes)
findAllForDeveloper(String, Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Finder that returns all pushApplication object for the given owner/developer.
findAllForPushApplication(String, boolean) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Loads all push message metadata objects for the given PushApplication, but offers a way to order (asc/desc) by date.
findAllForPushApplication(String, boolean, Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Loads paged push message metadata objects for the given PushApplication, but offers a way to order (asc/desc) by date.
findAllForVariant(String, boolean, Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Loads all push message metadata objects for the given Variant, but offers a way to order (asc/desc) by date.
findAllPushApplicationIDsForDeveloper(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Finder that returns a list, containing all pushApplication ids for the given owner/developer.
findAllVariantsByIDs(List<String>) - Method in interface org.jboss.aerogear.unifiedpush.dao.VariantDao
Loads list of all variants, where IDs are given.
findByNames(List<String>) - Method in interface org.jboss.aerogear.unifiedpush.dao.CategoryDao
 
findByPushApplicationID(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Finder that returns an actual PushApplicationEntity, identified by its ID.
findByPushApplicationIDForDeveloper(String, String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Finder that returns an actual PushApplicationEntity, identified by its ID and its owner/developer.
findByVariantID(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.VariantDao
Returns the Variant entity, matching the given variantID.
findByVariantIds(List<String>) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Return application name and id of all variants matching given ids
findInstallationForVariantByDeviceToken(String, String) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Loads a specific installation for the given Variant, specified by the device token.
findInstallationsByVariant(String, Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Find all installations for the variant specified (used for admin role)
findInstallationsByVariantForDeveloper(String, String, Integer, Integer) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Find all installations for the variant specified and for the authneticated user.
findInstallationsForVariantByDeviceTokens(String, Set<String>) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Loads all installations matching the Set of deviceTokens, for the given Variant
findLastThreeActivity(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Filters the three most recent PushMessageInformation objects
findLastThreeActivity() - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
 
findVariantIDsForDeveloper(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.VariantDao
Loads list of all variantIDs for given user.
findVariantIDsWithWarnings(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Filters those variantIDs where the variant shows errors/issues for previous message sends
findVariantIDsWithWarnings() - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
 
fine(String) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
finest(String) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
flushAndClear() - Method in interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao
 

G

GenericBaseDao<O,K> - Interface in org.jboss.aerogear.unifiedpush.dao
Generic base interface for different DAO layers
getAlias() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getCategories() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getCertificate() - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
The APNs certificate that is needed to establish a connection to any of Apple's APNs Push Servers.
getClientId() - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
This is the clientId of the created "application" in the Google API Console https://cloud.google.com/console
getClientIdentifier() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The Client Identifier showing who triggered the Push Notification
getClientSecret() - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
This is the clientSecret of the created "application" in the Google API Console https://cloud.google.com/console
getCount() - Method in class org.jboss.aerogear.unifiedpush.dao.PageResult
 
getDeliveryStatus() - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
Indicator if the request to the actual push network, for the related variant, was successful or not.
getDescription() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
getDescription() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
getDeveloper() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
The developer which created the app.
getDeveloper() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
getDeviceToken() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getDeviceType() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getGoogleKey() - Method in class org.jboss.aerogear.unifiedpush.api.AndroidVariant
The Google API Key from the Google API project, which has been enabled for Android-based GCM.
getId() - Method in class org.jboss.aerogear.unifiedpush.api.BaseModel
 
getId() - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
getInstance(Class) - Static method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
getIpAddress() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The IP from the submitter of the push message request
getMasterSecret() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
getName() - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
getName() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
getName() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
getNumberOfDevicesForVariantIDs(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Counts the total number of registered devices/clients for the give List of variantIDs
getNumberOfDevicesForVariantIDs() - Method in interface org.jboss.aerogear.unifiedpush.dao.InstallationDao
Counts the total number of all registered devices/clients
getNumberOfPushApplicationsForDeveloper(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
Returns total number of PushApplications for given user
getNumberOfPushApplicationsForDeveloper() - Method in interface org.jboss.aerogear.unifiedpush.dao.PushApplicationDao
 
getNumberOfPushMessagesForApplications(String) - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
Does a count for all the push message that have been submitted for the given PushApplication.
getNumberOfPushMessagesForApplications() - Method in interface org.jboss.aerogear.unifiedpush.dao.PushMessageInformationDao
 
getOperatingSystem() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getOsVersion() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getPassphrase() - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
The APNs passphrase that is needed to establish a connection to any of Apple's APNs Push Servers.
getPlatform() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getProjectNumber() - Method in class org.jboss.aerogear.unifiedpush.api.AndroidVariant
The "Google Project Number" from the API Console is not needed for sending push messages, but it is a convenience to "see" it on the Admin UI as well, since the Android applications require it (called Sender ID there).
getPushApplicationID() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
getPushApplicationId() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The ID of the root push application, for which the push message request has been submitted
getRawJsonMessage() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The raw JSON payload of the push message request
getReason() - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
In case of an error (deliveryStatus:false), there is most likely a reason which may give some more insights.
getReceivers() - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
Number of receives for this variant that were found for the submitted push request
getRefreshToken() - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
This is the refreshToken for the created "application"
getResultList() - Method in class org.jboss.aerogear.unifiedpush.dao.PageResult
 
getSecret() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
getSubmitDate() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The date when the push message request has been processed on the UPS
getTotalReceivers() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
The number of active tokens, regardless from the variants, to which this Push Message was sent to
getType() - Method in class org.jboss.aerogear.unifiedpush.api.AndroidVariant
 
getType() - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
 
getType() - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
 
getType() - Method in class org.jboss.aerogear.unifiedpush.api.SimplePushVariant
 
getType() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
The type (Android, iOS or SimplePush) of the underlying variant.
getTypeName() - Method in enum org.jboss.aerogear.unifiedpush.api.VariantType
Returns the actual type name of the variant type
getVariant() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
getVariantID() - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
getVariantID() - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
The ID of the involved variant
getVariantInformations() - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
Collection of specific infos around the related variants
getVariants() - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 

H

hashCode() - Method in class org.jboss.aerogear.unifiedpush.api.Category
 

I

info(String) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
initialize(DeviceTokenCheck) - Method in class org.jboss.aerogear.unifiedpush.api.validation.DeviceTokenValidator
 
Installation - Class in org.jboss.aerogear.unifiedpush.api
One installation of a push-enabled client, running on a device (Android/iOS) or user-agent (SimplePush)
Installation() - Constructor for class org.jboss.aerogear.unifiedpush.api.Installation
 
InstallationDao - Interface in org.jboss.aerogear.unifiedpush.dao
 
iOSVariant - Class in org.jboss.aerogear.unifiedpush.api
The iOS variant class encapsulates APNs specific behavior.
iOSVariant() - Constructor for class org.jboss.aerogear.unifiedpush.api.iOSVariant
 
isEnabled() - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
isProduction() - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
If true a connection to Apple's Production APNs server will be established for this iOS variant.
isValid(Installation, ConstraintValidatorContext) - Method in class org.jboss.aerogear.unifiedpush.api.validation.DeviceTokenValidator
 

O

org.jboss.aerogear.unifiedpush.api - package org.jboss.aerogear.unifiedpush.api
 
org.jboss.aerogear.unifiedpush.api.validation - package org.jboss.aerogear.unifiedpush.api.validation
 
org.jboss.aerogear.unifiedpush.dao - package org.jboss.aerogear.unifiedpush.dao
 
org.jboss.aerogear.unifiedpush.utils - package org.jboss.aerogear.unifiedpush.utils
 

P

PageResult<T> - Class in org.jboss.aerogear.unifiedpush.dao
Holds the result of a query plus the total number of rows
PageResult(List<T>, long) - Constructor for class org.jboss.aerogear.unifiedpush.dao.PageResult
 
PushApplication - Class in org.jboss.aerogear.unifiedpush.api
Logical construct of an overall mobile and push-enabled Application
PushApplication() - Constructor for class org.jboss.aerogear.unifiedpush.api.PushApplication
 
PushApplicationDao - Interface in org.jboss.aerogear.unifiedpush.dao
 
PushMessageInformation - Class in org.jboss.aerogear.unifiedpush.api
Metadata object that contains various informations around a submitted push message request
PushMessageInformation() - Constructor for class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
PushMessageInformationDao - Interface in org.jboss.aerogear.unifiedpush.dao
 

S

setAlias(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
Application specific alias to identify users with the system.
setCategories(Set<Category>) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
Used to "tag" the clients.
setCertificate(byte[]) - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
 
setClientId(String) - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
 
setClientIdentifier(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setClientSecret(String) - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
 
setDeliveryStatus(Boolean) - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
 
setDescription(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
The description of the app.
setDescription(String) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
Some description of the app.
setDeveloper(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
setDeveloper(String) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
setDeviceToken(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
Identifies the device/user-agent within its PushNetwork.
setDeviceType(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
The device type of the device or the user agent.
setEnabled(boolean) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
Flag if the actual client installation is enabled (default) or not.
setGoogleKey(String) - Method in class org.jboss.aerogear.unifiedpush.api.AndroidVariant
 
setId(String) - Method in class org.jboss.aerogear.unifiedpush.api.BaseModel
Key identifying the model object in the underlying database (primary key)
setId(Long) - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
setIpAddress(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setMasterSecret(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
The master password, used for sending message to a PushApplication or its Variants.
setName(String) - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
setName(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
The name of the application.
setName(String) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
The name of the variant (e.g.
setOperatingSystem(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
The (optional) name of the underlying Operating System.
setOsVersion(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
The (optional) version of the used Operating System.
setPassphrase(String) - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
 
setPlatform(String) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
A reliable way of determining the platform type for an installation.
setProduction(boolean) - Method in class org.jboss.aerogear.unifiedpush.api.iOSVariant
 
setProjectNumber(String) - Method in class org.jboss.aerogear.unifiedpush.api.AndroidVariant
 
setPushApplicationID(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
Identifier used to register variants with this PushApplication
setPushApplicationId(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setRawJsonMessage(String) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setReason(String) - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
 
setReceivers(long) - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
 
setRefreshToken(String) - Method in class org.jboss.aerogear.unifiedpush.api.ChromePackagedAppVariant
 
setSecret(String) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
setSubmitDate(Date) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setTotalReceivers(long) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setType(VariantType) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
 
setVariant(Variant) - Method in class org.jboss.aerogear.unifiedpush.api.Installation
 
setVariantID(String) - Method in class org.jboss.aerogear.unifiedpush.api.Variant
Identifier used to register an Installation with this Variant
setVariantID(String) - Method in class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
 
setVariantInformations(Set<VariantMetricInformation>) - Method in class org.jboss.aerogear.unifiedpush.api.PushMessageInformation
 
setVariants(List<Variant>) - Method in class org.jboss.aerogear.unifiedpush.api.PushApplication
 
severe(String) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
severe(String, Throwable) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
SimplePushVariant - Class in org.jboss.aerogear.unifiedpush.api
The SimplePush variant class encapsulates SimplePush specific behavior.
SimplePushVariant() - Constructor for class org.jboss.aerogear.unifiedpush.api.SimplePushVariant
 

T

toString() - Method in class org.jboss.aerogear.unifiedpush.api.Category
 
toString() - Method in class org.jboss.aerogear.unifiedpush.dao.PageResult
 

U

update(O) - Method in interface org.jboss.aerogear.unifiedpush.dao.GenericBaseDao
 

V

valueOf(String) - Static method in enum org.jboss.aerogear.unifiedpush.api.VariantType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jboss.aerogear.unifiedpush.api.VariantType
Returns an array containing the constants of this enum type, in the order they are declared.
Variant - Class in org.jboss.aerogear.unifiedpush.api
Logical construct which matches a mobile app in the appstore.
Variant() - Constructor for class org.jboss.aerogear.unifiedpush.api.Variant
 
VariantDao - Interface in org.jboss.aerogear.unifiedpush.dao
 
VariantMetricInformation - Class in org.jboss.aerogear.unifiedpush.api
Contains metadata about a variant, of the push message request, such as successful delivery to the push network or involved client devices.
VariantMetricInformation() - Constructor for class org.jboss.aerogear.unifiedpush.api.VariantMetricInformation
 
VariantType - Enum in org.jboss.aerogear.unifiedpush.api
A type-safe identifier for the allowed variant types.

W

warning(String) - Method in class org.jboss.aerogear.unifiedpush.utils.AeroGearLogger
 
A B C D E F G H I O P S T U V W 
UnifiedPush Server Model API 1.0.3

Copyright © 2015 JBoss by Red Hat. All Rights Reserved.