org.wso2.charon3.core.extensions

Interface UserManager

public interface UserManager

This is the interface for usermanager extension. An implementation can plugin their own user manager-(either LDAP based, DB based etc) by implementing this interface and mentioning it in configuration.

Method Summary

Modifier and Type	Method and Description
Group	createGroup(Group group, Map<String,Boolean> requiredAttributes)
User	createMe(User user, Map<String,Boolean> requiredAttributes)
User	createUser(User user, Map<String,Boolean> requiredAttributes) User Manipulation operations.
void	deleteGroup(String id)
void	deleteMe(String userName)
void	deleteUser(String userId)
default List<Attribute>	getCustomUserSchemaAttributes() Returns list of attributes in custom schema.
default AttributeSchema	getCustomUserSchemaExtension() Return Custom schema.
default List<Attribute>	getEnterpriseUserSchema() Retrieve schema of the enterprise user.
Group	getGroup(String id, Map<String,Boolean> requiredAttributes)
User	getMe(String userName, Map<String,Boolean> requiredAttributes)
User	getUser(String id, Map<String,Boolean> requiredAttributes)
default List<Attribute>	getUserSchema()
default List<Object>	listGroupsWithGET(Node node, Integer startIndex, Integer count, String sortBy, String sortOrder, String domainName, Map<String,Boolean> requiredAttributes)
default List<Object>	listGroupsWithGET(Node node, int startIndex, int count, String sortBy, String sortOrder, Map<String,Boolean> requiredAttributes) Deprecated.
default List<Object>	listGroupsWithGET(Node node, int startIndex, int count, String sortBy, String sortOrder, String domainName, Map<String,Boolean> requiredAttributes) Deprecated. Method does not handle when the count is not specified in the request and when the count specified is zero. Use listGroupsWithGET(Node, Integer, Integer, String, String, String, Map) method.
List<Object>	listGroupsWithPost(SearchRequest searchRequest, Map<String,Boolean> requiredAttributes)
default List<Object>	listUsersWithGET(Node node, Integer startIndex, Integer count, String sortBy, String sortOrder, String domainName, Map<String,Boolean> requiredAttributes) List users with Get.
default List<Object>	listUsersWithGET(Node node, int startIndex, int count, String sortBy, String sortOrder, Map<String,Boolean> requiredAttributes) Deprecated.
default List<Object>	listUsersWithGET(Node node, int startIndex, int count, String sortBy, String sortOrder, String domainName, Map<String,Boolean> requiredAttributes) Deprecated. Method does not handle when the count is not specified in the request and when the count specified is zero. Use listUsersWithGET(Node, Integer, Integer, String, String, String, Map) method.
List<Object>	listUsersWithPost(SearchRequest searchRequest, Map<String,Boolean> requiredAttributes)
default Group	patchGroup(String groupId, String currentGroupName, Map<String,List<PatchOperation>> patchOperations, Map<String,Boolean> requiredAttributes) Updates the group via PATCH.
default void	updateGroup(Group oldGroup, Group newGroup) Updates the group.
Group	updateGroup(Group oldGroup, Group newGroup, Map<String,Boolean> requiredAttributes)
User	updateMe(User updatedUser, Map<String,Boolean> requiredAttributes)
User	updateUser(User updatedUser, Map<String,Boolean> requiredAttributes)
default User	updateUser(User updatedUser, Map<String,Boolean> requiredAttributes, List<String> allSimpleMultiValuedAttributes) Identify user claims to be updated and update the user in user store.

Method Detail

createUser

User createUser(User user,
                Map<String,Boolean> requiredAttributes)
         throws CharonException,
                ConflictException,
                BadRequestException

User Manipulation operations.

Throws:

CharonException

ConflictException

BadRequestException

getUser

User getUser(String id,
             Map<String,Boolean> requiredAttributes)
      throws CharonException,
             BadRequestException,
             NotFoundException

Throws:

CharonException

BadRequestException

NotFoundException

deleteUser

void deleteUser(String userId)
         throws NotFoundException,
                CharonException,
                NotImplementedException,
                BadRequestException

Throws:

NotFoundException

CharonException

NotImplementedException

BadRequestException

listUsersWithGET

default List<Object> listUsersWithGET(Node node,
                                      Integer startIndex,
                                      Integer count,
                                      String sortBy,
                                      String sortOrder,
                                      String domainName,
                                      Map<String,Boolean> requiredAttributes)
                               throws CharonException,
                                      NotImplementedException,
                                      BadRequestException

List users with Get.

Parameters:

node - Node

startIndex - Start Index

count - Count

sortBy - Sort by

sortOrder - Sort order

domainName - Domain name

requiredAttributes - Required user attributes

Returns:

Users with requested attributes

Throws:

CharonException - Error while listing users

NotImplementedException - Operation note implemented

BadRequestException - Bad request

listUsersWithGET

@Deprecated
default List<Object> listUsersWithGET(Node node,
                                                  int startIndex,
                                                  int count,
                                                  String sortBy,
                                                  String sortOrder,
                                                  String domainName,
                                                  Map<String,Boolean> requiredAttributes)
                                           throws CharonException,
                                                  NotImplementedException,
                                                  BadRequestException

Deprecated. Method does not handle when the count is not specified in the request and when the count specified is zero. Use listUsersWithGET(Node, Integer, Integer, String, String, String, Map) method.

This method is deprecated.

Throws:

CharonException

NotImplementedException

BadRequestException

Since:

1.2.21

listUsersWithGET

@Deprecated
default List<Object> listUsersWithGET(Node node,
                                                  int startIndex,
                                                  int count,
                                                  String sortBy,
                                                  String sortOrder,
                                                  Map<String,Boolean> requiredAttributes)
                                           throws CharonException,
                                                  NotImplementedException,
                                                  BadRequestException

Deprecated.

Throws:

CharonException

NotImplementedException

BadRequestException

listUsersWithPost

List<Object> listUsersWithPost(SearchRequest searchRequest,
                               Map<String,Boolean> requiredAttributes)
                        throws CharonException,
                               NotImplementedException,
                               BadRequestException

Throws:

CharonException

NotImplementedException

BadRequestException

updateUser

User updateUser(User updatedUser,
                Map<String,Boolean> requiredAttributes)
         throws NotImplementedException,
                CharonException,
                BadRequestException,
                NotFoundException

Throws:

NotImplementedException

CharonException

BadRequestException

NotFoundException

updateUser

default User updateUser(User updatedUser,
                        Map<String,Boolean> requiredAttributes,
                        List<String> allSimpleMultiValuedAttributes)
                 throws CharonException,
                        BadRequestException,
                        NotFoundException,
                        NotImplementedException

Identify user claims to be updated and update the user in user store.

Parameters:

updatedUser - Updated user.

requiredAttributes - URIs of required attributes which must be given a value.

allSimpleMultiValuedAttributes - Simple multi-valued attributes defined in SCIM schema.

Returns:

Updated user stored in the user store.

Throws:

CharonException - Charon exception.

BadRequestException - Bad request exception.

NotFoundException - Not found exception.

NotImplementedException - Functionality no implemented exception.

getMe

User getMe(String userName,
           Map<String,Boolean> requiredAttributes)
    throws CharonException,
           BadRequestException,
           NotFoundException

Throws:

CharonException

BadRequestException

NotFoundException

createMe

User createMe(User user,
              Map<String,Boolean> requiredAttributes)
       throws CharonException,
              ConflictException,
              BadRequestException

Throws:

CharonException

ConflictException

BadRequestException

deleteMe

void deleteMe(String userName)
       throws NotFoundException,
              CharonException,
              NotImplementedException,
              BadRequestException

Throws:

NotFoundException

CharonException

NotImplementedException

BadRequestException

updateMe

User updateMe(User updatedUser,
              Map<String,Boolean> requiredAttributes)
       throws NotImplementedException,
              CharonException,
              BadRequestException,
              NotFoundException

Throws:

NotImplementedException

CharonException

BadRequestException

NotFoundException

createGroup

Group createGroup(Group group,
                  Map<String,Boolean> requiredAttributes)
           throws CharonException,
                  ConflictException,
                  NotImplementedException,
                  BadRequestException

Throws:

CharonException

ConflictException

NotImplementedException

BadRequestException

getGroup

Group getGroup(String id,
               Map<String,Boolean> requiredAttributes)
        throws NotImplementedException,
               BadRequestException,
               CharonException,
               NotFoundException

Throws:

NotImplementedException

BadRequestException

CharonException

NotFoundException

deleteGroup

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

Throws:

