io.ballerina.messaging.broker.auth.authorization

Class DiscretionaryAccessController

java.lang.Object

io.ballerina.messaging.broker.auth.authorization.DiscretionaryAccessController

Direct Known Subclasses:

MemoryDacHandler, RdbmsDacHandler

public abstract class DiscretionaryAccessController
extends Object

Used to manage permissions for dynamic resources.

Constructor Summary

Constructors

Constructor and Description
DiscretionaryAccessController()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addGroupsToResource(String resourceType, String resourceName, String action, List<String> groups) Allow given groups to access the given resource.
abstract void	addResource(String resourceType, String resourceName, String owner) Create auth resource.
boolean	authorize(String resourceType, String resource, String action, String userId, Set<String> userGroups) Authorize resource with given resource and action.
abstract boolean	changeResourceOwner(String resourceType, String resourceName, String owner) Create auth resource.
abstract boolean	deleteResource(String resourceType, String resourceName) Delete auth resource.
abstract AuthResource	getAuthResource(String resourceType, String resourceName) Get auth resource.
abstract void	initialize(io.ballerina.messaging.broker.common.StartupContext startupContext, UserStore userStore, Map<String,String> properties) Initialize authorization controller based on given auth configuration, user store.
abstract boolean	removeGroupFromResource(String resourceType, String resourceName, String action, String group) Revoke access from the given group.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscretionaryAccessController

public DiscretionaryAccessController()

Method Detail

initialize

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

Initialize authorization controller based on given auth configuration, user store.

Parameters:

startupContext - the startup context provides registered services in broker

userStore - user store

properties - properties

Throws:

Exception

authorize

public final boolean authorize(String resourceType,
                               String resource,
                               String action,
                               String userId,
                               Set<String> userGroups)
                        throws AuthServerException,
                               AuthNotFoundException

Authorize resource with given resource and action.

Parameters:

resourceType - resource Type

resource - resource

action - action

userId - user identifier of owner

userGroups - user groups of the user

Returns:

true if authorised, false otherwise

Throws:

AuthServerException - throws if an server error occurred

AuthNotFoundException - throws if the resource is not found

addResource

public abstract void addResource(String resourceType,
                                 String resourceName,
                                 String owner)
                          throws AuthServerException

Create auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

owner - resource owner

Throws:

AuthServerException - throws if an server error occurred

deleteResource

public abstract boolean deleteResource(String resourceType,
                                       String resourceName)
                                throws AuthServerException,
                                       AuthNotFoundException

Delete auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

Throws:

AuthServerException - throws if an server error occurred

AuthNotFoundException - throws if the resource is not found

addGroupsToResource

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

Allow given groups to access the given resource.

Parameters:

resourceType - resource type

resourceName - resource name

action - action

groups - list of group

Returns:

true if group list add successfully

Throws:

AuthServerException - throws if server error occurred

removeGroupFromResource

public abstract 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

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

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

getAuthResource

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

Get auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

Returns:

permission data of the resource

Throws:

AuthServerException - throws if an server error occurred

AuthNotFoundException - throws if the resource is not found