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

Interface for authentication state. It tell broker whether the authentication is completed or not, if completed, what is the AuthRole is.

Constructor Summary

Constructors

Constructor and Description
OneStageAuthenticationState(org.apache.pulsar.common.api.AuthData authData, SocketAddress remoteAddress, SSLSession sslSession, AuthenticationProvider provider)
OneStageAuthenticationState(javax.servlet.http.HttpServletRequest request, AuthenticationProvider provider)

Method Summary

Modifier and Type	Method and Description
org.apache.pulsar.common.api.AuthData	authenticate(org.apache.pulsar.common.api.AuthData authData) Challenge passed in auth data and get response data.
AuthenticationDataSource	getAuthDataSource() Return AuthenticationDataSource.
String	getAuthRole() After the authentication between client and broker completed, get authentication role represent for the client.
boolean	isComplete() Whether the authentication is completed or not.

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, getStateId, isExpired, refreshAuthentication

Constructor Detail

OneStageAuthenticationState

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

Throws:

AuthenticationException

OneStageAuthenticationState

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

Throws:

AuthenticationException

Method Detail

getAuthRole

public String getAuthRole()

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

getAuthDataSource

public AuthenticationDataSource getAuthDataSource()

Description copied from interface: AuthenticationState

Return AuthenticationDataSource.

Specified by:

getAuthDataSource in interface AuthenticationState

authenticate

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

Description copied from interface: AuthenticationState

Challenge passed in auth data and get response data.

Specified by:

authenticate in interface AuthenticationState

isComplete

public boolean isComplete()

Description copied from interface: AuthenticationState

Whether the authentication is completed or not.

Specified by:

isComplete in interface AuthenticationState