Package org.apache.kafka.common.security.oauthbearer.secured

Class HttpAccessTokenRetriever

java.lang.Object

org.apache.kafka.common.security.oauthbearer.secured.HttpAccessTokenRetriever

All Implemented Interfaces:

Closeable, AutoCloseable, AccessTokenRetriever, Initable

public class HttpAccessTokenRetriever
extends Object
implements AccessTokenRetriever

HttpAccessTokenRetriever is an AccessTokenRetriever that will communicate with an OAuth/OIDC provider directly via HTTP to post client credentials (OAuthBearerLoginCallbackHandler.CLIENT_ID_CONFIG/OAuthBearerLoginCallbackHandler.CLIENT_SECRET_CONFIG) to a publicized token endpoint URL (SaslConfigs.SASL_OAUTHBEARER_TOKEN_ENDPOINT_URL).

See Also:

• AccessTokenRetriever
• OAuthBearerLoginCallbackHandler.CLIENT_ID_CONFIG
• OAuthBearerLoginCallbackHandler.CLIENT_SECRET_CONFIG
• OAuthBearerLoginCallbackHandler.SCOPE_CONFIG
• SaslConfigs.SASL_OAUTHBEARER_TOKEN_ENDPOINT_URL

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORIZATION_HEADER

Constructor Summary

Constructors

Constructor	Description
HttpAccessTokenRetriever(String clientId, String clientSecret, String scope, SSLSocketFactory sslSocketFactory, String tokenEndpointUrl, long loginRetryBackoffMs, long loginRetryBackoffMaxMs, Integer loginConnectTimeoutMs, Integer loginReadTimeoutMs)

Method Summary

Modifier and Type	Method	Description
static String	post(HttpURLConnection con, Map<String,String> headers, String requestBody, Integer connectTimeoutMs, Integer readTimeoutMs)
String	retrieve()	Retrieves a JWT access token in its serialized three-part form.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.kafka.common.security.oauthbearer.secured.AccessTokenRetriever

close

Methods inherited from interface org.apache.kafka.common.security.oauthbearer.secured.Initable

init

Field Details

AUTHORIZATION_HEADER

public static final String AUTHORIZATION_HEADER

See Also:

• Constant Field Values

Constructor Details

HttpAccessTokenRetriever

public HttpAccessTokenRetriever(String clientId,
 String clientSecret,
 String scope,
 SSLSocketFactory sslSocketFactory,
 String tokenEndpointUrl,
 long loginRetryBackoffMs,
 long loginRetryBackoffMaxMs,
 Integer loginConnectTimeoutMs,
 Integer loginReadTimeoutMs)

Method Details

retrieve

public String retrieve()
                throws IOException

Retrieves a JWT access token in its serialized three-part form. The implementation is free to determine how it should be retrieved but should not perform validation on the result. Note: This is a blocking function and callers should be aware that the implementation communicates over a network. The facility in the LoginModule from which this is ultimately called does not provide an asynchronous approach.

Specified by:

retrieve in interface AccessTokenRetriever

Returns:

Non-null JWT access token string

Throws:

IOException - Thrown on errors related to IO during retrieval

post

public static String post(HttpURLConnection con,
 Map<String,String> headers,
 String requestBody,
 Integer connectTimeoutMs,
 Integer readTimeoutMs)
                   throws IOException,
UnretryableException

Throws:

IOException

UnretryableException