io.ballerina.messaging.broker.auth.authentication

Interface Authenticator

All Known Implementing Classes:

DefaultAuthenticator, JaasAuthenticator

public interface Authenticator

Interface represents the authenticator. This provides ability to extend different authentication strategies for broker auth.

authenticate(String, char[]) is used to authenticate user on given username and credentials.

Method Summary

Modifier and Type	Method and Description
AuthResult	authenticate(String username, char[] password) Authenticate given user based on defined authentication strategy.
void	initialize(io.ballerina.messaging.broker.common.StartupContext startupContext, UserStore userStore, Map<String,Object> properties) Initiate authenticator with startup context.

Method Detail

initialize

void initialize(io.ballerina.messaging.broker.common.StartupContext startupContext,
                UserStore userStore,
                Map<String,Object> properties)
         throws Exception

Initiate authenticator with startup context.

Parameters:

startupContext - the startup context provides registered services for authenticator functionality.

userStore - UserStore to get the user information

properties - set of properties

Throws:

Exception

authenticate

AuthResult authenticate(String username,
                        char[] password)
                 throws AuthException

Authenticate given user based on defined authentication strategy.

Parameters:

username - an username

password - the password of the user

Returns:

authentication result with user information

Throws:

AuthException - if error occurred while authenticating user.