Module com.zerodeplibs.webpush

Package com.zerodeplibs.webpush

Class VAPIDKeyPairs

java.lang.Object

com.zerodeplibs.webpush.VAPIDKeyPairs

public class VAPIDKeyPairs
extends Object

Static factory methods used to create instances of VAPIDKeyPair.

Thread Safety:

• Instances obtained through of(PrivateKeySource, PublicKeySource, BiFunction) are thread-safe only if an instance obtained from jwtGeneratorFactory is thread-safe.
• If you use of(PrivateKeySource, PublicKeySource) without sub-modules for VAPIDJWTGenerator, obtained instances are thread-safe. Because the default implementation of VAPIDJWTGenerator is thread-safe.
• If you use of(PrivateKeySource, PublicKeySource) with a sub-module provided by zerodep-web-push-java-ext-jwt, obtained instances are thread-safe.

Author:

Tomoki Sato

Method Summary

Modifier and Type	Method	Description
static VAPIDKeyPair	of(PrivateKeySource privateKeySource, PublicKeySource publicKeySource)	Creates a new VAPIDKeyPair with the given private key source and the given public key source.
static VAPIDKeyPair	of(PrivateKeySource privateKeySource, PublicKeySource publicKeySource, BiFunction<ECPrivateKey,ECPublicKey,VAPIDJWTGenerator> jwtGeneratorFactory)	Creates a new VAPIDKeyPair with the given private key source, the given public key source and the given factory for VAPIDJWTGenerator.

Methods inherited from class java.lang.Object

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

Method Detail

of

public static VAPIDKeyPair of(PrivateKeySource privateKeySource,
                              PublicKeySource publicKeySource,
                              BiFunction<ECPrivateKey,ECPublicKey,VAPIDJWTGenerator> jwtGeneratorFactory)

Creates a new VAPIDKeyPair with the given private key source, the given public key source and the given factory for VAPIDJWTGenerator.

Parameters:

privateKeySource - a private key source.

publicKeySource - a public key source.

jwtGeneratorFactory - a factory for VAPIDJWTGenerator.

Returns:

a new VAPIDKeyPair

Throws:

InvalidECPublicKeyException - if the public key extracted from the given public key source is invalid.

of

public static VAPIDKeyPair of(PrivateKeySource privateKeySource,
                              PublicKeySource publicKeySource)

Creates a new VAPIDKeyPair with the given private key source and the given public key source.

The implementation of VAPIDJWTGenerator can be provided by one of the sub-modules (zerodep-web-push-java-ext-jwt) on your classpath. If such sub-modules don't exist, the default implementation (created by DefaultVAPIDJWTGeneratorFactory) is used.

Parameters:

privateKeySource - a private key source.

publicKeySource - a public key source.

Returns:

a new VAPIDKeyPair

Throws:

InvalidECPublicKeyException - if the public key extracted from the given public key source is invalid.

See Also:

DefaultVAPIDJWTGeneratorFactory