org.jboss.aerogear.unifiedpush.message.UnifiedMessage Maven / Gradle / Ivy
The newest version!
/**
* JBoss, Home of Professional Open Source
* Copyright Red Hat, Inc., and individual contributors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.jboss.aerogear.unifiedpush.message;
import org.jboss.aerogear.unifiedpush.message.apns.APNs;
import org.jboss.aerogear.unifiedpush.message.windows.ToastType;
import org.jboss.aerogear.unifiedpush.message.windows.TileType;
import org.jboss.aerogear.unifiedpush.message.windows.BadgeType;
import org.jboss.aerogear.unifiedpush.message.windows.DurationType;
import org.jboss.aerogear.unifiedpush.message.windows.Type;
import org.jboss.aerogear.unifiedpush.message.windows.Windows;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* A UnifiedMessage represents a message in the format expected from the Unified Push Server.
* The message format is very simple: A generic JSON map is used to send messages to Android, iOS and Windows devices.
* The applications on the devices will receive the JSON map and are responsible for performing a lookup to read values of the given keys.
* See the Message Specification for more information.
*
* To construct a message use the {@link #withMessage()} like this :
*
*
* {@code
* UnifiedMessage unifiedMessage = UnifiedMessage.withMessage()
* .alert("Hello")
* .sound("default")
* .criteria()
* .variants("c3f0a94f-48de-4b77-a08e-68114460857e") // e.g. HR_Premium
* .aliases("mike", "john")
* .categories("sport", "world cup")
* .deviceType("iPad", "AndroidTablet")
* .build();
* }
*
*/
public class UnifiedMessage {
private final UnifiedPushMessage unifiedPushMessage = new UnifiedPushMessage();
private final MessageBuilder message;
private final CriteriaBuilder criteria;
private final ConfigBuilder config;
public static MessageBuilder withMessage() {
return new Builder().message();
}
public static CriteriaBuilder withCriteria() {
return new Builder().criteria();
}
public static ConfigBuilder withConfig() {
return new Builder().config();
}
/**
* A builder to provide a fluent API
*
* @deprecated Please use one of the static methods in {@link UnifiedMessage}
* @see UnifiedMessage#withMessage()
* @see UnifiedMessage#withCriteria()
* @see UnifiedMessage#withConfig()
*/
public static class Builder {
private MessageBuilder messageBuilder;
private CriteriaBuilder criteriaBuilder;
private ConfigBuilder configBuilder;
/**
*
* Returns the criteria builder
*
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder criteria() {
if (criteriaBuilder == null) {
criteriaBuilder = new CriteriaBuilder(this);
}
return criteriaBuilder;
}
/**
*
* Returns the message builder
*
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder message() {
if (messageBuilder == null) {
messageBuilder = new MessageBuilder(this);
}
return messageBuilder;
}
/**
*
* Returns the config builder
*
* @return the current {@link ConfigBuilder} instance
*/
public ConfigBuilder config() {
if (configBuilder == null) {
configBuilder = new ConfigBuilder(this);
}
return configBuilder;
}
public UnifiedMessage build() {
return new UnifiedMessage(this);
}
}
public static class CriteriaBuilder {
public CriteriaBuilder(Builder builder) {
this.builder = builder;
}
private final Builder builder;
private final Criteria criteria = new Criteria();
/**
* Sets a list of "identifiers", like username or email address.
*
* @param aliases a list of "identifiers", like username or email address
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder aliases(List aliases) {
criteria.setAliases(aliases);
return this;
}
/**
* Sets a list of "identifiers", like username or email address.
*
* @param aliases a list of "identifiers", like username or email address
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder aliases(String... aliases) {
return aliases(new ArrayList(Arrays.asList(aliases)));
}
/**
* A filter for notifying only specific mobile variants of the Push Application.
*
* @param variants a list of mobile variants ids
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder variants(List variants) {
criteria.setVariants(variants);
return this;
}
/**
* A filter for notifying only specific mobile variants of the Push Application.
*
* @param variants a list of mobile variants ids
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder variants(String... variants) {
return variants(new ArrayList(Arrays.asList(variants)));
}
/**
* A list of categories. A Category is a semantical tag.
*
* @param categories a set of categories
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder categories(Set categories) {
criteria.setCategories(new ArrayList(categories));
return this;
}
/**
* A list of categories. A Category is a semantical tag.
*
* @param categories a list of categories
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder categories(String... categories) {
return categories(new HashSet(Arrays.asList(categories)));
}
/**
* A filter for notifying only users running a certain device.
*
* @param deviceType a list of devices i.e ["iPad","iPhone"]
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder deviceType(List deviceType) {
criteria.setDeviceTypes(deviceType);
return this;
}
/**
* A filter for notifying only users running a certain device.
*
* @param deviceType a list of devices i.e ["iPad","iPhone"]
* @return the current {@link CriteriaBuilder} instance
*/
public CriteriaBuilder deviceType(String... deviceType) {
return deviceType(new ArrayList(Arrays.asList(deviceType)));
}
public MessageBuilder message() {
if (builder.messageBuilder == null) {
builder.messageBuilder = new MessageBuilder(builder);
}
return builder.messageBuilder;
}
public ConfigBuilder config() {
if (builder.configBuilder == null) {
builder.configBuilder = new ConfigBuilder(builder);
}
return builder.configBuilder;
}
public UnifiedMessage build() {
return builder.build();
}
public Criteria getObject() {
return criteria;
}
}
public static class MessageBuilder {
public MessageBuilder(Builder builder) {
this.builder = builder;
}
private final Builder builder;
private final Message message = new Message();
private WindowsBuilder windowsBuilder;
private ApnsBuilder apnsBuilder;
/**
* Triggers a dialog, displaying the value.
*
* @param message that will be displayed on the alert UI element
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder alert(String message) {
this.message.setAlert(message);
return this;
}
/**
* Plays a given sound - On iOS no API needs to be invoked to play the sound file.
* However on other platforms custom API call may be required.
*
* @param sound i.e name of the sound file
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder sound(String sound) {
message.setSound(sound);
return this;
}
/**
* Sets the value of the badge icon - no iOS API needs to be invoked by the app developer.
*
* @param badge i.e file name of the icon
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder badge(String badge) {
message.setBadge(Integer.valueOf(badge));
return this;
}
/**
* Needed when sending a message to a SimplePush Network
*
* @param version to pass to the broadcast channel, i.e "version=5"
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder simplePush(String version) {
message.setSimplePush(fixVersion(version));
return this;
}
/**
* Adds an custom value for the given key. This is used to pass user data to
* the UnifiedPush Server
*
* @param key of an user data entry
* @param value of an user data entry
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder userData(String key, String value) {
message.getUserData().put(key, value);
return this;
}
/**
* Adds a map containing custom key/value entries. This is used to pass user data to
* the UnifiedPush Server
* @param userDataMap containing custom key/value entries
* @return the current {@link MessageBuilder} instance
*/
public MessageBuilder userData(Map userDataMap) {
message.setUserData(userDataMap);
return this;
}
public CriteriaBuilder criteria() {
if (builder.criteriaBuilder == null) {
builder.criteriaBuilder = new CriteriaBuilder(builder);
}
return builder.criteriaBuilder;
}
public ConfigBuilder config() {
if (builder.configBuilder == null) {
builder.configBuilder = new ConfigBuilder(builder);
}
return builder.configBuilder;
}
/**
* Windows specific push notification settings support for Tile, Raw, Badge and Toast messages
* For all the templates as much as possible the main parts of the message are re-used. Alert is the main text
* as is the badge number for badge notifications. Only specific windows settings are put in this part of the message
* and ignored by other message senders.
*
* @return a {@link WindowsBuilder} instance
*/
public WindowsBuilder windows() {
if (windowsBuilder == null) {
windowsBuilder = new WindowsBuilder(this);
}
return windowsBuilder;
}
/**
* Apns specific push notification settings like "title", "actionCategory" ...
* more info about apns
*
* @return a {@link ApnsBuilder} instance
*/
public ApnsBuilder apns() {
if (apnsBuilder == null) {
apnsBuilder = new ApnsBuilder(this);
}
return apnsBuilder;
}
private static String fixVersion(String version) {
if (version != null && !version.startsWith("version=")) {
version = "version=" + version;
}
return version;
}
public UnifiedMessage build() {
return builder.build();
}
protected Message getObject() {
return message;
}
public static class WindowsBuilder {
private final MessageBuilder messageBuilder;
private final Windows windows = new Windows();
public WindowsBuilder(MessageBuilder builder) {
this.messageBuilder = builder;
}
/**
* Set the type of message to send toast, raw, badge or tile.
* more info about the types
*
* @param type of message to send
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder type(Type type) {
windows.setType(type);
return this;
}
/**
* Set the raw notification type. A raw notification is a type of push notification without any associated UI.
* more info about the raw type
*
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder raw() {
windows.setType(Type.raw);
return this;
}
/**
* Set the badge notifications type for badges that are not numbers,
* for numbers use {@link MessageBuilder#badge(String)} method.
* Check the Tile and badge catalog
*
* @param badgeType the badge notifications type
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder badgeType(BadgeType badgeType) {
windows.setType(Type.badge);
windows.setBadge(badgeType);
return this;
}
/**
* Set the type of the tile messages, different sizes are available.
* See the tile template catalog
*
* @param tileType the tileType
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder tileType(TileType tileType) {
windows.setType(Type.tile);
windows.setTileType(tileType);
return this;
}
/**
* Set the duration of a Toast message (long or short)
*
* @param durationType the duration of a Toast message (long or short)
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder durationType(DurationType durationType) {
windows.setDuration(durationType);
return this;
}
/**
* Set the toast template.
* Refer to the Toast template catalog
*
* @param toastType the toast template
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder toastType(ToastType toastType) {
windows.setType(Type.toast);
windows.setToastType(toastType);
return this;
}
/**
* Set a list of image's paths for the Tile Notification Type
*
* @param images a list of image's paths
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder images(List images) {
windows.setImages(images);
return this;
}
/**
* Set a list of text fields for the Tile Notification Type
*
* @param textFields a list of text fields
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder textFields(List textFields) {
windows.setTextFields(textFields);
return this;
}
/**
* Sets the page, this is a Windows specific setting that contains the
* page in you application to launch when the user 'touches' the notification
* in the notification dock. For cordova applications set this to 'cordova' to
* launch your app and invoke the javascript callback.
*
* Payload example:
*
* "page": "/MainPage.xaml"
*
* @param page to launch when user 'touches' the notification
* @return the current {@link WindowsBuilder} instance
*/
public WindowsBuilder page(String page){
windows.setPage(page);
return this;
}
public MessageBuilder build() {
messageBuilder.message.setWindows(windows);
return messageBuilder;
}
}
public static class ApnsBuilder {
private final MessageBuilder messageBuilder;
private final APNs apns= new APNs();
public ApnsBuilder(MessageBuilder builder) {
this.messageBuilder = builder;
}
/**
* An iOS specific argument to mark the payload as 'content-available'. The feature is
* needed when sending notifications to Newsstand applications and submitting silent iOS notifications (iOS7)
*
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder contentAvailable() {
apns.setContentAvailable(true);
return this;
}
/**
* An iOS specific argument to pass an Action Category for interaction notifications ( iOS8)
*
* @param actionCategory the identifier of the action category for the interactive notification
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder actionCategory(String actionCategory) {
apns.setActionCategory(actionCategory);
return this;
}
/**
* Sets the value of the 'action' key from the submitted payload.
*
* @param action the 'action' key
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder action(String action) {
apns.setAction(action);
return this;
}
/**
* Sets the value of the 'title' key from the submitted payload.
*
* @param title the value of the 'title' key
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder title(String title) {
apns.setTitle(title);
return this;
}
/**
* The key to a title string in the Localizable.strings file for the current localization.
*
* @param localizedTitleKey the localized title key
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder localizedTitleKey(String localizedTitleKey) {
apns.setLocalizedTitleKey(localizedTitleKey);
return this;
}
/**
* Sets the arguments for the localizable title key
*
* @param localizedTitleArguments the localized title arguments
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder localizedTitleArguments(String[] localizedTitleArguments) {
apns.setLocalizedTitleArguments(localizedTitleArguments);
return this;
}
/**
* Sets the value of the 'url-args' key from the submitted payload.
*
* @param urlArgs a String Array containing the keys
* @return the current {@link ApnsBuilder} instance
*/
public ApnsBuilder urlArgs(String[] urlArgs) {
apns.setUrlArgs(urlArgs);
return this;
}
public MessageBuilder build() {
messageBuilder.message.setApns(apns);
return messageBuilder;
}
}
}
public static class ConfigBuilder {
private final Builder builder;
private final Config config = new Config();
public ConfigBuilder(Builder builder) {
this.builder = builder;
}
/**
* Specify the Time To Live of the message, used by the APNs/GCM Push Networks.
* If the device is offline for a longer time than the ttl value, the supported Push Networks may not deliver the message to the client.
*
* @param seconds , the amount of seconds of the Time To Live
* @return the current {@link ConfigBuilder} instance
*/
public ConfigBuilder timeToLive(int seconds) {
config.setTimeToLive(seconds);
return this;
}
protected Config getObject() {
return config;
}
public MessageBuilder message() {
if (builder.messageBuilder == null) {
builder.messageBuilder = new MessageBuilder(builder);
}
return builder.messageBuilder;
}
public CriteriaBuilder criteria() {
if (builder.criteriaBuilder == null) {
builder.criteriaBuilder = new CriteriaBuilder(builder);
}
return builder.criteriaBuilder;
}
public UnifiedMessage build() {
return builder.build();
}
}
/**
* private constructor as UnifiedMessage can only be created through the Builder.
*
* @param builder The builder object that would be used to construct the UnifiedMessage
*/
private UnifiedMessage(Builder builder) {
criteria = builder.criteriaBuilder;
config = builder.configBuilder;
message = builder.messageBuilder;
}
public MessageBuilder getMessage() {
return message;
}
public CriteriaBuilder getCriteria() {
return criteria;
}
public ConfigBuilder getConfig() {
return config;
}
public UnifiedPushMessage getObject() {
if (message != null) {
unifiedPushMessage.setMessage(message.getObject());
}
if (config != null) {
unifiedPushMessage.setConfig(config.getObject());
}
if (criteria != null) {
unifiedPushMessage.setCriteria(criteria.getObject());
}
return unifiedPushMessage;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy