io.ballerina.messaging.broker.auth.authorization

Interface UserStore

All Known Implementing Classes:

FileBasedUserStore

public interface UserStore

Interface represents user store for broker users which provide authorization groups..

Method Summary

Modifier and Type	Method and Description
AuthResult	authenticate(String username, char... credentials) Authenticate given user with credentials.
Set<String>	getUserGroupsList(String userId) Get set of user Groups for the user
void	initialize(io.ballerina.messaging.broker.common.StartupContext startupContext, Map<String,String> properties) Initialize authorization strategy based on given auth configuration, user store manager and data source.
boolean	isUserExists(String username) Verify given username against underlying user store

Method Detail

initialize

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

Initialize authorization strategy based on given auth configuration, user store manager and data source.

Parameters:

startupContext - the startup context provides registered services for authorizer

properties - user store properties

Throws:

Exception

getUserGroupsList

Set<String> getUserGroupsList(String userId)
                       throws AuthException

Get set of user Groups for the user

Parameters:

userId - user id

Returns:

set of user groups

Throws:

AuthException - throws if error occurs while authorizing user

authenticate

AuthResult authenticate(String username,
                        char... credentials)
                 throws AuthException

Authenticate given user with credentials.

Parameters:

username - userName

credentials - credentials

Returns:

Authentication result

Throws:

AuthException - Exception throws when authentication failed.

isUserExists

boolean isUserExists(String username)

Verify given username against underlying user store

Parameters:

username - username to verify

Returns:

true or false based on the verification