/**
* 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.sender;
import com.notnoop.apns.APNS;
import com.notnoop.apns.ApnsService;
import com.notnoop.apns.ApnsServiceBuilder;
import com.notnoop.apns.EnhancedApnsNotification;
import com.notnoop.apns.PayloadBuilder;
import org.jboss.aerogear.unifiedpush.message.cache.APNsCache;
import org.jboss.aerogear.unifiedpush.model.iOSVariant;
import org.jboss.aerogear.unifiedpush.service.ClientInstallationService;
import org.jboss.aerogear.unifiedpush.service.sender.message.UnifiedPushMessage;
import javax.inject.Inject;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
public class APNsPushNotificationSender {
private final Logger logger = Logger.getLogger(APNsPushNotificationSender.class.getName());
@Inject
private ClientInstallationService clientInstallationService;
/**
* Sends APNs notifications ({@link UnifiedPushMessage}) to all devices, that are represented by
* the {@link Collection} of tokens for the given {@link iOSVariant}.
*
* @param iOSVariant the logical construct, needed to lookup the certificate and the passphrase.
* @param tokens collection of tokens, representing actual iOS devices
* @param pushMessage the payload to be submitted
*/
public void sendPushMessage(iOSVariant iOSVariant, Collection<String> tokens, UnifiedPushMessage pushMessage) {
// no need to send empty list
if (tokens.isEmpty()) {
return;
}
PayloadBuilder builder = APNS.newPayload()
// adding recognized key values
.alertBody(pushMessage.getAlert()) // alert dialog, in iOS
.badge(pushMessage.getBadge()) // little badge icon update;
.sound(pushMessage.getSound()); // sound to be played by app
// apply the 'content-available:1' value:
if (pushMessage.isContentAvailable()) {
// content-available:1 is (with iOS7) not only used
// Newsstand, however 'notnoop' names it this way (legacy)...
builder = builder.forNewsstand();
}
builder = builder.customFields(pushMessage.getData()); // adding other (submitted) fields
final String apnsMessage = builder.build(); // build the JSON payload, for APNs
ApnsService service = buildApnsService(iOSVariant);
if (service != null) {
try {
logger.fine(String.format("Sending transformed APNs payload: '%s' ", apnsMessage));
// send:
service.start();
Date expireDate = createFutureDateBasedOnTTL(pushMessage.getTimeToLive());
service.push(tokens, apnsMessage, expireDate);
// after sending, let's ask for the inactive tokens:
final Set<String> inactiveTokens = service.getInactiveDevices().keySet();
// transform the tokens to be all lower-case:
final Set<String> transformedTokens = lowerCaseAllTokens(inactiveTokens);
// trigger asynchronous deletion:
clientInstallationService.removeInstallationsForVariantByDeviceTokens(iOSVariant.getVariantID(), transformedTokens);
} catch (RuntimeException e) {
logger.log(Level.SEVERE, "Error sending messages to APN server", e);
} finally {
// tear down and release resources:
service.stop();
}
} else {
logger.severe("No certificate was found. Could not send messages to APNs");
}
}
/**
* Helper method that creates a future {@link Date}, based on the given ttl/time-to-live value.
* If no TTL was provided, we use the max date from the APNs library
*/
private Date createFutureDateBasedOnTTL(int ttl) {
// no TTL was specified on the payload, we use the MAX Default from the APNs library:
if (ttl == -1) {
return new Date(System.currentTimeMillis() + EnhancedApnsNotification.MAXIMUM_EXPIRY * 1000L);
} else {
// apply the given TTL to the current time
return new Date(System.currentTimeMillis() + ttl);
}
}
/**
* The Java-APNs lib returns the tokens in UPPERCASE format, however, the iOS Devices submit the token in
* LOWER CASE format. This helper method performs a transformation
*/
private Set<String> lowerCaseAllTokens(Set<String> inactiveTokens) {
final Set<String> lowerCaseTokens = new HashSet<String>();
for (String token : inactiveTokens) {
lowerCaseTokens.add(token.toLowerCase());
}
return lowerCaseTokens;
}
/**
* Returns the ApnsService, based on the required profile (production VS sandbox/test).
* Null is returned if there is no "configuration" for the request stage
*/
private ApnsService buildApnsService(iOSVariant iOSVariant) {
// this check should not be needed, but you never know:
if (iOSVariant.getCertificate() != null && iOSVariant.getPassphrase() != null) {
final ApnsServiceBuilder builder = APNS.newService();
// add the certificate:
ByteArrayInputStream stream = new ByteArrayInputStream(iOSVariant.getCertificate());
builder.withCert(stream, iOSVariant.getPassphrase());
try {
// release the stream
stream.close();
} catch (IOException e) {
logger.log(Level.SEVERE, "Error reading certificate", e);
}
// pick the destination:
if (iOSVariant.isProduction()) {
builder.withProductionDestination();
} else {
builder.withSandboxDestination();
}
// create the service
return builder.build();
}
// null if, why ever, there was no cert/passphrase
return null;
}
}