Class IdTokenVerifier.Builder

java.lang.Object
com.google.api.client.auth.openidconnect.IdTokenVerifier.Builder
Enclosing class:
IdTokenVerifier

@Beta public static class IdTokenVerifier.Builder extends Object
Beta
Builder for IdTokenVerifier.

Implementation is not thread-safe.

Since:
1.16
  • Field Details

    • clock

      com.google.api.client.util.Clock clock
      Clock.
    • certificatesLocation

      String certificatesLocation
    • environment

      Environment environment
      wrapper for environment variables
    • acceptableTimeSkewSeconds

      long acceptableTimeSkewSeconds
      Seconds of time skew to accept when verifying time.
    • issuers

      Collection<String> issuers
      Collection of equivalent expected issuers or null to suppress the issuer check.
    • audience

      Collection<String> audience
      List of trusted audience client IDs or null to suppress the audience check.
    • httpTransportFactory

      HttpTransportFactory httpTransportFactory
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • build

      public IdTokenVerifier build()
      Builds a new instance of IdTokenVerifier.
    • getClock

      public final com.google.api.client.util.Clock getClock()
      Returns the clock.
    • setClock

      public IdTokenVerifier.Builder setClock(com.google.api.client.util.Clock clock)
      Sets the clock.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getIssuer

      public final String getIssuer()
      Returns the first of equivalent expected issuers or null if issuer check suppressed.
    • setIssuer

      public IdTokenVerifier.Builder setIssuer(String issuer)
      Sets the expected issuer or null to suppress the issuer check.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • setCertificatesLocation

      public IdTokenVerifier.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
    • getIssuers

      public final Collection<String> getIssuers()
      Returns the equivalent expected issuers or null if issuer check suppressed.
      Since:
      1.21.0
    • setIssuers

      public IdTokenVerifier.Builder setIssuers(Collection<String> issuers)
      Sets the list of equivalent expected issuers or null to suppress the issuer check. Typically only a single issuer should be used, but multiple may be specified to support an issuer transitioning to a new string. The collection must not be empty.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

      Since:
      1.21.0
    • getAudience

      public final Collection<String> getAudience()
      Returns the list of trusted audience client IDs or null to suppress the audience check.
    • setAudience

      public IdTokenVerifier.Builder setAudience(Collection<String> audience)
      Sets the list of trusted audience client IDs or null to suppress the audience check.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getAcceptableTimeSkewSeconds

      public final long getAcceptableTimeSkewSeconds()
      Returns the seconds of time skew to accept when verifying time.
    • setAcceptableTimeSkewSeconds

      public IdTokenVerifier.Builder setAcceptableTimeSkewSeconds(long acceptableTimeSkewSeconds)
      Sets the seconds of time skew to accept when verifying time (default is IdTokenVerifier.DEFAULT_TIME_SKEW_SECONDS).

      It must be greater or equal to zero.

      Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

    • getEnvironment

      final Environment getEnvironment()
      Returns an instance of the Environment
    • setEnvironment

      IdTokenVerifier.Builder setEnvironment(Environment environment)
      Sets the environment. Used mostly for testing
    • setHttpTransportFactory

      public IdTokenVerifier.Builder setHttpTransportFactory(HttpTransportFactory httpTransportFactory)
      Sets 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