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

Class DefaultMetadataResolver

java.lang.Object

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

All Implemented Interfaces:

MetadataResolver

public class DefaultMetadataResolver
extends Object
implements MetadataResolver

Resolves OAuth 2.0 authorization server metadata as described in RFC 8414.

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
DefaultMetadataResolver(URL metadataUrl)

Method Summary

Modifier and Type	Method	Description
static DefaultMetadataResolver	fromIssuerUrl(URL issuerUrl)	Gets a well-known metadata URL for the given OAuth issuer URL.
static URL	getWellKnownMetadataUrl(URL issuerUrl)	Gets a well-known metadata URL for the given OAuth issuer URL.
Metadata	resolve()	Resolves the authorization metadata.
DefaultMetadataResolver	withConnectTimeout(Duration connectTimeout)
DefaultMetadataResolver	withReadTimeout(Duration readTimeout)

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

DefaultMetadataResolver

public DefaultMetadataResolver(URL metadataUrl)

Method Details

withConnectTimeout

public DefaultMetadataResolver withConnectTimeout(Duration connectTimeout)

withReadTimeout

public DefaultMetadataResolver withReadTimeout(Duration readTimeout)

resolve

public Metadata resolve()
                 throws IOException

Resolves the authorization metadata.

Specified by:

resolve in interface MetadataResolver

Returns:

metadata

Throws:

IOException - if the metadata could not be resolved.

fromIssuerUrl

public static DefaultMetadataResolver fromIssuerUrl(URL issuerUrl)

Gets a well-known metadata URL for the given OAuth issuer URL.

Parameters:

issuerUrl - The authorization server's issuer identifier

Returns:

a resolver

getWellKnownMetadataUrl

public static URL getWellKnownMetadataUrl(URL issuerUrl)

Gets a well-known metadata URL for the given OAuth issuer URL.

Parameters:

issuerUrl - The authorization server's issuer identifier

Returns:

a URL

See Also:

• OAuth Discovery: Obtaining Authorization Server Metadata