io.ballerina.messaging.broker.auth.authorization.authorizer.rdbms.resource.dao

Interface AuthResourceDao

All Known Implementing Classes:

AuthResourceInMemoryDao, AuthResourceRdbmsDao

public interface AuthResourceDao

Defines functionality required at persistence layer for managing resources.

Method Summary

Modifier and Type	Method and Description
boolean	addGroups(String resourceType, String resourceName, String action, List<String> groups) Add batch of group mapping to the given auth resource
boolean	delete(String resourceType, String resource) Delete resource from database on given given resource type and name and user groups.
boolean	isExists(String resourceType, String resource) Check resource existence for given resource type and name.
void	persist(AuthResource authResource) Persist resource in the database
AuthResource	read(String resourceType, String resource) Get resource for given resource type and name.
List<AuthResource>	readAll(String resourceType, String ownerId) Get all resource for given resource type.
List<AuthResource>	readAll(String resourceType, String action, String ownerId, List<String> userGroups) Get all resource for given resource type.
boolean	removeGroup(String resourceType, String resourceName, String action, String group) Remove a group mapping from the given auth resource.
void	update(AuthResource authResource) Update resource owner in the database
boolean	updateOwner(String resourceType, String resourceName, String newOwner) Update owner of the given resource.

Method Detail

persist

void persist(AuthResource authResource)
      throws AuthServerException

Persist resource in the database

Parameters:

authResource - authResource

Throws:

AuthServerException - when database operation failed.

update

void update(AuthResource authResource)
     throws AuthServerException

Update resource owner in the database

Parameters:

authResource - authResource

Throws:

AuthServerException - when database operation failed.

delete

boolean delete(String resourceType,
               String resource)
        throws AuthServerException

Delete resource from database on given given resource type and name and user groups.

Parameters:

resourceType - resource Type

resource - resource

Throws:

AuthServerException - when database operation failed.

read

AuthResource read(String resourceType,
                  String resource)
           throws AuthServerException

Get resource for given resource type and name.

Parameters:

resourceType - resource Type

resource - resource

Returns:

user id

Throws:

AuthServerException - when database operation failed.

readAll

List<AuthResource> readAll(String resourceType,
                           String ownerId)
                    throws AuthServerException

Get all resource for given resource type.

Parameters:

resourceType - resource Type

ownerId - owner user id

Returns:

user id

Throws:

AuthServerException - when database operation failed.

readAll

List<AuthResource> readAll(String resourceType,
                           String action,
                           String ownerId,
                           List<String> userGroups)
                    throws AuthServerException

Get all resource for given resource type.

Parameters:

resourceType - resource Type

action - action

ownerId - owner user id

userGroups - user groups

Returns:

user id

Throws:

AuthServerException - when database operation failed.

isExists

boolean isExists(String resourceType,
                 String resource)
          throws AuthServerException

Check resource existence for given resource type and name.

Parameters:

resourceType - resource Type

resource - resource

Returns:

is resource exist or not

Throws:

AuthServerException - when database operation failed.

updateOwner

boolean updateOwner(String resourceType,
                    String resourceName,
                    String newOwner)
             throws AuthServerException

Update owner of the given resource.

Parameters:

resourceType - resource type

resourceName - resource name

newOwner - user ID of the new owner

Returns:

true if resource was updated

Throws:

AuthServerException - when database operation failed

addGroups

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

Add batch of group mapping to the given auth resource

Parameters:

resourceType - resource type

resourceName - resource name

action - action

groups - list of group to add

Returns:

true if resource update with group list

Throws:

AuthServerException - when database operation failed.

removeGroup

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

Remove a group mapping from the given auth resource.

Parameters:

resourceType - resource type

resourceName - resource name

action - action

group - group to add

Returns:

true if resource was updated

Throws:

AuthNotFoundException

AuthServerException