Package com.google.api.client.auth.oauth2

Class Credential.Builder

java.lang.Object
com.google.api.client.auth.oauth2.Credential.Builder
Enclosing class:
Credential
public static class Credential.Builder extends Object
Credential builder.

Implementation is not thread-safe.

  • Field Details

    • method

      final Credential.AccessMethod method
      Method of presenting the access token to the resource server (for example BearerToken.AuthorizationHeaderAccessMethod).

    • transport

      com.google.api.client.http.HttpTransport transport
      HTTP transport for executing refresh token request or null if not refreshing tokens.

    • jsonFactory

      com.google.api.client.json.JsonFactory jsonFactory
      JSON factory to use for parsing response for refresh token request or null if not refreshing tokens.

    • tokenServerUrl

      com.google.api.client.http.GenericUrl tokenServerUrl
      Token server URL or null if not refreshing tokens.

    • clock

      com.google.api.client.util.Clock clock
      Clock used for expiration checks.

    • clientAuthentication

      com.google.api.client.http.HttpExecuteInterceptor clientAuthentication
      Client authentication or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor)).

    • requestInitializer

      com.google.api.client.http.HttpRequestInitializer requestInitializer
      HTTP request initializer for refresh token requests to the token server or null for none.

    • refreshListeners

      Collection<CredentialRefreshListener> refreshListeners
      Listeners for refresh token results.

  • Constructor Details

  • Method Details

    • build

      public Credential build()
      Returns a new credential instance.

    • getMethod

      public final Credential.AccessMethod getMethod()
      Returns the method of presenting the access token to the resource server (for example BearerToken.AuthorizationHeaderAccessMethod).

    • getTransport

      public final com.google.api.client.http.HttpTransport getTransport()
      Returns the HTTP transport for executing refresh token request or null if not refreshing tokens.

    • setTransport

      public Credential.Builder setTransport(com.google.api.client.http.HttpTransport transport)
      Sets the HTTP transport for executing refresh token request or null if not refreshing tokens.

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

    • getClock

      public final com.google.api.client.util.Clock getClock()
      Returns the clock to use for expiration checks or Clock.SYSTEM as default.
      Since:
      1.9

    • setClock

      public Credential.Builder setClock(com.google.api.client.util.Clock clock)
      Sets the clock to use for expiration checks.

      The default value is Clock.SYSTEM.

      Since:
      1.9

    • getJsonFactory

      public final com.google.api.client.json.JsonFactory getJsonFactory()
      Returns the JSON factory to use for parsing response for refresh token request or null if not refreshing tokens.

    • setJsonFactory

      public Credential.Builder setJsonFactory(com.google.api.client.json.JsonFactory jsonFactory)
      Sets the JSON factory to use for parsing response for refresh token request or null if not refreshing tokens.

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

    • getTokenServerUrl

      public final com.google.api.client.http.GenericUrl getTokenServerUrl()
      Returns the token server URL or null if not refreshing tokens.

    • setTokenServerUrl

      public Credential.Builder setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)
      Sets the token server URL or null if not refreshing tokens.

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

    • setTokenServerEncodedUrl

      public Credential.Builder setTokenServerEncodedUrl(String tokenServerEncodedUrl)
      Sets the encoded token server URL or null if not refreshing tokens.

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

    • getClientAuthentication

      public final com.google.api.client.http.HttpExecuteInterceptor getClientAuthentication()
      Returns the client authentication or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor)).

    • setClientAuthentication

      public Credential.Builder setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
      Sets the client authentication or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor)).

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

    • getRequestInitializer

      public final com.google.api.client.http.HttpRequestInitializer getRequestInitializer()
      Returns the HTTP request initializer for refresh token requests to the token server or null for none.

    • setRequestInitializer

      public Credential.Builder setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
      Sets the HTTP request initializer for refresh token requests to the token server or null for none.

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

    • addRefreshListener

      public Credential.Builder addRefreshListener(CredentialRefreshListener refreshListener)
      Adds a listener for refresh token results.

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

      Parameters:
      refreshListener - refresh listener

    • getRefreshListeners

      public final Collection<CredentialRefreshListener> getRefreshListeners()
      Returns the listeners for refresh token results.

    • setRefreshListeners

      public Credential.Builder setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)
      Sets the listeners for refresh token results.

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