nl.martijndwars.webpush

Class PushService

java.lang.Object

nl.martijndwars.webpush.PushService

public class PushService
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SERVER_KEY_CURVE
static java.lang.String	SERVER_KEY_ID

Constructor Summary

Constructors

Constructor and Description
PushService()
PushService(java.security.KeyPair keyPair)
PushService(java.security.KeyPair keyPair, java.lang.String subject)
PushService(java.lang.String gcmApiKey)
PushService(java.lang.String publicKey, java.lang.String privateKey)
PushService(java.lang.String publicKey, java.lang.String privateKey, java.lang.String subject)

Method Summary

Modifier and Type	Method and Description
static Encrypted	encrypt(byte[] payload, org.bouncycastle.jce.interfaces.ECPublicKey userPublicKey, byte[] userAuth, Encoding encoding) Encrypt the payload.
java.security.KeyPair	getKeyPair()
java.security.PrivateKey	getPrivateKey()
java.security.PublicKey	getPublicKey()
org.apache.http.client.methods.HttpPost	preparePost(Notification notification, Encoding encoding) Prepare a HttpPost for Apache async http client
org.apache.http.HttpResponse	send(Notification notification)
org.apache.http.HttpResponse	send(Notification notification, Encoding encoding) Send a notification and wait for the response.
java.util.concurrent.Future<org.apache.http.HttpResponse>	sendAsync(Notification notification)
java.util.concurrent.Future<org.apache.http.HttpResponse>	sendAsync(Notification notification, Encoding encoding) Send a notification, but don't wait for the response.
PushService	setGcmApiKey(java.lang.String gcmApiKey) Set the Google Cloud Messaging (GCM) API key
PushService	setKeyPair(java.security.KeyPair keyPair) Set the public and private key (for VAPID).
PushService	setPrivateKey(java.security.PrivateKey privateKey) Set the private key (for VAPID)
PushService	setPrivateKey(java.lang.String privateKey) Set the public key using a base64url-encoded string.
PushService	setPublicKey(java.security.PublicKey publicKey) Set the public key (for VAPID)
PushService	setPublicKey(java.lang.String publicKey) Set the public key using a base64url-encoded string.
PushService	setSubject(java.lang.String subject) Set the JWT subject (for VAPID)
protected boolean	vapidEnabled() Check if VAPID is enabled

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_KEY_ID

public static final java.lang.String SERVER_KEY_ID

See Also:

Constant Field Values

SERVER_KEY_CURVE

public static final java.lang.String SERVER_KEY_CURVE

See Also:

Constant Field Values

Constructor Detail

PushService

public PushService()

PushService

public PushService(java.lang.String gcmApiKey)

PushService

public PushService(java.security.KeyPair keyPair)

PushService

public PushService(java.security.KeyPair keyPair,
                   java.lang.String subject)

PushService

public PushService(java.lang.String publicKey,
                   java.lang.String privateKey)
            throws java.security.GeneralSecurityException

Throws:

java.security.GeneralSecurityException

PushService

public PushService(java.lang.String publicKey,
                   java.lang.String privateKey,
                   java.lang.String subject)
            throws java.security.GeneralSecurityException

Throws:

java.security.GeneralSecurityException

Method Detail

encrypt

public static Encrypted encrypt(byte[] payload,
                                org.bouncycastle.jce.interfaces.ECPublicKey userPublicKey,
                                byte[] userAuth,
                                Encoding encoding)
                         throws java.security.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:

java.security.GeneralSecurityException

send

public org.apache.http.HttpResponse send(Notification notification,
                                         Encoding encoding)
                                  throws java.security.GeneralSecurityException,
                                         java.io.IOException,
                                         org.jose4j.lang.JoseException,
                                         java.util.concurrent.ExecutionException,
                                         java.lang.InterruptedException

Send a notification and wait for the response.

Parameters:

notification -

encoding -

Returns:

