io.ballerina.messaging.broker.auth.authorization

Interface AuthScopeStore

All Known Implementing Classes:

AuthScopeStoreImpl

public interface AuthScopeStore

Representation for auth scope store which provides Mandatory access control (MAC) based authorization model for broker resources.

Method Summary

Modifier and Type	Method and Description
boolean	authorize(String authScopeName, Set<String> userGroups) Authorize user for given resource and action
AuthScope	read(String authScopeName) Read authScope for given scope key.
List<AuthScope>	readAll() Read all authScopes.
void	update(String authScopeName, List<String> userGroups) Update auth

Method Detail

authorize

boolean authorize(String authScopeName,
                  Set<String> userGroups)
           throws AuthServerException,
                  AuthNotFoundException

Authorize user for given resource and action

Parameters:

authScopeName - an authScopeName

userGroups - set of user groups of user

Returns:

is authorized or not

Throws:

AuthServerException - throws if error occurs while authorization

AuthNotFoundException

update

void update(String authScopeName,
            List<String> userGroups)
     throws AuthServerException

Update auth

Parameters:

authScopeName - an authScopeName

userGroups - set of user groups of user

Throws:

AuthServerException - throws if error occurs while granting scope.

read

AuthScope read(String authScopeName)
        throws AuthServerException

Read authScope for given scope key.

Parameters:

authScopeName - an authScopeName

Returns:

auth scope

Throws:

AuthServerException - throws if error occurs while reading scope.

readAll

List<AuthScope> readAll()
                 throws AuthServerException

Read all authScopes.

Returns:

all auth scopes

Throws:

AuthServerException - throws if error occurs while reading scope.