Class TokenVerifier.Builder (1.28.0)

Version latest

• 1.28.0 (latest)
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.1
• 1.20.0
• 1.19.0
• 1.18.0
• 1.7.0
• 1.6.1
• 1.4.0
• 1.3.0

public static class TokenVerifier.Builder

Inheritance

java.lang.Object > TokenVerifier.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

build()

public TokenVerifier build()

Build the custom TokenVerifier for verifying tokens.

Returns
Type	Description
TokenVerifier	the customized TokenVerifier

setAudience(String audience)

public TokenVerifier.Builder setAudience(String audience)

Set a target audience to verify.

Parameter
Name	Description
audience	String the audience claim to verify

Returns
Type	Description
TokenVerifier.Builder	the builder

setCertificatesLocation(String certificatesLocation)

public TokenVerifier.Builder setCertificatesLocation(String certificatesLocation)

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

Parameter
Name	Description
certificatesLocation	String URL to published public keys

Returns
Type	Description
TokenVerifier.Builder	the builder

setClock(Clock clock)

public TokenVerifier.Builder setClock(Clock clock)

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

Parameter
Name	Description
clock	com.google.api.client.util.Clock the clock to use. Defaults to the system clock

Returns
Type	Description
TokenVerifier.Builder	the builder

setHttpTransportFactory(HttpTransportFactory httpTransportFactory)

public TokenVerifier.Builder setHttpTransportFactory(HttpTransportFactory httpTransportFactory)

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

Parameter
Name	Description
httpTransportFactory	HttpTransportFactory the HttpTransportFactory used to build certificate URL requests

Returns
Type	Description
TokenVerifier.Builder	the builder

setIssuer(String issuer)

public TokenVerifier.Builder setIssuer(String issuer)

Set the issuer to verify.

Parameter
Name	Description
issuer	String the issuer claim to verify

Returns
Type	Description
TokenVerifier.Builder	the builder

setPublicKey(PublicKey publicKey)

public TokenVerifier.Builder setPublicKey(PublicKey publicKey)

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

Parameter
Name	Description
publicKey	PublicKey the public key to validate the signature

Returns
Type	Description
TokenVerifier.Builder	the builder