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)
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<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)
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)
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)

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

Throws:

CharonException

NotImplementedException

BadRequestException

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

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

listGroupsWithPost

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

Throws:

NotImplementedException

BadRequestException

CharonException