Package org.apache.pulsar.broker.authentication

Class AuthenticationService

java.lang.Object

org.apache.pulsar.broker.authentication.AuthenticationService

All Implemented Interfaces:

Closeable, AutoCloseable

public class AuthenticationService
extends Object
implements Closeable

Authentication service.

Constructor Summary

Constructors

Constructor	Description
AuthenticationService(ServiceConfiguration conf)

Method Summary

Modifier and Type	Method	Description
String	authenticateHttpRequest(javax.servlet.http.HttpServletRequest request)	Deprecated. use authenticateHttpRequest(HttpServletRequest, HttpServletResponse).
boolean	authenticateHttpRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	authenticateHttpRequest(javax.servlet.http.HttpServletRequest request, AuthenticationDataSource authData)	Deprecated. use authenticateHttpRequest(HttpServletRequest, HttpServletResponse)
void	close()
Optional<String>	getAnonymousUserRole()
AuthenticationProvider	getAuthenticationProvider(String authMethodName)

Methods inherited from class java.lang.Object

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

Constructor Details

AuthenticationService

public AuthenticationService(ServiceConfiguration conf)
                      throws PulsarServerException

Throws:

PulsarServerException

Method Details

authenticateHttpRequest

public boolean authenticateHttpRequest(javax.servlet.http.HttpServletRequest request,
 javax.servlet.http.HttpServletResponse response)
                                throws Exception

Throws:

Exception

authenticateHttpRequest

@Deprecated(since="3.0.0")
public String authenticateHttpRequest(javax.servlet.http.HttpServletRequest request,
 AuthenticationDataSource authData)
                               throws AuthenticationException

Deprecated.

use authenticateHttpRequest(HttpServletRequest, HttpServletResponse)

Throws:

AuthenticationException

authenticateHttpRequest

@Deprecated
public String authenticateHttpRequest(javax.servlet.http.HttpServletRequest request)
                               throws AuthenticationException

Deprecated.

use authenticateHttpRequest(HttpServletRequest, HttpServletResponse).

Mark this function as deprecated, it is recommended to use a method with the AuthenticationDataSource signature to implement it.

Throws:

AuthenticationException

getAuthenticationProvider

public AuthenticationProvider getAuthenticationProvider(String authMethodName)

getAnonymousUserRole

public Optional<String> getAnonymousUserRole()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException