Package com.google.auth.oauth2

Class UserAuthorizer.TokenResponseWithConfig

java.lang.Object

com.google.auth.oauth2.UserAuthorizer.TokenResponseWithConfig

Enclosing class:

UserAuthorizer

public static class UserAuthorizer.TokenResponseWithConfig
extends java.lang.Object

Represents the response from an OAuth token exchange, including configuration details used to initiate the flow.

This response can be used to initialize the following credentials types:

 // UserCredentials when Google is the identity provider:
 UserCredentials userCredentials = UserCredentials.newBuilder()
     .setHttpTransportFactory(tokenResponseWithConfig.getHttpTransportFactory())
     .setClientId(tokenResponseWithConfig.getClientId())
     .setClientSecret(tokenResponseWithConfig.getClientSecret())
     .setAccessToken(tokenResponseWithConfig.getAccessToken())
     .setRefreshToken(tokenResponseWithConfig.getRefreshToken())
     .setTokenServerUri(tokenResponseWithConfig.getTokenServerUri())
     .build();

 // ExternalAccountAuthorizedUserCredentials when using Workforce Identity Federation:
 ExternalAccountAuthorizedUserCredentials externalAccountAuthorizedUserCredentials =
     ExternalAccountAuthorizedUserCredentials.newBuilder()
         .setHttpTransportFactory(tokenResponseWithConfig.getHttpTransportFactory())
         .setClientId(tokenResponseWithConfig.getClientId())
         .setClientSecret(tokenResponseWithConfig.getClientSecret())
         .setAccessToken(tokenResponseWithConfig.getAccessToken())
         .setRefreshToken(tokenResponseWithConfig.getRefreshToken())
         .setTokenUrl(tokenResponseWithConfig.getTokenServerUri().toURL().toString())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	UserAuthorizer.TokenResponseWithConfig.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private AccessToken	accessToken
private java.lang.String	clientId
private java.lang.String	clientSecret
private HttpTransportFactory	httpTransportFactory
private java.lang.String	refreshToken
private java.net.URI	tokenServerUri

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TokenResponseWithConfig(UserAuthorizer.TokenResponseWithConfig.Builder builder)

Method Summary

Modifier and Type	Method	Description
AccessToken	getAccessToken()	Returns the access token obtained from the token exchange.
java.lang.String	getClientId()	Returns the OAuth 2.0 client ID used.
java.lang.String	getClientSecret()	Returns the OAuth 2.0 client secret used.
HttpTransportFactory	getHttpTransportFactory()	Returns the HTTP transport factory used.
java.lang.String	getRefreshToken()	Returns the refresh token obtained from the token exchange, if available.
java.net.URI	getTokenServerUri()	Returns the URI of the token server used.
(package private) static UserAuthorizer.TokenResponseWithConfig.Builder	newBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

clientId

private final java.lang.String clientId

clientSecret

private final java.lang.String clientSecret

refreshToken

private final java.lang.String refreshToken

accessToken

private final AccessToken accessToken

tokenServerUri

private java.net.URI tokenServerUri

httpTransportFactory

private final HttpTransportFactory httpTransportFactory

Constructor Detail

TokenResponseWithConfig

private TokenResponseWithConfig(UserAuthorizer.TokenResponseWithConfig.Builder builder)

Method Detail

getClientId

public java.lang.String getClientId()

Returns the OAuth 2.0 client ID used.

Returns:

The client ID.

getClientSecret

public java.lang.String getClientSecret()

Returns the OAuth 2.0 client secret used.

Returns:

The client secret.

getAccessToken

public AccessToken getAccessToken()

Returns the access token obtained from the token exchange.

Returns:

The access token.

getHttpTransportFactory

public HttpTransportFactory getHttpTransportFactory()

Returns the HTTP transport factory used.

Returns:

The HTTP transport factory.

getTokenServerUri

public java.net.URI getTokenServerUri()

Returns the URI of the token server used.

Returns:

The token server URI.

getRefreshToken

@Nullable
public java.lang.String getRefreshToken()

Returns the refresh token obtained from the token exchange, if available.

Returns:

The refresh token, or null if not granted.

newBuilder

static UserAuthorizer.TokenResponseWithConfig.Builder newBuilder()