Module com.zerodeplibs.webpush

Package com.zerodeplibs.webpush.jwt

Class VAPIDJWTParam.Builder

java.lang.Object

com.zerodeplibs.webpush.jwt.VAPIDJWTParam.Builder

Enclosing class:

VAPIDJWTParam

public static class VAPIDJWTParam.Builder
extends Object

The builder class for VAPIDJWTParam.

Author:

Tomoki Sato

Method Summary

Modifier and Type	Method	Description
VAPIDJWTParam.Builder	additionalClaim(String name, Object value)	Specifies an additional claim.
VAPIDJWTParam	build()	Creates a new VAPIDJWTParam.
VAPIDJWTParam	buildWithDefault()	Creates a new VAPIDJWTParam.
VAPIDJWTParam.Builder	expirationTime(Instant expirationTime)	Specifies the time at which a JWT for VAPID expires.
VAPIDJWTParam.Builder	expiresAfter(int expiresAfter, TimeUnit timeUnit)	Specifies the time after which a JWT for VAPID expires.
VAPIDJWTParam.Builder	resourceURL(URL resourceURL)	Specifies a push resource URL from which the origin is extracted.
VAPIDJWTParam.Builder	resourceURLString(String resourceURLString)	Specifies a push resource URL from which the origin is extracted.
VAPIDJWTParam.Builder	subject(String subject)	Specifies a subject.

Methods inherited from class java.lang.Object

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

Method Detail

resourceURLString

public VAPIDJWTParam.Builder resourceURLString(String resourceURLString)

Specifies a push resource URL from which the origin is extracted.

Typically,

• the resource URL is the value obtained from an endpoint field of a push subscription.
• the extracted origin is used as an "aud"(Audience) claim.

Parameters:

resourceURLString - the string representation of a push resource URL.

Returns:

this object.

Throws:

MalformedURLRuntimeException - if the underlying URL(String) throws MalformedURLException.

IllegalStateException - if the methods for specifying a resource URL are called more than once.

resourceURL

public VAPIDJWTParam.Builder resourceURL(URL resourceURL)

Specifies a push resource URL from which the origin is extracted.

Typically,

• the resource URL is the value obtained from an endpoint field of a push subscription.
• the extracted origin is used as an "aud"(Audience) claim.

Parameters:

resourceURL - a push resource URL.

Returns:

this object.

Throws:

IllegalStateException - if the methods for specifying a resource URL are called more than once.

expiresAfter

public VAPIDJWTParam.Builder expiresAfter(int expiresAfter,
                                          TimeUnit timeUnit)

Specifies the time after which a JWT for VAPID expires.

Typically, the specified expiration time is used as an "exp" (Expiry) claim.

Parameters:

expiresAfter - the time after which a JWT for VAPID expires.

timeUnit - the unit of the given expiresAfter.

Returns:

this object.

Throws:

IllegalStateException - if the methods for specifying expiration time are called more than once.

expirationTime

public VAPIDJWTParam.Builder expirationTime(Instant expirationTime)

Specifies the time at which a JWT for VAPID expires.

Typically, the specified expiration time is used as an "exp" (Expiry) claim.

Parameters:

expirationTime - the time at which a JWT for VAPID expires.

Returns:

this object.

Throws:

IllegalStateException - if the methods for specifying expiration time are called more than once.

subject

public VAPIDJWTParam.Builder subject(String subject)

Specifies a subject.

Typically, the specified subject is used as a "sub" (Subject) claim.

Parameters:

subject - a subject.

Returns:

this object.

additionalClaim

public VAPIDJWTParam.Builder additionalClaim(String name,
                                             Object value)

Specifies an additional claim.

Typically, the specified entry is used as a claim in a token's payload.

The following names are "reserved". So if one of these names is given, an IllegalArgumentException is thrown.

• "aud" - this claim should be specified via resourceURL(URL) or resourceURLString(String).
• "exp" - this claim should be specified via expirationTime(Instant) or expiresAfter(int, TimeUnit).
• "sub" - this claim should be specified via subject(String)

Parameters:

name - the name of an additional claim.

value - the value of an additional claim.

Returns:

this object.

Throws:

IllegalArgumentException - if one of the "reserved" names is given.

build

public VAPIDJWTParam build()

Creates a new VAPIDJWTParam.

Returns:

a new VAPIDJWTParam.

Throws:

IllegalStateException - if the resource URL and the expiration time aren't specified.

buildWithDefault

public VAPIDJWTParam buildWithDefault()

Creates a new VAPIDJWTParam. If the expiration time isn't specified, the value is set to 3 minutes.

Returns:

a new VAPIDJWTParam.

Throws:

IllegalStateException - if the resource URL isn't specified.