io.ballerina.messaging.broker.auth.authorization

Interface Authorizer

All Known Implementing Classes:

DefaultAuthorizer, NoOpAuthorizer

public interface Authorizer

Interface represents authorization for broker resources. This will provide two functions.

1. authorize 2. authorize by matching resource pattern

Method Summary

Modifier and Type	Method and Description
boolean	addGroupsToResource(String resourceType, String resourceName, String action, List<String> groups) Allow given groups to access the givne resource.
void	addProtectedResource(String resourceType, String resourceName, boolean durable, String owner) Create auth resource.
boolean	authorize(String scopeName, String userId) Authorize user with given scope key.
boolean	authorize(String resourceType, String resource, String action, String userId) Authorize resource with given resource and action.
boolean	changeResourceOwner(String resourceType, String resourceName, String owner) Create auth resource.
void	deleteProtectedResource(String resourceType, String resourceName) Delete auth resource.
AuthResource	getAuthResource(String resourceType, String resourceName) Query auth resource.
void	initialize(io.ballerina.messaging.broker.common.StartupContext startupContext) Initialize authorization strategy based on given auth configuration, user store manager and data source.
boolean	removeGroupFromResource(String resourceType, String resourceName, String action, String group) Revoke access from the given group.

Method Detail

initialize

void initialize(io.ballerina.messaging.broker.common.StartupContext startupContext)
         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 authProvider

Throws:

Exception

authorize

boolean authorize(String scopeName,
                  String userId)
           throws AuthException,
                  AuthServerException,
                  AuthNotFoundException

Authorize user with given scope key.

Parameters:

scopeName - a scope key

userId - an user identifier

Returns:

if authorised or not

Throws:

AuthException - throws if error occur during authorization

AuthServerException

AuthNotFoundException

authorize

boolean authorize(String resourceType,
                  String resource,
                  String action,
                  String userId)
           throws AuthException,
                  AuthServerException,
                  AuthNotFoundException

Authorize resource with given resource and action.

Parameters:

resourceType - resource Type

resource - resource

action - action

userId - user identifier

Returns:

if authorised or not

Throws:

AuthException - throws if error occur during authorization

AuthServerException

AuthNotFoundException

addProtectedResource

void addProtectedResource(String resourceType,
                          String resourceName,
                          boolean durable,
                          String owner)
                   throws AuthServerException

Create auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

durable - is durable

owner - resource owner

Throws:

AuthServerException - throws if error occurs while authorizing resource

deleteProtectedResource

void deleteProtectedResource(String resourceType,
                             String resourceName)
                      throws AuthServerException,
                             AuthNotFoundException

Delete auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

Throws:

AuthServerException - throws if error occurs while authorizing resource

AuthNotFoundException - throws if auth resource is not found

addGroupsToResource

boolean addGroupsToResource(String resourceType,
                            String resourceName,
                            String action,
                            List<String> groups)
                     throws AuthServerException

Allow given groups to access the givne resource.

Parameters:

resourceType - resource type

resourceName - resource name

action - action

groups - list of group to add

Returns:

true if group list add successfully

Throws:

AuthServerException - throws if error occurred while adding groups to resource

removeGroupFromResource

boolean removeGroupFromResource(String resourceType,
                                String resourceName,
                                String action,
                                String group)
                         throws AuthServerException,
                                AuthNotFoundException

Revoke access from the given group.

Parameters:

resourceType - resource type

resourceName - resource name

action - action

group - group

Throws:

AuthServerException - throws if an server error occurred

AuthNotFoundException - throws if the resource is not found

changeResourceOwner

boolean changeResourceOwner(String resourceType,
                            String resourceName,
                            String owner)
                     throws AuthServerException,
                            AuthNotFoundException,
                            AuthException

Create auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

owner - newOwner

Throws:

AuthServerException - throws if an server error occurred

AuthNotFoundException - throws if the resource is not found

AuthException

getAuthResource

AuthResource getAuthResource(String resourceType,
                             String resourceName)
                      throws AuthServerException,
                             AuthNotFoundException

Query auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

Returns:

matching auth resource if exists, null otherwise

Throws:

AuthServerException - throws if error occurs while authorizing resource

AuthNotFoundException - throws if auth resource is not found