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

Class TokenClient

java.lang.Object

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

All Implemented Interfaces:

AutoCloseable, ClientCredentialsExchanger

public class TokenClient
extends Object
implements ClientCredentialsExchanger

A client for an OAuth 2.0 token endpoint.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	DEFAULT_CONNECT_TIMEOUT_IN_SECONDS
protected static final int	DEFAULT_READ_TIMEOUT_IN_SECONDS

Constructor Summary

Constructors

Constructor	Description
TokenClient(URL tokenUrl)

Method Summary

Modifier and Type	Method	Description
void	close()
TokenResult	exchangeClientCredentials(ClientCredentialsExchangeRequest req)	Performs a token exchange using client credentials.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CONNECT_TIMEOUT_IN_SECONDS

protected static final int DEFAULT_CONNECT_TIMEOUT_IN_SECONDS

See Also:

• Constant Field Values

DEFAULT_READ_TIMEOUT_IN_SECONDS

protected static final int DEFAULT_READ_TIMEOUT_IN_SECONDS

See Also:

• Constant Field Values

Constructor Details

TokenClient

public TokenClient(URL tokenUrl)

Method Details

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception

exchangeClientCredentials

public TokenResult exchangeClientCredentials(ClientCredentialsExchangeRequest req)
                                      throws TokenExchangeException,
IOException

Performs a token exchange using client credentials.

Specified by:

exchangeClientCredentials in interface ClientCredentialsExchanger

Parameters:

req - the client credentials request details.

Returns:

a token result

Throws:

TokenExchangeException

IOException - if a general IO error occurred.