Package org.apache.pulsar.broker.authentication

Class SaslAuthenticationState

java.lang.Object

org.apache.pulsar.broker.authentication.SaslAuthenticationState

All Implemented Interfaces:

org.apache.pulsar.broker.authentication.AuthenticationState

public class SaslAuthenticationState
extends Object
implements org.apache.pulsar.broker.authentication.AuthenticationState

Interface for authentication state. It is basically holding the the authentication state. It tell broker whether the authentication is completed or not,

Constructor Summary

Constructors

Constructor	Description
SaslAuthenticationState(PulsarSaslServer server)

Method Summary

Modifier and Type	Method	Description
org.apache.pulsar.common.api.AuthData	authenticate(org.apache.pulsar.common.api.AuthData authData)	Returns null if authentication has completed, and no auth data is required to send back to client.
org.apache.pulsar.broker.authentication.AuthenticationDataSource	getAuthDataSource()
String	getAuthRole()
long	getStateId()
boolean	isComplete()

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

authenticateAsync, isExpired, refreshAuthentication

Constructor Details

SaslAuthenticationState

public SaslAuthenticationState(PulsarSaslServer server)

Method Details

getAuthRole

public String getAuthRole()

Specified by:

getAuthRole in interface org.apache.pulsar.broker.authentication.AuthenticationState

getAuthDataSource

public org.apache.pulsar.broker.authentication.AuthenticationDataSource getAuthDataSource()

Specified by:

getAuthDataSource in interface org.apache.pulsar.broker.authentication.AuthenticationState

isComplete

public boolean isComplete()

Specified by:

isComplete in interface org.apache.pulsar.broker.authentication.AuthenticationState

authenticate

public org.apache.pulsar.common.api.AuthData authenticate(org.apache.pulsar.common.api.AuthData authData)
                                                   throws AuthenticationException

Returns null if authentication has completed, and no auth data is required to send back to client. Do auth and Returns the auth data back to client, if authentication has not completed.

Specified by:

authenticate in interface org.apache.pulsar.broker.authentication.AuthenticationState

Throws:

AuthenticationException

getStateId

public long getStateId()

Specified by:

getStateId in interface org.apache.pulsar.broker.authentication.AuthenticationState