Package de.svenkubiak.webpush4j

Class WebPush

java.lang.Object

de.svenkubiak.webpush4j.WebPush

public class WebPush
extends Object

Constructor Summary

Constructors

Constructor	Description
WebPush()

Method Summary

Modifier and Type	Method	Description
static WebPush	crerate()
static Encrypted	encrypt(byte[] payload, org.bouncycastle.jce.interfaces.ECPublicKey userPublicKey, byte[] userAuth, Encoding encoding)	Encrypt the payload.
String	getGcmApiKey()
KeyPair	getKeyPair()
PrivateKey	getPrivateKey()
PublicKey	getPublicKey()
String	getSubject()
protected final HttpRequest	prepareRequest(Notification notification, Encoding encoding)
void	send(Notification notification)
<T> T	setGcmApiKey(String gcmApiKey)	Set the Google Cloud Messaging (GCM) API key
<T> T	setKeyPair(KeyPair keyPair)	Set the public and private key (for VAPID).
<T> T	setPrivateKey(String privateKey)	Set the public key using a base64url-encoded string.
<T> T	setPrivateKey(PrivateKey privateKey)	Set the private key (for VAPID)
<T> T	setPublicKey(String publicKey)	Set the public key using a base64url-encoded string.
<T> T	setPublicKey(PublicKey publicKey)	Set the public key (for VAPID)
<T> T	setSubject(String subject)	Set the JWT subject (for VAPID)
protected boolean	vapidEnabled()	Check if VAPID is enabled
WebPush	withGcmApiKey(String gcmApiKey)
WebPush	withKeyPair(KeyPair keyPair)
WebPush	withPrivateKey(String privateKey)
WebPush	withPublicKey(String publicKey)
WebPush	withSubject(String subject)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebPush

public WebPush()

Method Details

crerate

public static WebPush crerate()

withGcmApiKey

public WebPush withGcmApiKey(String gcmApiKey)

withKeyPair

public WebPush withKeyPair(KeyPair keyPair)

withPublicKey

public WebPush withPublicKey(String publicKey)
                      throws NoSuchProviderException,
NoSuchAlgorithmException,
InvalidKeySpecException

Throws:

NoSuchProviderException

NoSuchAlgorithmException

InvalidKeySpecException

withPrivateKey

public WebPush withPrivateKey(String privateKey)
                       throws NoSuchProviderException,
NoSuchAlgorithmException,
InvalidKeySpecException

Throws:

NoSuchProviderException

NoSuchAlgorithmException

InvalidKeySpecException

withSubject

public WebPush withSubject(String subject)
                    throws GeneralSecurityException

Throws:

GeneralSecurityException

send

public void send(Notification notification)
          throws GeneralSecurityException,
IOException,
org.jose4j.lang.JoseException

Throws:

GeneralSecurityException

IOException

org.jose4j.lang.JoseException

encrypt

public static Encrypted encrypt(byte[] payload,
 org.bouncycastle.jce.interfaces.ECPublicKey userPublicKey,
 byte[] userAuth,
 Encoding encoding)
                         throws GeneralSecurityException

Encrypt the payload. Encryption uses Elliptic curve Diffie-Hellman (ECDH) cryptography over the prime256v1 curve.

Parameters:

payload - Payload to encrypt.

userPublicKey - The user agent's public key (keys.p256dh).

userAuth - The user agent's authentication secret (keys.auth).

encoding -

Returns:

An Encrypted object containing the public key, salt, and ciphertext.

Throws:

GeneralSecurityException

prepareRequest

protected final HttpRequest prepareRequest(Notification notification,
 Encoding encoding)
                                    throws GeneralSecurityException,
IOException,
org.jose4j.lang.JoseException

Throws:

GeneralSecurityException

IOException

org.jose4j.lang.JoseException

setGcmApiKey

public <T> T setGcmApiKey(String gcmApiKey)

Set the Google Cloud Messaging (GCM) API key

Parameters:

gcmApiKey -

Returns:

getGcmApiKey

public String getGcmApiKey()

getSubject

public String getSubject()

setSubject

public <T> T setSubject(String subject)

Set the JWT subject (for VAPID)

Parameters:

subject -

Returns:

setKeyPair

public <T> T setKeyPair(KeyPair keyPair)

Set the public and private key (for VAPID).

Parameters:

keyPair -

Returns:

getPublicKey

public PublicKey getPublicKey()

setPublicKey

public <T> T setPublicKey(String publicKey)
                   throws NoSuchAlgorithmException,
NoSuchProviderException,
InvalidKeySpecException

Set the public key using a base64url-encoded string.

Parameters:

publicKey -

Returns:

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidKeySpecException

getPrivateKey

public PrivateKey getPrivateKey()

getKeyPair

public KeyPair getKeyPair()

setPublicKey

public <T> T setPublicKey(PublicKey publicKey)

Set the public key (for VAPID)

Parameters:

publicKey -

Returns:

setPrivateKey

public <T> T setPrivateKey(String privateKey)
                    throws NoSuchAlgorithmException,
NoSuchProviderException,
InvalidKeySpecException

Set the public key using a base64url-encoded string.

Parameters:

privateKey -

Returns:

Throws:

NoSuchAlgorithmException

NoSuchProviderException

InvalidKeySpecException

setPrivateKey

public <T> T setPrivateKey(PrivateKey privateKey)

Set the private key (for VAPID)

Parameters:

privateKey -

Returns:

vapidEnabled

protected boolean vapidEnabled()

Check if VAPID is enabled

Returns: