org.wso2.charon3.core.protocol.endpoints

Interface ResourceManager

All Known Implementing Classes:

AbstractResourceManager, BulkResourceManager, GroupResourceManager, MeResourceManager, ResourceTypeResourceManager, RoleResourceManager, SchemaResourceManager, ServiceProviderConfigResourceManager, UserResourceManager

public interface ResourceManager

Interface for SCIM resource endpoints.

Method Summary

Modifier and Type	Method and Description
SCIMResponse	create(String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
default SCIMResponse	createRole(String postRequest, RoleManager roleManager) POST method to create a new role.
SCIMResponse	delete(String id, UserManager userManager)
default SCIMResponse	deleteRole(String id, RoleManager roleManager) DELETE method to delete a specific role.
SCIMResponse	get(String id, UserManager userManager, String attributes, String excludeAttributes)
default SCIMResponse	getRole(String id, RoleManager roleManager, String attributes, String excludeAttributes) GET method to retrieve a specific role.
default 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) Deprecated. Method does not differenticate when the count paramter is not set in the request. Use listWithGET(UserManager, String, Integer, Integer, String, String, String, String, String)
default SCIMResponse	listWithGETRole(RoleManager roleManager, String filter, Integer startIndex, Integer count, String sortBy, String sortOrder) GET method to list roles.
SCIMResponse	listWithPOST(String resourceString, UserManager userManager)
default SCIMResponse	listWithPOSTRole(String searchRequest, RoleManager roleManager) POST method to search roles.
default SCIMResponse	updateWithPATCH(String existingId, String patchRequest, UserManager userManager)
SCIMResponse	updateWithPATCH(String existingId, String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
default 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)
default SCIMResponse	updateWithPUTRole(String id, String putRequest, RoleManager roleManager) PUT method To update a role by giving entire attributes set.

Method Detail

get

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

create

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

delete

SCIMResponse delete(String id,
                    UserManager userManager)

listWithGET

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

Deprecated. Method does not differenticate when the count paramter is not set in the request. Use listWithGET(UserManager, String, Integer, Integer, String, String, String, String, String)

This method is deprecated

Parameters:

userManager -

filter -

startIndex -

count -

sortBy -

sortOrder -

domainName -

attributes -

excludeAttributes -

Returns:

Since:

1.2.21

listWithGET

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

listWithPOST

SCIMResponse listWithPOST(String resourceString,
                          UserManager userManager)

updateWithPUT

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

updateWithPATCH

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

updateWithPATCH

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

getRole

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

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

default SCIMResponse createRole(String postRequest,
                                RoleManager roleManager)

POST method to create a new role.

Parameters:

postRequest - Post request.

roleManager - Role manager.

Returns:

SCIMResponse.

deleteRole

default SCIMResponse deleteRole(String id,
                                RoleManager roleManager)

DELETE method to delete a specific role.

Parameters:

id - Resource id.

roleManager - Role manager.

Returns:

SCIMResponse.

listWithGETRole

default SCIMResponse listWithGETRole(RoleManager roleManager,
                                     String filter,
                                     Integer startIndex,
                                     Integer count,
                                     String sortBy,
                                     String sortOrder)

GET method to list roles.

Parameters:

roleManager - Role manager.

filter - Filter to be executed.

startIndex - Starting index value of the filter.

count - Number of required results.

sortBy - SortBy.

sortOrder - Sorting order.

Returns:

SCIMResponse.

listWithPOSTRole

default SCIMResponse listWithPOSTRole(String searchRequest,
                                      RoleManager roleManager)

POST method to search roles.

Parameters:

searchRequest - Search request.

roleManager - Role manager.

Returns:

SCIMResponse.

updateWithPUTRole

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

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

Parameters:

id - Resource id.

putRequest - Put request.

roleManager - Role manager.

Returns:

SCIMResponse.

updateWithPATCHRole

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

PATCH method to partially updates a role.

Parameters:

id - Resource id.

patchRequest - Patch request.

roleManager - Role manager.

Returns:

SCIMResponse.