Package com.okta.jwt.impl.jjwt

Class JjwtAccessTokenVerifierBuilder

java.lang.Object

com.okta.jwt.impl.jjwt.JjwtAccessTokenVerifierBuilder

All Implemented Interfaces:

AccessTokenVerifier.Builder, VerifierBuilderSupport<AccessTokenVerifier.Builder,AccessTokenVerifier>

public final class JjwtAccessTokenVerifierBuilder
extends Object
implements AccessTokenVerifier.Builder

Classes in this `impl` implementation package may change in NON backward compatible way, and should ONLY be used as a "runtime" dependency.

Constructor Summary

Constructors

Constructor	Description
JjwtAccessTokenVerifierBuilder()

Method Summary

Modifier and Type	Method	Description
AccessTokenVerifier	build()	Constructs a JWT Verifier.
boolean	equals(Object o)
Clock	getClock()
Duration	getMaxHttpRetryElapsed()
boolean	getPreloadSigningKeys()
String	getProxyHost()
String	getProxyPassword()
int	getProxyPort()
String	getProxyUsername()
int	getRetryMaxAttempts()
int	hashCode()
protected HttpClient	httpClient()
protected String	resolveKeysEndpoint(String issuer)
protected AccessTokenVerifier.Builder	self()
AccessTokenVerifier.Builder	setAudience(String audience)	Sets the audience the verifier will expect.
AccessTokenVerifier.Builder	setClock(Clock clock)	Sets the clock the verifier will use for evaluating token expiration.
AccessTokenVerifier.Builder	setConnectionTimeout(Duration connectionTimeout)	Sets the connectionTimeout for the verifier.
AccessTokenVerifier.Builder	setIssuer(String issuer)	Sets the issuer the verifier will expect.
AccessTokenVerifier.Builder	setLeeway(Duration leeway)	Sets the leeway the verifier will allow.
AccessTokenVerifier.Builder	setPreloadSigningKeys(boolean preloadSigningKeys)	Sets the preloadSigningKeys the verifier will use to determine if it needs to prefetch Signing keys into cache at boot time.
AccessTokenVerifier.Builder	setProxyHost(String proxyHost)	Sets the proxy host used for the configured HTTP proxy.
AccessTokenVerifier.Builder	setProxyPassword(String proxyPassword)	Sets the proxy password used for the configured HTTP proxy.
AccessTokenVerifier.Builder	setProxyPort(int proxyPort)	Sets the proxy port used for the configured HTTP proxy.
AccessTokenVerifier.Builder	setProxyUsername(String proxyUsername)	Sets the proxy username used for the configured HTTP proxy.
AccessTokenVerifier.Builder	setRetryMaxAttempts(int retryMaxAttempts)	Sets the retryMaxAttempts the verifier will allow when making HTTP requests to the "keys" endpoint.
AccessTokenVerifier.Builder	setRetryMaxElapsed(Duration retryMaxElapsed)	Sets the retryMaxElapsed the verifier will allow when making HTTP requests to the "keys" endpoint.
protected io.jsonwebtoken.SigningKeyResolver	signingKeyResolver()
protected void	validate()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.jwt.VerifierBuilderSupport

setClock, setConnectionTimeout, setIssuer, setLeeway, setPreloadSigningKeys, setProxyHost, setProxyPassword, setProxyPort, setProxyUsername, setRetryMaxAttempts, setRetryMaxElapsed

Constructor Details

JjwtAccessTokenVerifierBuilder

public JjwtAccessTokenVerifierBuilder()

Method Details

setAudience

public AccessTokenVerifier.Builder setAudience(String audience)

Description copied from interface: AccessTokenVerifier.Builder

Sets the audience the verifier will expect. Default implementation, uses "api://default" as the default value.

Specified by:

setAudience in interface AccessTokenVerifier.Builder

Parameters:

audience - Audience

Returns:

a reference to the current builder for use in method chaining

validate

protected void validate()

build

public AccessTokenVerifier build()

Description copied from interface: VerifierBuilderSupport

Constructs a JWT Verifier.

Specified by:

build in interface VerifierBuilderSupport<AccessTokenVerifier.Builder,AccessTokenVerifier>

Returns:

A JWT Verifier

setIssuer

public AccessTokenVerifier.Builder setIssuer(String issuer)

Description copied from interface: VerifierBuilderSupport

Sets the issuer the verifier will expect.

Specified by:

setIssuer in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

issuer - Issuer URL

Returns:

a reference to the current builder for use in method chaining

setLeeway

public AccessTokenVerifier.Builder setLeeway(Duration leeway)

Description copied from interface: VerifierBuilderSupport

Sets the leeway the verifier will allow.

Specified by:

setLeeway in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

leeway - clock skew leeway

Returns:

a reference to the current builder for use in method chaining

setConnectionTimeout

public AccessTokenVerifier.Builder setConnectionTimeout(Duration connectionTimeout)

Description copied from interface: VerifierBuilderSupport

Sets the connectionTimeout for the verifier.

Specified by:

setConnectionTimeout in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

connectionTimeout - connection timeout

Returns:

a reference to the current builder for use in method chaining

getProxyHost

public String getProxyHost()

setProxyHost

public AccessTokenVerifier.Builder setProxyHost(String proxyHost)

Description copied from interface: VerifierBuilderSupport

Sets the proxy host used for the configured HTTP proxy.

Specified by:

setProxyHost in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

proxyHost - the proxy host used for the configured HTTP proxy

Returns:

a reference to the current builder for use in method chaining

getProxyPort

public int getProxyPort()

setProxyPort

public AccessTokenVerifier.Builder setProxyPort(int proxyPort)

Description copied from interface: VerifierBuilderSupport

Sets the proxy port used for the configured HTTP proxy.

Specified by:

setProxyPort in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

proxyPort - the proxy port used for the configured HTTP proxy

Returns:

a reference to the current builder for use in method chaining

getProxyUsername

public String getProxyUsername()

setProxyUsername

public AccessTokenVerifier.Builder setProxyUsername(String proxyUsername)

Description copied from interface: VerifierBuilderSupport

Sets the proxy username used for the configured HTTP proxy.

Specified by:

setProxyUsername in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

proxyUsername - the proxy username used for the configured HTTP proxy

Returns:

a reference to the current builder for use in method chaining

getProxyPassword

public String getProxyPassword()

setProxyPassword

public AccessTokenVerifier.Builder setProxyPassword(String proxyPassword)

Description copied from interface: VerifierBuilderSupport

Sets the proxy password used for the configured HTTP proxy.

Specified by:

setProxyPassword in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

proxyPassword - the proxy password used for the configured HTTP proxy

Returns:

a reference to the current builder for use in method chaining

getRetryMaxAttempts

public int getRetryMaxAttempts()

setRetryMaxAttempts

public AccessTokenVerifier.Builder setRetryMaxAttempts(int retryMaxAttempts)

Description copied from interface: VerifierBuilderSupport

Sets the retryMaxAttempts the verifier will allow when making HTTP requests to the "keys" endpoint.

Specified by:

setRetryMaxAttempts in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

retryMaxAttempts - The maximum number of times to retry HTTP requests

Returns:

a reference to the current builder for use in method chaining

getMaxHttpRetryElapsed

public Duration getMaxHttpRetryElapsed()

setRetryMaxElapsed

public AccessTokenVerifier.Builder setRetryMaxElapsed(Duration retryMaxElapsed)

Description copied from interface: VerifierBuilderSupport

Sets the retryMaxElapsed the verifier will allow when making HTTP requests to the "keys" endpoint.

Specified by:

setRetryMaxElapsed in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

retryMaxElapsed - the max duration for the total of HTTP request

Returns:

a reference to the current builder for use in method chaining

getClock

public Clock getClock()

setClock

public AccessTokenVerifier.Builder setClock(Clock clock)

Description copied from interface: VerifierBuilderSupport

Sets the clock the verifier will use for evaluating token expiration.

Specified by:

setClock in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

clock - specify an alternate clock, such as fixed or offset to be used during testing

Returns:

a reference to the current builder for use in method chaining

getPreloadSigningKeys

public boolean getPreloadSigningKeys()

setPreloadSigningKeys

public AccessTokenVerifier.Builder setPreloadSigningKeys(boolean preloadSigningKeys)

Description copied from interface: VerifierBuilderSupport

Sets the preloadSigningKeys the verifier will use to determine if it needs to prefetch Signing keys into cache at boot time.

Specified by:

setPreloadSigningKeys in interface VerifierBuilderSupport<B extends VerifierBuilderSupport,R>

Parameters:

preloadSigningKeys - specify if we want to prefetch the signing keys from issuer's url at boot time

Returns:

a reference to the current builder for use in method chaining

self

protected AccessTokenVerifier.Builder self()

resolveKeysEndpoint

protected String resolveKeysEndpoint(String issuer)

signingKeyResolver

protected io.jsonwebtoken.SigningKeyResolver signingKeyResolver()

httpClient

protected HttpClient httpClient()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object