Package org.apache.pulsar.client.impl.auth.oauth2.protocol

Interface ClientCredentialsExchanger

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

TokenClient

public interface ClientCredentialsExchanger
extends AutoCloseable

An interface for exchanging client credentials for an access token.

Method Summary

Modifier and Type	Method	Description
TokenResult	exchangeClientCredentials(ClientCredentialsExchangeRequest req)	Requests an exchange of client credentials for an access token.

Methods inherited from interface java.lang.AutoCloseable

close

Method Details

exchangeClientCredentials

TokenResult exchangeClientCredentials(ClientCredentialsExchangeRequest req)
                               throws TokenExchangeException,
IOException

Requests an exchange of client credentials for an access token.

Parameters:

req - the request details.

Returns:

an access token.

Throws:

TokenExchangeException - if the OAuth server returned a detailed error.

IOException - if a general IO error occurred.