com.google.auth.oauth2

Class TokenVerifier.Builder

java.lang.Object

com.google.auth.oauth2.TokenVerifier.Builder

Enclosing class:

TokenVerifier

public static class TokenVerifier.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
TokenVerifier	build() Build the custom TokenVerifier for verifying tokens.
TokenVerifier.Builder	setAudience(String audience) Set a target audience to verify.
TokenVerifier.Builder	setCertificatesLocation(String certificatesLocation) Override the location URL that contains published public keys.
TokenVerifier.Builder	setClock(com.google.api.client.util.Clock clock) Set the clock for checking token expiry.
TokenVerifier.Builder	setHttpTransportFactory(HttpTransportFactory httpTransportFactory) Set the HttpTransportFactory used for requesting public keys from the certificate URL.
TokenVerifier.Builder	setIssuer(String issuer) Set the issuer to verify.
TokenVerifier.Builder	setPublicKey(PublicKey publicKey) Set the PublicKey for verifying the signature.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setAudience

public TokenVerifier.Builder setAudience(String audience)

Set a target audience to verify.

Parameters:

audience - the audience claim to verify

Returns:

the builder

setCertificatesLocation

public TokenVerifier.Builder setCertificatesLocation(String certificatesLocation)

Override the location URL that contains published public keys. Defaults to well-known Google locations.

Parameters:

certificatesLocation - URL to published public keys

Returns:

the builder

setIssuer

public TokenVerifier.Builder setIssuer(String issuer)

Set the issuer to verify.

Parameters:

issuer - the issuer claim to verify

Returns:

the builder

setPublicKey

public TokenVerifier.Builder setPublicKey(PublicKey publicKey)

Set the PublicKey for verifying the signature. This will ignore the key id from the JWT token header.

Parameters:

publicKey - the public key to validate the signature

Returns:

the builder

setClock

public TokenVerifier.Builder setClock(com.google.api.client.util.Clock clock)

Set the clock for checking token expiry. Used for testing.

Parameters:

clock - the clock to use. Defaults to the system clock

Returns:

the builder

setHttpTransportFactory

public TokenVerifier.Builder setHttpTransportFactory(HttpTransportFactory httpTransportFactory)

Set the HttpTransportFactory used for requesting public keys from the certificate URL. Used mostly for testing.

Parameters:

httpTransportFactory - the HttpTransportFactory used to build certificate URL requests

Returns:

the builder

build

public TokenVerifier build()

Build the custom TokenVerifier for verifying tokens.

Returns:

the customized TokenVerifier