Package org.apache.pulsar.broker.authentication

Class OneStageAuthenticationState

java.lang.Object

org.apache.pulsar.broker.authentication.OneStageAuthenticationState

All Implemented Interfaces:

AuthenticationState

public class OneStageAuthenticationState
extends Object
implements AuthenticationState

A class to track single stage authentication. This class assumes that: 1. authenticateAsync(AuthData) is called once and when the CompletableFuture completes, authentication is complete. 2. Authentication does not expire, so AuthenticationState.isExpired() always returns false.

See AuthenticationState for Pulsar's contract on how this interface is used by Pulsar.

Constructor Summary

Constructors

Constructor	Description
OneStageAuthenticationState(javax.servlet.http.HttpServletRequest request, AuthenticationProvider provider)
OneStageAuthenticationState(org.apache.pulsar.common.api.AuthData authData, SocketAddress remoteAddress, SSLSession sslSession, AuthenticationProvider provider)	Constructor for a OneStageAuthenticationState where there is no authentication performed during initialization.

Method Summary

Modifier and Type	Method	Description
org.apache.pulsar.common.api.AuthData	authenticate(org.apache.pulsar.common.api.AuthData authData)	Deprecated. use authenticateAsync(AuthData)
CompletableFuture<org.apache.pulsar.common.api.AuthData>	authenticateAsync(org.apache.pulsar.common.api.AuthData authData)	Warning: this method is not intended to be called concurrently.
AuthenticationDataSource	getAuthDataSource()	Return AuthenticationDataSource.
String	getAuthRole()	After the authentication between client and broker completed, get authentication role represent for the client.
boolean	isComplete()	Deprecated. rely on result from authenticateAsync(AuthData).

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.broker.authentication.AuthenticationState

getStateId, isExpired, refreshAuthentication

Constructor Details

OneStageAuthenticationState

public OneStageAuthenticationState(org.apache.pulsar.common.api.AuthData authData,
 SocketAddress remoteAddress,
 SSLSession sslSession,
 AuthenticationProvider provider)

Constructor for a OneStageAuthenticationState where there is no authentication performed during initialization.

Parameters:

remoteAddress - - remoteAddress associated with the AuthenticationState

sslSession - - sslSession associated with the AuthenticationState

provider - - AuthenticationProvider to use to verify AuthData

OneStageAuthenticationState

public OneStageAuthenticationState(javax.servlet.http.HttpServletRequest request,
 AuthenticationProvider provider)

Method Details

getAuthRole

public String getAuthRole()
                   throws AuthenticationException

Description copied from interface: AuthenticationState

After the authentication between client and broker completed, get authentication role represent for the client. It should throw exception if auth not complete.

Specified by:

getAuthRole in interface AuthenticationState

Throws:

AuthenticationException

getAuthDataSource

public AuthenticationDataSource getAuthDataSource()

Description copied from interface: AuthenticationState

Return AuthenticationDataSource.

Specified by:

getAuthDataSource in interface AuthenticationState

authenticateAsync

public CompletableFuture<org.apache.pulsar.common.api.AuthData> authenticateAsync(org.apache.pulsar.common.api.AuthData authData)

Warning: this method is not intended to be called concurrently.

Specified by:

authenticateAsync in interface AuthenticationState

authenticate

@Deprecated(since="3.0.0")
public org.apache.pulsar.common.api.AuthData authenticate(org.apache.pulsar.common.api.AuthData authData)
                                                   throws AuthenticationException

Deprecated.

use authenticateAsync(AuthData)

Description copied from interface: AuthenticationState

Challenge passed in auth data and get response data.

Specified by:

authenticate in interface AuthenticationState

Throws:

AuthenticationException

isComplete

@Deprecated(since="3.0.0")
public boolean isComplete()

Deprecated.

rely on result from authenticateAsync(AuthData). For more information, see the Javadoc for AuthenticationState.isComplete().

Description copied from interface: AuthenticationState

Whether the authentication is completed or not.

Specified by:

isComplete in interface AuthenticationState