org.wso2.charon3.core.protocol.endpoints

Class RoleResourceManager

java.lang.Object

org.wso2.charon3.core.protocol.endpoints.AbstractResourceManager

org.wso2.charon3.core.protocol.endpoints.RoleResourceManager

All Implemented Interfaces:

ResourceManager

public class RoleResourceManager
extends AbstractResourceManager

REST API exposed by Charon-Core to perform operations on RoleResource.

Constructor Summary

Constructors

Constructor and Description
RoleResourceManager()

Method Summary

Modifier and Type	Method and Description
SCIMResponse	create(String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
protected ListedResource	createListedResource(List<Object> roles, int startIndex, int totalResults)
SCIMResponse	createRole(String postRequest, RoleManager roleManager) POST method to create a new role.
SCIMResponse	delete(String id, UserManager userManager)
SCIMResponse	deleteRole(String id, RoleManager roleManager) DELETE method to delete a specific role.
SCIMResponse	get(String id, UserManager userManager, String attributes, String excludeAttributes)
SCIMResponse	getRole(String id, RoleManager roleManager, String attributes, String excludeAttributes) GET method to retrieve a specific role.
SCIMResponse	listWithGET(UserManager userManager, String filter, Integer startIndexInt, Integer countInt, String sortBy, String sortOrder, String domainName, String attributes, String excludeAttributes)
SCIMResponse	listWithGET(UserManager userManager, String filter, int startIndex, int count, String sortBy, String sortOrder, String domainName, String attributes, String excludeAttributes) This method is deprecated
SCIMResponse	listWithGETRole(RoleManager roleManager, String filter, Integer startIndexInt, Integer countInt, String sortBy, String sortOrder) GET method to list roles.
SCIMResponse	listWithPOST(String resourceString, UserManager userManager)
SCIMResponse	listWithPOSTRole(String searchRequest, RoleManager roleManager) POST method to search roles.
SCIMResponse	updateWithPATCH(String existingId, String patchRequest, UserManager userManager)
SCIMResponse	updateWithPATCH(String existingId, String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
SCIMResponse	updateWithPATCHRole(String id, String patchRequest, RoleManager roleManager) PATCH method to partially updates a role.
SCIMResponse	updateWithPUT(String existingId, String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
SCIMResponse	updateWithPUTRole(String id, String putRequest, RoleManager roleManager) PUT method To update a role by giving entire attributes set.

Methods inherited from class org.wso2.charon3.core.protocol.endpoints.AbstractResourceManager

encodeSCIMException, getDecoder, getEncoder, getResourceEndpointURL, setEndpointURLMap, setResourceURLBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleResourceManager

public RoleResourceManager()

Method Detail

getRole

public SCIMResponse getRole(String id,
                            RoleManager roleManager,
                            String attributes,
                            String excludeAttributes)

Description copied from interface: ResourceManager

GET method to retrieve a specific role.

Parameters:

id - Resource id.

roleManager - Role manager.

attributes - Attributes in the response.

excludeAttributes - Exclude attributes in the response.

Returns:

SCIMResponse.

createRole

public SCIMResponse createRole(String postRequest,
                               RoleManager roleManager)

Description copied from interface: ResourceManager

POST method to create a new role.

Parameters:

postRequest - Post request.

roleManager - Role manager.

Returns:

SCIMResponse.

deleteRole

public SCIMResponse deleteRole(String id,
                               RoleManager roleManager)

Description copied from interface: ResourceManager

DELETE method to delete a specific role.

Parameters:

id - Resource id.

roleManager - Role manager.

Returns:

SCIMResponse.

listWithGETRole

public SCIMResponse listWithGETRole(RoleManager roleManager,
                                    String filter,
                                    Integer startIndexInt,
                                    Integer countInt,
                                    String sortBy,
                                    String sortOrder)

Description copied from interface: ResourceManager

GET method to list roles.

Parameters:

roleManager - Role manager.

filter - Filter to be executed.

startIndexInt - Starting index value of the filter.

countInt - Number of required results.

sortBy - SortBy.

sortOrder - Sorting order.

Returns:

SCIMResponse.

createListedResource

protected ListedResource createListedResource(List<Object> roles,
                                              int startIndex,
                                              int totalResults)

listWithPOSTRole

public SCIMResponse listWithPOSTRole(String searchRequest,
                                     RoleManager roleManager)

Description copied from interface: ResourceManager

POST method to search roles.

Parameters:

searchRequest - Search request.

roleManager - Role manager.

Returns:

SCIMResponse.

updateWithPUTRole

public SCIMResponse updateWithPUTRole(String id,
                                      String putRequest,
                                      RoleManager roleManager)

Description copied from interface: ResourceManager

PUT method To update a role by giving entire attributes set.

Parameters:

id - Resource id.

putRequest - Put request.

roleManager - Role manager.

Returns:

SCIMResponse.

updateWithPATCHRole

public SCIMResponse updateWithPATCHRole(String id,
                                        String patchRequest,
                                        RoleManager roleManager)

Description copied from interface: ResourceManager

PATCH method to partially updates a role.

Parameters:

id - Resource id.

patchRequest - Patch request.

roleManager - Role manager.

Returns:

SCIMResponse.

get

public SCIMResponse get(String id,
                        UserManager userManager,
                        String attributes,
                        String excludeAttributes)

create

public SCIMResponse create(String scimObjectString,
                           UserManager userManager,
                           String attributes,
                           String excludeAttributes)

delete

public SCIMResponse delete(String id,
                           UserManager userManager)

listWithGET

public SCIMResponse listWithGET(UserManager userManager,
                                String filter,
                                int startIndex,
                                int count,
                                String sortBy,
                                String sortOrder,
                                String domainName,
                                String attributes,
                                String excludeAttributes)

Description copied from interface: ResourceManager

This method is deprecated

Returns:

listWithGET

public SCIMResponse listWithGET(UserManager userManager,
                                String filter,
                                Integer startIndexInt,
                                Integer countInt,
                                String sortBy,
                                String sortOrder,
                                String domainName,
                                String attributes,
                                String excludeAttributes)

listWithPOST

public SCIMResponse listWithPOST(String resourceString,
                                 UserManager userManager)

updateWithPUT

public SCIMResponse updateWithPUT(String existingId,
                                  String scimObjectString,
                                  UserManager userManager,
                                  String attributes,
                                  String excludeAttributes)

updateWithPATCH

public SCIMResponse updateWithPATCH(String existingId,
                                    String scimObjectString,
                                    UserManager userManager,
                                    String attributes,
                                    String excludeAttributes)

updateWithPATCH

public SCIMResponse updateWithPATCH(String existingId,
                                    String patchRequest,
                                    UserManager userManager)