org.mozilla.geckoview

Class WebPushSubscription

Object

org.mozilla.geckoview.WebPushSubscription

All Implemented Interfaces:

Parcelable

public class WebPushSubscription
extends Object
implements Parcelable

This class represents a single Web Push subscription, as described in the Web Push API specification. This is a low-level interface, allowing applications to do all of the heavy lifting themselves. It is recommended that consumers have a thorough understanding of the Web Push API, especially RFC 8291. Only trivial sanity checks are performed on the values held here. The application must ensure it is generating compliant keys/secrets itself.

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	appServerKey This is an optional public key provided by the application server to authenticate itself with the endpoint, formatted according to X9.62.
byte[]	authSecret 16 byte secret key, generated by the embedder, to be provided to the app server for use in encrypting and authenticating messages sent to the endpoint.
byte[]	browserPublicKey The P-256 EC public key, formatted as X9.62, generated by the embedder, to be provided to the app server for message encryption.
static Parcelable.Creator<WebPushSubscription>	CREATOR
String	endpoint The Web Push endpoint for this subscription.
String	scope The Service Worker scope associated with this subscription.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
WebPushSubscription(String scope, String endpoint, byte[] appServerKey, byte[] browserPublicKey, byte[] authSecret)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
void	writeToParcel(Parcel out, int flags)

Methods inherited from class Object

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

Field Detail

scope

@NonNull
public final String scope

The Service Worker scope associated with this subscription.

See Also:

ServiceWorker registration

endpoint

@NonNull
public final String endpoint

The Web Push endpoint for this subscription. This is the URL of a web service which implements the Web Push protocol.

See Also:

RFC 8030

appServerKey

@Nullable
public final byte[] appServerKey

This is an optional public key provided by the application server to authenticate itself with the endpoint, formatted according to X9.62. This key is used for VAPID, the Voluntary Application Server Identification (VAPID) for Web Push, from RFC 8292.

See Also:

applicationServerKey, Message Encryption for Web Push

browserPublicKey

@NonNull
public final byte[] browserPublicKey

The P-256 EC public key, formatted as X9.62, generated by the embedder, to be provided to the app server for message encryption.

See Also:

PushEncryptionKeyName - p256dh, RFC 8291 section 3.1

authSecret

@NonNull
public final byte[] authSecret

16 byte secret key, generated by the embedder, to be provided to the app server for use in encrypting and authenticating messages sent to the endpoint.

See Also:

PushEncryptionKeyName - auth, RFC 8291, section 3.2

CREATOR

public static final Parcelable.Creator<WebPushSubscription> CREATOR

Constructor Detail

WebPushSubscription

public WebPushSubscription(@NonNull
                           String scope,
                           @NonNull
                           String endpoint,
                           @Nullable
                           byte[] appServerKey,
                           @NonNull
                           byte[] browserPublicKey,
                           @NonNull
                           byte[] authSecret)

Method Detail

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel out,
                          int flags)

Specified by:

writeToParcel in interface Parcelable