org.wso2.charon3.core.extensions

Interface RoleManager

public interface RoleManager

OSGi service interface which uses to manage roles.

Method Summary

Modifier and Type	Method and Description
Role	createRole(Role role) Create a role.
void	deleteRole(String id) Delete the given role.
Role	getRole(String id, Map<String,Boolean> requiredAttributes) Get the role for the given ID.
RolesGetResponse	listRolesWithGET(Node node, Integer startIndex, Integer count, String sortBy, String sortOrder) List roles with Get.
RolesGetResponse	listRolesWithPost(SearchRequest searchRequest) List roles with Post.
default Role	patchRole(String roleId, Map<String,List<PatchOperation>> patchOperations) Updates the role via PATCH.
Role	updateRole(Role oldRole, Role newRole) Update the role.

Method Detail

createRole

Role createRole(Role role)
         throws CharonException,
                ConflictException,
                NotImplementedException,
                BadRequestException

Create a role.

Parameters:

role - Role Object.

Returns:

Role.

Throws:

CharonException - CharonException.

ConflictException - ConflictException.

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

getRole

Role getRole(String id,
             Map<String,Boolean> requiredAttributes)
      throws NotImplementedException,
             BadRequestException,
             CharonException,
             NotFoundException

Get the role for the given ID.

Parameters:

id - Role ID.

requiredAttributes - Required Attributes.

Returns:

Role.

Throws:

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

CharonException - CharonException.

NotFoundException - NotFoundException.

deleteRole

void deleteRole(String id)
         throws NotFoundException,
                CharonException,
                NotImplementedException,
                BadRequestException

Delete the given role.

Parameters:

id - Role ID.

Throws:

NotFoundException - NotFoundException.

CharonException - CharonException.

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

listRolesWithGET

RolesGetResponse listRolesWithGET(Node node,
                                  Integer startIndex,
                                  Integer count,
                                  String sortBy,
                                  String sortOrder)
                           throws CharonException,
                                  NotImplementedException,
                                  BadRequestException

List roles with Get.

Parameters:

node - Node

startIndex - Start Index

count - Count

sortBy - Sort by

sortOrder - Sort order

Returns:

List of roles.

Throws:

CharonException - CharonException.

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

updateRole

Role updateRole(Role oldRole,
                Role newRole)
         throws NotImplementedException,
                BadRequestException,
                CharonException,
                ConflictException,
                NotFoundException

Update the role.

Parameters:

oldRole - Old role.

newRole - new role.

Returns:

Updated role.

Throws:

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

CharonException - CharonException.

ConflictException - ConflictException.

NotFoundException - NotFoundException.

listRolesWithPost

RolesGetResponse listRolesWithPost(SearchRequest searchRequest)
                            throws NotImplementedException,
                                   BadRequestException,
                                   CharonException

List roles with Post.

Parameters:

searchRequest - Search request.

Returns:

List of roles.

Throws:

NotImplementedException - NotImplementedException.

BadRequestException - BadRequestException.

CharonException - CharonException.

patchRole

default Role patchRole(String roleId,
                       Map<String,List<PatchOperation>> patchOperations)
                throws NotImplementedException,
                       BadRequestException,
                       CharonException,
                       ConflictException,
                       NotFoundException

Updates the role via PATCH.

Parameters:

roleId - ID of the role.

patchOperations - A map of patch operations.

Returns:

Updated group.

Throws:

CharonException - Charon exception.

BadRequestException - Bad request exception.

NotFoundException - Not found exception.

NotImplementedException - Functionality no implemented exception.

ConflictException