NotFoundException

CharonException

NotImplementedException

BadRequestException

listGroupsWithGET

default List<Object> listGroupsWithGET(Node node,
                                       Integer startIndex,
                                       Integer count,
                                       String sortBy,
                                       String sortOrder,
                                       String domainName,
                                       Map<String,Boolean> requiredAttributes)
                                throws CharonException,
                                       NotImplementedException,
                                       BadRequestException

Throws:

CharonException

NotImplementedException

BadRequestException

listGroupsWithGET

@Deprecated
default List<Object> listGroupsWithGET(Node node,
                                                   int startIndex,
                                                   int count,
                                                   String sortBy,
                                                   String sortOrder,
                                                   String domainName,
                                                   Map<String,Boolean> requiredAttributes)
                                            throws CharonException,
                                                   NotImplementedException,
                                                   BadRequestException

Deprecated. Method does not handle when the count is not specified in the request and when the count specified is zero. Use listGroupsWithGET(Node, Integer, Integer, String, String, String, Map) method.

This method is deprecated.

Throws:

CharonException

NotImplementedException

BadRequestException

Since:

1.2.21

listGroupsWithGET

@Deprecated
default List<Object> listGroupsWithGET(Node node,
                                                   int startIndex,
                                                   int count,
                                                   String sortBy,
                                                   String sortOrder,
                                                   Map<String,Boolean> requiredAttributes)
                                            throws CharonException,
                                                   NotImplementedException,
                                                   BadRequestException

Deprecated.

Throws:

CharonException

NotImplementedException

BadRequestException

updateGroup

Group updateGroup(Group oldGroup,
                  Group newGroup,
                  Map<String,Boolean> requiredAttributes)
           throws NotImplementedException,
                  BadRequestException,
                  CharonException,
                  NotFoundException

Throws:

NotImplementedException

BadRequestException

CharonException

NotFoundException

updateGroup

default void updateGroup(Group oldGroup,
                         Group newGroup)
                  throws NotImplementedException,
                         BadRequestException,
                         CharonException,
                         NotFoundException

Updates the group.

Parameters:

oldGroup -

newGroup -

Throws:

NotImplementedException

BadRequestException

CharonException

NotFoundException

patchGroup

default Group patchGroup(String groupId,
                         String currentGroupName,
                         Map<String,List<PatchOperation>> patchOperations,
                         Map<String,Boolean> requiredAttributes)
                  throws NotImplementedException,
                         BadRequestException,
                         CharonException,
                         NotFoundException

Updates the group via PATCH.

Parameters:

groupId - ID of the group.

currentGroupName - Current name of the group.

patchOperations - A map of patch operations.

requiredAttributes - Attributes to be returned in the response.

Returns:

Updated group.

Throws:

CharonException - Charon exception.

BadRequestException - Bad request exception.

NotFoundException - Not found exception.

NotImplementedException - Functionality no implemented exception.

listGroupsWithPost

List<Object> listGroupsWithPost(SearchRequest searchRequest,
                                Map<String,Boolean> requiredAttributes)
                         throws NotImplementedException,
                                BadRequestException,
                                CharonException

Throws:

NotImplementedException

BadRequestException

CharonException

getUserSchema

default List<Attribute> getUserSchema()
                               throws CharonException,
                                      NotImplementedException,
                                      BadRequestException

Throws:

CharonException

NotImplementedException

BadRequestException

getEnterpriseUserSchema

default List<Attribute> getEnterpriseUserSchema()
                                         throws CharonException,
                                                NotImplementedException,
                                                BadRequestException

Retrieve schema of the enterprise user.

Returns:

List of attributes of enterprise user schema.

Throws:

CharonException

NotImplementedException

BadRequestException

getCustomUserSchemaExtension

default AttributeSchema getCustomUserSchemaExtension()
                                              throws CharonException,
                                                     NotImplementedException,
                                                     BadRequestException

Return Custom schema.

Returns:

Custom schema.

Throws:

CharonException

NotImplementedException

BadRequestException

getCustomUserSchemaAttributes

default List<Attribute> getCustomUserSchemaAttributes()
                                               throws CharonException,
                                                      NotImplementedException,
                                                      BadRequestException

Returns list of attributes in custom schema.

Returns:

List of attributes in custom schema.

Throws:

CharonException

NotImplementedException

BadRequestException