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

Class AuthenticationOAuth2

java.lang.Object

org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, org.apache.pulsar.client.api.Authentication, org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

public class AuthenticationOAuth2
extends Object
implements org.apache.pulsar.client.api.Authentication, org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

Pulsar client authentication provider based on OAuth 2.0.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTH_METHOD_NAME
static final String	CONFIG_PARAM_TYPE
static final double	EXPIRY_ADJUSTMENT
static final String	TYPE_CLIENT_CREDENTIALS

Constructor Summary

Constructors

Constructor	Description
AuthenticationOAuth2()

Method Summary

Modifier and Type	Method	Description
void	close()
void	configure(String encodedAuthParamString)
void	configure(Map<String,String> authParams)	Deprecated.
org.apache.pulsar.client.api.AuthenticationDataProvider	getAuthData()
String	getAuthMethodName()
void	start()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.pulsar.client.api.Authentication

authenticationStage, getAuthData, newRequestHeader

Field Details

CONFIG_PARAM_TYPE

public static final String CONFIG_PARAM_TYPE

See Also:

• Constant Field Values

TYPE_CLIENT_CREDENTIALS

public static final String TYPE_CLIENT_CREDENTIALS

See Also:

• Constant Field Values

AUTH_METHOD_NAME

public static final String AUTH_METHOD_NAME

See Also:

• Constant Field Values

EXPIRY_ADJUSTMENT

public static final double EXPIRY_ADJUSTMENT

See Also:

• Constant Field Values

Constructor Details

AuthenticationOAuth2

public AuthenticationOAuth2()

Method Details

getAuthMethodName

public String getAuthMethodName()

Specified by:

getAuthMethodName in interface org.apache.pulsar.client.api.Authentication

configure

public void configure(String encodedAuthParamString)

Specified by:

configure in interface org.apache.pulsar.client.api.EncodedAuthenticationParameterSupport

configure

@Deprecated
public void configure(Map<String,String> authParams)

Deprecated.

Specified by:

configure in interface org.apache.pulsar.client.api.Authentication

start

public void start()
           throws org.apache.pulsar.client.api.PulsarClientException

Specified by:

start in interface org.apache.pulsar.client.api.Authentication

Throws:

org.apache.pulsar.client.api.PulsarClientException

getAuthData

public org.apache.pulsar.client.api.AuthenticationDataProvider getAuthData()
                                                                    throws org.apache.pulsar.client.api.PulsarClientException

Specified by:

getAuthData in interface org.apache.pulsar.client.api.Authentication

Throws:

org.apache.pulsar.client.api.PulsarClientException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException