Package com.google.auth.oauth2

Class StsRequestHandler

java.lang.Object

com.google.auth.oauth2.StsRequestHandler

public final class StsRequestHandler
extends Object

Implements the OAuth 2.0 token exchange based on RFC 8693.

This class handles the process of exchanging one type of token for another using the Security Token Service (STS). It constructs and sends the token exchange request to the STS endpoint and parses the response to create an StsTokenExchangeResponse object.

Use the newBuilder(String, StsTokenExchangeRequest, HttpRequestFactory) method to create a new builder for constructing an instance of this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StsRequestHandler.Builder

Method Summary

Modifier and Type	Method	Description
StsTokenExchangeResponse	exchangeToken()	Exchanges the provided token for another type of token based on the RFC 8693 spec.
static StsRequestHandler.Builder	newBuilder(String tokenExchangeEndpoint, StsTokenExchangeRequest stsTokenExchangeRequest, com.google.api.client.http.HttpRequestFactory httpRequestFactory)	Returns a new builder for creating an instance of StsRequestHandler.

Methods inherited from class java.lang.Object

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

Method Details

newBuilder

public static StsRequestHandler.Builder newBuilder(String tokenExchangeEndpoint,
 StsTokenExchangeRequest stsTokenExchangeRequest,
 com.google.api.client.http.HttpRequestFactory httpRequestFactory)

Returns a new builder for creating an instance of StsRequestHandler.

Parameters:

tokenExchangeEndpoint - The STS token exchange endpoint.

stsTokenExchangeRequest - The STS token exchange request.

httpRequestFactory - The HTTP request factory to use for sending the request.

Returns:

A new builder instance.

exchangeToken

public StsTokenExchangeResponse exchangeToken()
                                       throws IOException

Exchanges the provided token for another type of token based on the RFC 8693 spec.

Throws:

IOException