Throws:

java.security.GeneralSecurityException

java.io.IOException

org.jose4j.lang.JoseException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

send

public org.apache.http.HttpResponse send(Notification notification)
                                  throws java.security.GeneralSecurityException,
                                         java.io.IOException,
                                         org.jose4j.lang.JoseException,
                                         java.util.concurrent.ExecutionException,
                                         java.lang.InterruptedException

Throws:

java.security.GeneralSecurityException

java.io.IOException

org.jose4j.lang.JoseException

java.util.concurrent.ExecutionException

java.lang.InterruptedException

sendAsync

public java.util.concurrent.Future<org.apache.http.HttpResponse> sendAsync(Notification notification,
                                                                           Encoding encoding)
                                                                    throws java.security.GeneralSecurityException,
                                                                           java.io.IOException,
                                                                           org.jose4j.lang.JoseException

Send a notification, but don't wait for the response.

Parameters:

notification -

encoding -

Returns:

Throws:

java.security.GeneralSecurityException

java.io.IOException

org.jose4j.lang.JoseException

sendAsync

public java.util.concurrent.Future<org.apache.http.HttpResponse> sendAsync(Notification notification)
                                                                    throws java.security.GeneralSecurityException,
                                                                           java.io.IOException,
                                                                           org.jose4j.lang.JoseException

Throws:

java.security.GeneralSecurityException

java.io.IOException

org.jose4j.lang.JoseException

preparePost

public org.apache.http.client.methods.HttpPost preparePost(Notification notification,
                                                           Encoding encoding)
                                                    throws java.security.GeneralSecurityException,
                                                           java.io.IOException,
                                                           org.jose4j.lang.JoseException

Prepare a HttpPost for Apache async http client

Parameters:

notification -

encoding -

Returns:

Throws:

java.security.GeneralSecurityException

java.io.IOException

org.jose4j.lang.JoseException

setGcmApiKey

public PushService setGcmApiKey(java.lang.String gcmApiKey)

Set the Google Cloud Messaging (GCM) API key

Parameters:

gcmApiKey -

Returns:

setSubject

public PushService setSubject(java.lang.String subject)

Set the JWT subject (for VAPID)

Parameters:

subject -

Returns:

setKeyPair

public PushService setKeyPair(java.security.KeyPair keyPair)

Set the public and private key (for VAPID).

Parameters:

keyPair -

Returns:

getPublicKey

public java.security.PublicKey getPublicKey()

setPublicKey

public PushService setPublicKey(java.lang.String publicKey)
                         throws java.security.NoSuchAlgorithmException,
                                java.security.NoSuchProviderException,
                                java.security.spec.InvalidKeySpecException

Set the public key using a base64url-encoded string.

Parameters:

publicKey -

Returns:

Throws:

java.security.NoSuchAlgorithmException

java.security.NoSuchProviderException

java.security.spec.InvalidKeySpecException

getPrivateKey

public java.security.PrivateKey getPrivateKey()

getKeyPair

public java.security.KeyPair getKeyPair()

setPublicKey

public PushService setPublicKey(java.security.PublicKey publicKey)

Set the public key (for VAPID)

Parameters:

publicKey -

Returns:

setPrivateKey

public PushService setPrivateKey(java.lang.String privateKey)
                          throws java.security.NoSuchAlgorithmException,
                                 java.security.NoSuchProviderException,
                                 java.security.spec.InvalidKeySpecException

Set the public key using a base64url-encoded string.

Parameters:

privateKey -

Returns:

Throws:

java.security.NoSuchAlgorithmException

java.security.NoSuchProviderException

java.security.spec.InvalidKeySpecException

setPrivateKey

public PushService setPrivateKey(java.security.PrivateKey privateKey)

Set the private key (for VAPID)

Parameters:

privateKey -

Returns:

vapidEnabled

protected boolean vapidEnabled()

Check if VAPID is enabled

Returns: