Notification.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2022 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.turro.push.service;
 
import java.net.MalformedURLException;
import java.net.URL;
import static java.nio.charset.StandardCharsets.UTF_8;
import java.security.NoSuchAlgorithmException;
import java.security.NoSuchProviderException;
import java.security.PublicKey;
import java.security.spec.InvalidKeySpecException;
import org.apache.commons.codec.binary.Base64;
import org.bouncycastle.jce.interfaces.ECPublicKey;
import org.turro.push.security.ServerKeys;
 
public class Notification {
 
  private final String endpoint;
 
  private final ECPublicKey userPublicKey;
 
  private final byte[] userAuth;
 
  private final byte[] payload;
 
  private Urgency urgency;
 
  private String topic;
 
  private final int ttl;
 
  private static final int ONE_DAY_DURATION_IN_SECONDS = 86400;
  private static int DEFAULT_TTL = 28 * ONE_DAY_DURATION_IN_SECONDS;
 
  public Notification(String endpoint, ECPublicKey userPublicKey, byte[] userAuth, byte[] payload, int ttl, Urgency urgency, String topic) {
    this.endpoint = endpoint;
    this.userPublicKey = userPublicKey;
    this.userAuth = userAuth;
    this.payload = payload;
    this.ttl = ttl;
    this.urgency = urgency;
    this.topic = topic;
  }
 
  public Notification(String endpoint, PublicKey userPublicKey, byte[] userAuth, byte[] payload, int ttl) {
    this(endpoint, (ECPublicKey) userPublicKey, userAuth, payload, ttl, null, null);
  }
 
  public Notification(String endpoint, String userPublicKey, String userAuth, byte[] payload, int ttl) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(endpoint, ServerKeys.loadPublicKey(userPublicKey), Base64.decodeBase64(userAuth), payload, ttl);
  }
 
  public Notification(String endpoint, PublicKey userPublicKey, byte[] userAuth, byte[] payload) {
    this(endpoint, userPublicKey, userAuth, payload, DEFAULT_TTL);
  }
 
  public Notification(String endpoint, String userPublicKey, String userAuth, byte[] payload) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(endpoint, ServerKeys.loadPublicKey(userPublicKey), Base64.decodeBase64(userAuth), payload);
  }
 
  public Notification(String endpoint, String userPublicKey, String userAuth, String payload) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(endpoint, ServerKeys.loadPublicKey(userPublicKey), Base64.decodeBase64(userAuth), payload.getBytes(UTF_8));
  }
 
  public Notification(String endpoint, String userPublicKey, String userAuth, String payload, Urgency urgency) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(endpoint, ServerKeys.loadPublicKey(userPublicKey), Base64.decodeBase64(userAuth), payload.getBytes(UTF_8));
    this.urgency = urgency;
  }
 
  public Notification(Subscription subscription, String payload) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(subscription.endpoint, subscription.keys.p256dh, subscription.keys.auth, payload);
  }
 
  public Notification(Subscription subscription, String payload, Urgency urgency) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
    this(subscription.endpoint, subscription.keys.p256dh, subscription.keys.auth, payload);
    this.urgency = urgency;
  }
 
  public String getEndpoint() {
    return endpoint;
  }
 
  public ECPublicKey getUserPublicKey() {
    return userPublicKey;
  }
 
  public byte[] getUserAuth() {
    return userAuth;
  }
 
  public byte[] getPayload() {
    return payload;
  }
 
  public boolean hasPayload() {
    return getPayload().length > 0;
  }
 
  public boolean hasUrgency() {
    return urgency != null;
  }
 
  public boolean hasTopic() {
    return topic != null;
  }
 
  public boolean isGcm() {
    return getEndpoint().indexOf("https://android.googleapis.com/gcm/send") == 0;
  }
 
  public boolean isFcm() {
    return getEndpoint().indexOf("https://fcm.googleapis.com/fcm/send") == 0;
  }
 
  public int getTTL() {
    return ttl;
  }
 
  public Urgency getUrgency() {
    return urgency;
  }
 
  public String getTopic() {
    return topic;
  }
 
  public String getOrigin() throws MalformedURLException {
    URL url = new URL(getEndpoint());
 
    return url.getProtocol() + "://" + url.getHost();
  }
 
  public static NotificationBuilder builder() {
    return new Notification.NotificationBuilder();
  }
 
  public static class NotificationBuilder {
 
    private String endpoint = null;
    private ECPublicKey userPublicKey = null;
    private byte[] userAuth = null;
    private byte[] payload = null;
    private int ttl = DEFAULT_TTL;
    private Urgency urgency = null;
    private String topic = null;
 
    private NotificationBuilder() {
    }
 
    public Notification build() {
      return new Notification(endpoint, userPublicKey, userAuth, payload, ttl, urgency, topic);
    }
 
    public NotificationBuilder endpoint(String endpoint) {
      this.endpoint = endpoint;
      return this;
    }
 
    public NotificationBuilder userPublicKey(PublicKey publicKey) {
      this.userPublicKey = (ECPublicKey) publicKey;
      return this;
    }
 
    public NotificationBuilder userPublicKey(String publicKey) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
      this.userPublicKey = (ECPublicKey) ServerKeys.loadPublicKey(publicKey);
      return this;
    }
 
    public NotificationBuilder userPublicKey(byte[] publicKey) throws NoSuchAlgorithmException, NoSuchProviderException, InvalidKeySpecException {
      this.userPublicKey = (ECPublicKey) ServerKeys.loadPublicKey(publicKey);
      return this;
    }
 
    public NotificationBuilder userAuth(String userAuth) {
      this.userAuth = Base64.decodeBase64(userAuth);
      return this;
    }
 
    public NotificationBuilder userAuth(byte[] userAuth) {
      this.userAuth = userAuth;
      return this;
    }
 
    public NotificationBuilder payload(byte[] payload) {
      this.payload = payload;
      return this;
    }
 
    public NotificationBuilder payload(String payload) {
      this.payload = payload.getBytes(UTF_8);
      return this;
    }
 
    public NotificationBuilder ttl(int ttl) {
      this.ttl = ttl;
      return this;
    }
 
    public NotificationBuilder urgency(Urgency urgency) {
      this.urgency = urgency;
      return this;
    }
 
    public NotificationBuilder topic(String topic) {
      this.topic = topic;
      return this;
    }
  }
 
}