org.wso2.charon3.core.protocol.endpoints

Class GroupResourceManager

java.lang.Object

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

org.wso2.charon3.core.protocol.endpoints.GroupResourceManager

All Implemented Interfaces:

ResourceManager

public class GroupResourceManager
extends AbstractResourceManager

REST API exposed by Charon-Core to perform operations on GroupResource. Any SCIM service provider can call this API perform relevant CRUD operations on Group , based on the HTTP requests received by SCIM Client.

Constructor Summary

Constructors

Constructor and Description
GroupResourceManager()

Method Summary

Modifier and Type	Method and Description
SCIMResponse	create(String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)
ListedResource	createListedResource(List<Object> groups, int startIndex, int totalResults)
SCIMResponse	delete(String id, UserManager userManager)
SCIMResponse	get(String id, UserManager userManager, String attributes, String excludeAttributes)
SCIMResponse	listWithGET(UserManager userManager, String filter, Integer startIndexInt, Integer countInt, String sortBy, String sortOrder, String domainName, String attributes, String excludeAttributes) Method to list groups at the Groups endpoint.
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	listWithPOST(String resourceString, UserManager userManager)
SCIMResponse	updateWithPATCH(String existingGroupId, String patchRequest, UserManager userManager) Updates the group based on the operations defined in the patchRequest.
SCIMResponse	updateWithPATCH(String existingId, String patchRequest, UserManager userManager, String attributes, String excludeAttributes) Updates the group based on the operations defined in the patchRequest.
SCIMResponse	updateWithPatchForAddRemoveOperations(String existingGroupId, List<PatchOperation> opList, UserManager userManager, String attributes, String excludeAttributes) Updates the group based on the operations defined in the patchRequest.
SCIMResponse	updateWithPUT(String existingId, String scimObjectString, UserManager userManager, String attributes, String excludeAttributes)

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

Methods inherited from interface org.wso2.charon3.core.protocol.endpoints.ResourceManager

createRole, deleteRole, getRole, listWithGETRole, listWithPOSTRole, updateWithPATCHRole, updateWithPUTRole

Constructor Detail

GroupResourceManager

public GroupResourceManager()

Method Detail

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)

Method to list groups at the Groups endpoint. In the method, when the count is zero, the response will get zero results. When the count value is not specified (null) a default number of values for response will be returned. Any negative value to the count will return all the groups.

Parameters:

userManager - User manager

filter - Filter to be executed

startIndexInt - Starting index value of the filter

countInt - Number of required results

sortBy - SortBy

sortOrder - Sorting order

domainName - Domain name

attributes - Attributes in the request

excludeAttributes - Exclude attributes

Returns:

SCIM response

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 patchRequest,
                                    UserManager userManager,
                                    String attributes,
                                    String excludeAttributes)

Updates the group based on the operations defined in the patchRequest. The updated group information is sent back in the response.

Parameters:

existingId - SCIM2 ID of the existing group.

patchRequest - SCIM2 patch request.

userManager - SCIM UserManager that handles the persistence layer.

attributes - Attributes to return in the response.

excludeAttributes - Attributes to exclude in the response.

Returns:

SCIM Response.

updateWithPatchForAddRemoveOperations

public SCIMResponse updateWithPatchForAddRemoveOperations(String existingGroupId,
                                                          List<PatchOperation> opList,
                                                          UserManager userManager,
                                                          String attributes,
                                                          String excludeAttributes)

Updates the group based on the operations defined in the patchRequest. The updated group information is sent back in the response.

Parameters:

existingGroupId - SCIM2 ID of the existing group.

opList - List of patch operations.

userManager - SCIM UserManager that handles the persistence layer.

attributes - Attributes to return in the response.

excludeAttributes - Attributes to exclude in the response.

Returns:

SCIM Response.

updateWithPATCH

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

Updates the group based on the operations defined in the patchRequest. The updated group information is not sent back in the response.

Parameters:

existingGroupId - SCIM2 ID of the existing group

patchRequest - SCIM2 patch request

userManager - SCIM UserManager that handles the persistence layer.

Returns:

createListedResource

public ListedResource createListedResource(List<Object> groups,
                                           int startIndex,
                                           int totalResults)
                                    throws CharonException,
                                           NotFoundException

Throws:

CharonException

NotFoundException