io.ballerina.messaging.broker.auth.authorization.provider

Class FileBasedUserStore

java.lang.Object

io.ballerina.messaging.broker.auth.authorization.provider.FileBasedUserStore

All Implemented Interfaces:

UserStore

public class FileBasedUserStore
extends Object
implements UserStore

This class implements @UserStore to connect to file based user store.

Constructor Summary

Constructors

Constructor and Description
FileBasedUserStore()

Method Summary

Modifier and Type	Method and Description
AuthResult	authenticate(String username, char... credentials) Authenticate given user with credentials.
Set<String>	getUserGroupsList(String userName) Retrieve the list of userRegistry for given username.
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

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBasedUserStore

public FileBasedUserStore()

Method Detail

initialize

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

Description copied from interface: UserStore

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

Specified by:

initialize in interface UserStore

Parameters:

startupContext - the startup context provides registered services for authorizer

properties - user store properties

Throws:

Exception

authenticate

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

Authenticate given user with credentials.

Specified by:

authenticate in interface UserStore

Parameters:

username - userName

credentials - Credentials

Returns:

Authentication result

Throws:

AuthException - Exception throws when authentication failed.

isUserExists

public boolean isUserExists(String username)

Description copied from interface: UserStore

Verify given username against underlying user store

Specified by:

isUserExists in interface UserStore

Parameters:

username - username to verify

Returns:

true or false based on the verification

getUserGroupsList

public Set<String> getUserGroupsList(String userName)

Retrieve the list of userRegistry for given username.

Specified by:

getUserGroupsList in interface UserStore

Parameters:

userName - user name

Returns:

List of roles