RestCrowdClient (Atlassian Crowd Integration Client

java.lang.Object
- com.atlassian.crowd.integration.rest.service.RestCrowdClient

All Implemented Interfaces:

CrowdClient
```
public class RestCrowdClient
extends Object
implements CrowdClient
```
This is the Crowd Client to access REST services on a remote Crowd Server.

Constructor Summary

Constructors
Constructor and Description
`RestCrowdClient(ClientProperties clientProperties)` Deprecated. use the `RestCrowdClientFactory` methods
`RestCrowdClient(RestExecutor executor)` Please do not call this constructor directly.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGroup(Group group)`
`void`	`addGroupToGroup(String childGroup, String parentGroup)`
`UserWithAttributes`	`addUser(User user, PasswordCredential passwordCredential)`
`UserWithAttributes`	`addUser(UserWithAttributes user, PasswordCredential passwordCredential)`
`void`	`addUserToGroup(String username, String groupName)`
`String`	`authenticateSSOUser(UserAuthenticationContext userAuthenticationContext)`
`String`	`authenticateSSOUser(UserAuthenticationContext userAuthenticationContext, long duration)`
`String`	`authenticateSSOUserWithoutValidatingPassword(UserAuthenticationContext userAuthenticationContext)`
`User`	`authenticateUser(String username, String password)`
`void`	`expireAllPasswords()`
`User`	`findUserFromSSOToken(String token)`
`List<Group>`	`getChildGroupsOfGroup(String groupName, int startIndex, int maxResults)`
`CookieConfiguration`	`getCookieConfiguration()`
`String`	`getCurrentEventToken()`
`Group`	`getGroup(String name)` Get a group by name.
`List<Group>`	`getGroupsForNestedUser(String userName, int startIndex, int maxResults)`
`List<Group>`	`getGroupsForUser(String userName, int startIndex, int maxResults)`
`List<GroupWithAttributes>`	`getGroupsWithAttributesForUser(String userName, int startIndex, int maxResults)`
`GroupWithAttributes`	`getGroupWithAttributes(String name)`
`Iterable<Membership>`	`getMemberships()`
`List<String>`	`getNamesOfChildGroupsOfGroup(String groupName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfGroupsForNestedUser(String userName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfGroupsForUser(String userName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfNestedChildGroupsOfGroup(String groupName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfNestedUsersOfGroup(String groupName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfParentGroupsForGroup(String groupName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfParentGroupsForNestedGroup(String groupName, int startIndex, int maxResults)`
`List<String>`	`getNamesOfUsersOfGroup(String groupName, int startIndex, int maxResults)`
`List<Group>`	`getNestedChildGroupsOfGroup(String groupName, int startIndex, int maxResults)`
`List<User>`	`getNestedUsersOfGroup(String groupName, int startIndex, int maxResults)`
`Events`	`getNewEvents(String eventToken)`
`List<Group>`	`getParentGroupsForGroup(String groupName, int startIndex, int maxResults)`
`List<Group>`	`getParentGroupsForNestedGroup(String groupName, int startIndex, int maxResults)`
`User`	`getUser(String name)`
`User`	`getUserByKey(String key)`
`List<User>`	`getUsersOfGroup(String groupName, int startIndex, int maxResults)`
`UserWithAttributes`	`getUserWithAttributes(String name)`
`String`	`getWebhook(long webhookId)`
`void`	`invalidateSSOToken(String token)`
`void`	`invalidateSSOTokensForUser(String username)`
`void`	`invalidateSSOTokensForUser(String username, String exclude)`
`boolean`	`isGroupDirectGroupMember(String childName, String parentName)`
`boolean`	`isUserDirectGroupMember(String username, String groupName)`
`boolean`	`isUserNestedGroupMember(String username, String groupName)`
`long`	`registerWebhook(String endpointUrl, String token)`
`void`	`removeGroup(String groupName)`
`void`	`removeGroupAttributes(String groupName, String attributeName)`
`void`	`removeGroupFromGroup(String childGroup, String parentGroup)`
`void`	`removeUser(String username)`
`void`	`removeUserAttributes(String username, String attributeName)`
`void`	`removeUserFromGroup(String username, String groupName)`
`User`	`renameUser(String oldUsername, String newUsername)`
`void`	`requestPasswordReset(String username)`
`void`	`requestUsernames(String email)`
`List<String>`	`searchGroupNames(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`List<Group>`	`searchGroups(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`List<GroupWithAttributes>`	`searchGroupsWithAttributes(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`List<String>`	`searchUserNames(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`List<User>`	`searchUsers(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`List<UserWithAttributes>`	`searchUsersWithAttributes(SearchRestriction searchRestriction, int startIndex, int maxResults)`
`void`	`shutdown()`
`void`	`storeGroupAttributes(String groupName, Map<String,Set<String>> attributes)`
`void`	`storeUserAttributes(String username, Map<String,Set<String>> attributes)`
`void`	`testConnection()`
`void`	`unregisterWebhook(long webhookId)`
`void`	`updateGroup(Group group)`
`void`	`updateUser(User user)`
`void`	`updateUserCredential(String username, String password)`
`User`	`userAuthenticated(String username)`
`void`	`validateSSOAuthentication(String token, List<ValidationFactor> validationFactors)`
`Session`	`validateSSOAuthenticationAndGetSession(String token, List<ValidationFactor> validationFactors)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- RestCrowdClient
```
@Deprecated
public RestCrowdClient(ClientProperties clientProperties)
```
  Deprecated. use the RestCrowdClientFactory methods
  
  Constructs a new REST Crowd Client instance. This client provides a simple interface for interacting with a remote Crowd server. The client is thread safe.
  
  Parameters:
  
  clientProperties - crowd properties for the client
- RestCrowdClient
```
public RestCrowdClient(RestExecutor executor)
```
  Please do not call this constructor directly. Use the methods in RestCrowdClientFactory instead.

Method Detail

getUser

public User getUser(String name)
             throws UserNotFoundException,
                    ApplicationPermissionException,
                    InvalidAuthenticationException,
                    OperationFailedException

Specified by:: getUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getUserWithAttributes

public UserWithAttributes getUserWithAttributes(String name)
                                         throws UserNotFoundException,
                                                ApplicationPermissionException,
                                                InvalidAuthenticationException,
                                                OperationFailedException

Specified by:: getUserWithAttributes in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getUserByKey

public User getUserByKey(String key)
                  throws UserNotFoundException,
                         OperationFailedException,
                         ApplicationPermissionException,
                         InvalidAuthenticationException

Specified by:: getUserByKey in interface CrowdClient
Throws:: UserNotFoundException; OperationFailedException; ApplicationPermissionException; InvalidAuthenticationException

authenticateUser

public User authenticateUser(String username,
                             String password)
                      throws UserNotFoundException,
                             InactiveAccountException,
                             ExpiredCredentialException,
                             ApplicationPermissionException,
                             InvalidAuthenticationException,
                             OperationFailedException

Specified by:: authenticateUser in interface CrowdClient
Throws:: UserNotFoundException; InactiveAccountException; ExpiredCredentialException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

userAuthenticated

public User userAuthenticated(String username)
                       throws ApplicationPermissionException,
                              OperationFailedException,
                              InvalidAuthenticationException,
                              UserNotFoundException,
                              InactiveAccountException

Specified by:: userAuthenticated in interface CrowdClient
Throws:: ApplicationPermissionException; OperationFailedException; InvalidAuthenticationException; UserNotFoundException; InactiveAccountException

addUser

public UserWithAttributes addUser(UserWithAttributes user,
                                  PasswordCredential passwordCredential)
                           throws ApplicationPermissionException,
                                  InvalidUserException,
                                  InvalidCredentialException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: addUser in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidUserException; InvalidCredentialException; InvalidAuthenticationException; OperationFailedException

addUser

public UserWithAttributes addUser(User user,
                                  PasswordCredential passwordCredential)
                           throws ApplicationPermissionException,
                                  InvalidUserException,
                                  InvalidCredentialException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: addUser in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidUserException; InvalidCredentialException; InvalidAuthenticationException; OperationFailedException

updateUser

public void updateUser(User user)
                throws InvalidUserException,
                       UserNotFoundException,
                       ApplicationPermissionException,
                       InvalidAuthenticationException,
                       OperationFailedException

Specified by:: updateUser in interface CrowdClient
Throws:: InvalidUserException; UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

renameUser

public User renameUser(String oldUsername,
                       String newUsername)
                throws InvalidUserException,
                       UserNotFoundException,
                       OperationFailedException,
                       ApplicationPermissionException,
                       InvalidAuthenticationException

Specified by:: renameUser in interface CrowdClient
Throws:: InvalidUserException; UserNotFoundException; OperationFailedException; ApplicationPermissionException; InvalidAuthenticationException

updateUserCredential

public void updateUserCredential(String username,
                                 String password)
                          throws InvalidCredentialException,
                                 UserNotFoundException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: updateUserCredential in interface CrowdClient
Throws:: InvalidCredentialException; UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

requestPasswordReset

public void requestPasswordReset(String username)
                          throws UserNotFoundException,
                                 InvalidEmailAddressException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: requestPasswordReset in interface CrowdClient
Throws:: UserNotFoundException; InvalidEmailAddressException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

requestUsernames

public void requestUsernames(String email)
                      throws InvalidEmailAddressException,
                             ApplicationPermissionException,
                             InvalidAuthenticationException,
                             OperationFailedException

Specified by:: requestUsernames in interface CrowdClient
Throws:: InvalidEmailAddressException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

storeUserAttributes

public void storeUserAttributes(String username,
                                Map<String,Set<String>> attributes)
                         throws UserNotFoundException,
                                ApplicationPermissionException,
                                InvalidAuthenticationException,
                                OperationFailedException

Specified by:: storeUserAttributes in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

removeUserAttributes

public void removeUserAttributes(String username,
                                 String attributeName)
                          throws UserNotFoundException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: removeUserAttributes in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

removeUser

public void removeUser(String username)
                throws UserNotFoundException,
                       ApplicationPermissionException,
                       InvalidAuthenticationException,
                       OperationFailedException

Specified by:: removeUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getGroup
```
public Group getGroup(String name)
               throws GroupNotFoundException,
                      ApplicationPermissionException,
                      InvalidAuthenticationException,
                      OperationFailedException
```
Get a group by name.

Specified by:

getGroup in interface CrowdClient

Parameters:

name - name of the group to retrieve.

Returns:

A Group

Throws:

GroupNotFoundException - The group does not exist on the remote server.

OperationFailedException - For any other communication errors.

ApplicationPermissionException

InvalidAuthenticationException

getGroupWithAttributes

public GroupWithAttributes getGroupWithAttributes(String name)
                                           throws GroupNotFoundException,
                                                  ApplicationPermissionException,
                                                  InvalidAuthenticationException,
                                                  OperationFailedException

Specified by:: getGroupWithAttributes in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

addGroup

public void addGroup(Group group)
              throws InvalidGroupException,
                     ApplicationPermissionException,
                     InvalidAuthenticationException,
                     OperationFailedException

Specified by:: addGroup in interface CrowdClient
Throws:: InvalidGroupException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

updateGroup

public void updateGroup(Group group)
                 throws InvalidGroupException,
                        GroupNotFoundException,
                        ApplicationPermissionException,
                        InvalidAuthenticationException,
                        OperationFailedException

Specified by:: updateGroup in interface CrowdClient
Throws:: InvalidGroupException; GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

storeGroupAttributes

public void storeGroupAttributes(String groupName,
                                 Map<String,Set<String>> attributes)
                          throws GroupNotFoundException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: storeGroupAttributes in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

removeGroupAttributes

public void removeGroupAttributes(String groupName,
                                  String attributeName)
                           throws GroupNotFoundException,
                                  ApplicationPermissionException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: removeGroupAttributes in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

removeGroup

public void removeGroup(String groupName)
                 throws GroupNotFoundException,
                        ApplicationPermissionException,
                        InvalidAuthenticationException,
                        OperationFailedException

Specified by:: removeGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

isUserDirectGroupMember

public boolean isUserDirectGroupMember(String username,
                                       String groupName)
                                throws ApplicationPermissionException,
                                       InvalidAuthenticationException,
                                       OperationFailedException

Specified by:: isUserDirectGroupMember in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

isUserNestedGroupMember

public boolean isUserNestedGroupMember(String username,
                                       String groupName)
                                throws ApplicationPermissionException,
                                       InvalidAuthenticationException,
                                       OperationFailedException

Specified by:: isUserNestedGroupMember in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

isGroupDirectGroupMember

public boolean isGroupDirectGroupMember(String childName,
                                        String parentName)
                                 throws ApplicationPermissionException,
                                        InvalidAuthenticationException,
                                        OperationFailedException

Specified by:: isGroupDirectGroupMember in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

addUserToGroup

public void addUserToGroup(String username,
                           String groupName)
                    throws GroupNotFoundException,
                           UserNotFoundException,
                           ApplicationPermissionException,
                           InvalidAuthenticationException,
                           OperationFailedException,
                           MembershipAlreadyExistsException

Specified by:: addUserToGroup in interface CrowdClient
Throws:: GroupNotFoundException; UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException; MembershipAlreadyExistsException

addGroupToGroup

public void addGroupToGroup(String childGroup,
                            String parentGroup)
                     throws GroupNotFoundException,
                            ApplicationPermissionException,
                            InvalidAuthenticationException,
                            OperationFailedException,
                            MembershipAlreadyExistsException

Specified by:: addGroupToGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException; MembershipAlreadyExistsException

removeUserFromGroup

public void removeUserFromGroup(String username,
                                String groupName)
                         throws MembershipNotFoundException,
                                GroupNotFoundException,
                                UserNotFoundException,
                                ApplicationPermissionException,
                                InvalidAuthenticationException,
                                OperationFailedException

Specified by:: removeUserFromGroup in interface CrowdClient
Throws:: MembershipNotFoundException; GroupNotFoundException; UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

removeGroupFromGroup

public void removeGroupFromGroup(String childGroup,
                                 String parentGroup)
                          throws MembershipNotFoundException,
                                 GroupNotFoundException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: removeGroupFromGroup in interface CrowdClient
Throws:: MembershipNotFoundException; GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

testConnection

public void testConnection()
                    throws ApplicationPermissionException,
                           InvalidAuthenticationException,
                           OperationFailedException

Specified by:: testConnection in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchUsers

public List<User> searchUsers(SearchRestriction searchRestriction,
                              int startIndex,
                              int maxResults)
                       throws ApplicationPermissionException,
                              InvalidAuthenticationException,
                              OperationFailedException

Specified by:: searchUsers in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchUsersWithAttributes

public List<UserWithAttributes> searchUsersWithAttributes(SearchRestriction searchRestriction,
                                                          int startIndex,
                                                          int maxResults)
                                                   throws ApplicationPermissionException,
                                                          InvalidAuthenticationException,
                                                          OperationFailedException

Specified by:: searchUsersWithAttributes in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchUserNames

public List<String> searchUserNames(SearchRestriction searchRestriction,
                                    int startIndex,
                                    int maxResults)
                             throws ApplicationPermissionException,
                                    InvalidAuthenticationException,
                                    OperationFailedException

Specified by:: searchUserNames in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchGroups

public List<Group> searchGroups(SearchRestriction searchRestriction,
                                int startIndex,
                                int maxResults)
                         throws ApplicationPermissionException,
                                InvalidAuthenticationException,
                                OperationFailedException

Specified by:: searchGroups in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchGroupsWithAttributes

public List<GroupWithAttributes> searchGroupsWithAttributes(SearchRestriction searchRestriction,
                                                            int startIndex,
                                                            int maxResults)
                                                     throws ApplicationPermissionException,
                                                            InvalidAuthenticationException,
                                                            OperationFailedException

Specified by:: searchGroupsWithAttributes in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

searchGroupNames

public List<String> searchGroupNames(SearchRestriction searchRestriction,
                                     int startIndex,
                                     int maxResults)
                              throws ApplicationPermissionException,
                                     InvalidAuthenticationException,
                                     OperationFailedException

Specified by:: searchGroupNames in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getUsersOfGroup

public List<User> getUsersOfGroup(String groupName,
                                  int startIndex,
                                  int maxResults)
                           throws GroupNotFoundException,
                                  ApplicationPermissionException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: getUsersOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfUsersOfGroup

public List<String> getNamesOfUsersOfGroup(String groupName,
                                           int startIndex,
                                           int maxResults)
                                    throws GroupNotFoundException,
                                           ApplicationPermissionException,
                                           InvalidAuthenticationException,
                                           OperationFailedException

Specified by:: getNamesOfUsersOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getChildGroupsOfGroup

public List<Group> getChildGroupsOfGroup(String groupName,
                                         int startIndex,
                                         int maxResults)
                                  throws GroupNotFoundException,
                                         ApplicationPermissionException,
                                         InvalidAuthenticationException,
                                         OperationFailedException

Specified by:: getChildGroupsOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfChildGroupsOfGroup

public List<String> getNamesOfChildGroupsOfGroup(String groupName,
                                                 int startIndex,
                                                 int maxResults)
                                          throws GroupNotFoundException,
                                                 ApplicationPermissionException,
                                                 InvalidAuthenticationException,
                                                 OperationFailedException

Specified by:: getNamesOfChildGroupsOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getGroupsForUser

public List<Group> getGroupsForUser(String userName,
                                    int startIndex,
                                    int maxResults)
                             throws UserNotFoundException,
                                    ApplicationPermissionException,
                                    InvalidAuthenticationException,
                                    OperationFailedException

Specified by:: getGroupsForUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getGroupsWithAttributesForUser

public List<GroupWithAttributes> getGroupsWithAttributesForUser(String userName,
                                                                int startIndex,
                                                                int maxResults)
                                                         throws UserNotFoundException,
                                                                ApplicationPermissionException,
                                                                InvalidAuthenticationException,
                                                                OperationFailedException

Specified by:: getGroupsWithAttributesForUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfGroupsForUser

public List<String> getNamesOfGroupsForUser(String userName,
                                            int startIndex,
                                            int maxResults)
                                     throws UserNotFoundException,
                                            ApplicationPermissionException,
                                            InvalidAuthenticationException,
                                            OperationFailedException

Specified by:: getNamesOfGroupsForUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getParentGroupsForGroup

public List<Group> getParentGroupsForGroup(String groupName,
                                           int startIndex,
                                           int maxResults)
                                    throws GroupNotFoundException,
                                           ApplicationPermissionException,
                                           InvalidAuthenticationException,
                                           OperationFailedException

Specified by:: getParentGroupsForGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfParentGroupsForGroup

public List<String> getNamesOfParentGroupsForGroup(String groupName,
                                                   int startIndex,
                                                   int maxResults)
                                            throws GroupNotFoundException,
                                                   ApplicationPermissionException,
                                                   InvalidAuthenticationException,
                                                   OperationFailedException

Specified by:: getNamesOfParentGroupsForGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNestedUsersOfGroup

public List<User> getNestedUsersOfGroup(String groupName,
                                        int startIndex,
                                        int maxResults)
                                 throws GroupNotFoundException,
                                        ApplicationPermissionException,
                                        InvalidAuthenticationException,
                                        OperationFailedException

Specified by:: getNestedUsersOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfNestedUsersOfGroup

public List<String> getNamesOfNestedUsersOfGroup(String groupName,
                                                 int startIndex,
                                                 int maxResults)
                                          throws GroupNotFoundException,
                                                 ApplicationPermissionException,
                                                 InvalidAuthenticationException,
                                                 OperationFailedException

Specified by:: getNamesOfNestedUsersOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNestedChildGroupsOfGroup

public List<Group> getNestedChildGroupsOfGroup(String groupName,
                                               int startIndex,
                                               int maxResults)
                                        throws GroupNotFoundException,
                                               ApplicationPermissionException,
                                               InvalidAuthenticationException,
                                               OperationFailedException

Specified by:: getNestedChildGroupsOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfNestedChildGroupsOfGroup

public List<String> getNamesOfNestedChildGroupsOfGroup(String groupName,
                                                       int startIndex,
                                                       int maxResults)
                                                throws GroupNotFoundException,
                                                       ApplicationPermissionException,
                                                       InvalidAuthenticationException,
                                                       OperationFailedException

Specified by:: getNamesOfNestedChildGroupsOfGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getGroupsForNestedUser

public List<Group> getGroupsForNestedUser(String userName,
                                          int startIndex,
                                          int maxResults)
                                   throws UserNotFoundException,
                                          ApplicationPermissionException,
                                          InvalidAuthenticationException,
                                          OperationFailedException

Specified by:: getGroupsForNestedUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfGroupsForNestedUser

public List<String> getNamesOfGroupsForNestedUser(String userName,
                                                  int startIndex,
                                                  int maxResults)
                                           throws UserNotFoundException,
                                                  ApplicationPermissionException,
                                                  InvalidAuthenticationException,
                                                  OperationFailedException

Specified by:: getNamesOfGroupsForNestedUser in interface CrowdClient
Throws:: UserNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getParentGroupsForNestedGroup

public List<Group> getParentGroupsForNestedGroup(String groupName,
                                                 int startIndex,
                                                 int maxResults)
                                          throws GroupNotFoundException,
                                                 ApplicationPermissionException,
                                                 InvalidAuthenticationException,
                                                 OperationFailedException

Specified by:: getParentGroupsForNestedGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getNamesOfParentGroupsForNestedGroup

public List<String> getNamesOfParentGroupsForNestedGroup(String groupName,
                                                         int startIndex,
                                                         int maxResults)
                                                  throws GroupNotFoundException,
                                                         ApplicationPermissionException,
                                                         InvalidAuthenticationException,
                                                         OperationFailedException

Specified by:: getNamesOfParentGroupsForNestedGroup in interface CrowdClient
Throws:: GroupNotFoundException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getMemberships

public Iterable<Membership> getMemberships()
                                    throws OperationFailedException,
                                           ApplicationPermissionException,
                                           InvalidAuthenticationException,
                                           UnsupportedCrowdApiException

Specified by:: getMemberships in interface CrowdClient
Throws:: OperationFailedException; ApplicationPermissionException; InvalidAuthenticationException; UnsupportedCrowdApiException

findUserFromSSOToken

public User findUserFromSSOToken(String token)
                          throws InvalidTokenException,
                                 ApplicationPermissionException,
                                 InvalidAuthenticationException,
                                 OperationFailedException

Specified by:: findUserFromSSOToken in interface CrowdClient
Throws:: InvalidTokenException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

authenticateSSOUser

public String authenticateSSOUser(UserAuthenticationContext userAuthenticationContext)
                           throws ApplicationAccessDeniedException,
                                  ExpiredCredentialException,
                                  InactiveAccountException,
                                  ApplicationPermissionException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: authenticateSSOUser in interface CrowdClient
Throws:: ApplicationAccessDeniedException; ExpiredCredentialException; InactiveAccountException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

authenticateSSOUser

public String authenticateSSOUser(UserAuthenticationContext userAuthenticationContext,
                                  long duration)
                           throws ApplicationAccessDeniedException,
                                  ExpiredCredentialException,
                                  InactiveAccountException,
                                  ApplicationPermissionException,
                                  InvalidAuthenticationException,
                                  OperationFailedException

Specified by:: authenticateSSOUser in interface CrowdClient
Throws:: ApplicationAccessDeniedException; ExpiredCredentialException; InactiveAccountException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

authenticateSSOUserWithoutValidatingPassword

public String authenticateSSOUserWithoutValidatingPassword(UserAuthenticationContext userAuthenticationContext)
                                                    throws ApplicationAccessDeniedException,
                                                           InactiveAccountException,
                                                           ApplicationPermissionException,
                                                           InvalidAuthenticationException,
                                                           OperationFailedException

Specified by:: authenticateSSOUserWithoutValidatingPassword in interface CrowdClient
Throws:: ApplicationAccessDeniedException; InactiveAccountException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

validateSSOAuthentication

public void validateSSOAuthentication(String token,
                                      List<ValidationFactor> validationFactors)
                               throws InvalidTokenException,
                                      ApplicationPermissionException,
                                      InvalidAuthenticationException,
                                      OperationFailedException

Specified by:: validateSSOAuthentication in interface CrowdClient
Throws:: InvalidTokenException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

validateSSOAuthenticationAndGetSession

public Session validateSSOAuthenticationAndGetSession(String token,
                                                      List<ValidationFactor> validationFactors)
                                               throws InvalidTokenException,
                                                      ApplicationPermissionException,
                                                      InvalidAuthenticationException,
                                                      OperationFailedException

Specified by:: validateSSOAuthenticationAndGetSession in interface CrowdClient
Throws:: InvalidTokenException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

invalidateSSOToken

public void invalidateSSOToken(String token)
                        throws ApplicationPermissionException,
                               InvalidAuthenticationException,
                               OperationFailedException

Specified by:: invalidateSSOToken in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

invalidateSSOTokensForUser

public void invalidateSSOTokensForUser(String username)
                                throws OperationFailedException,
                                       ApplicationPermissionException,
                                       InvalidAuthenticationException,
                                       UnsupportedCrowdApiException

Specified by:: invalidateSSOTokensForUser in interface CrowdClient
Throws:: OperationFailedException; ApplicationPermissionException; InvalidAuthenticationException; UnsupportedCrowdApiException

invalidateSSOTokensForUser

public void invalidateSSOTokensForUser(String username,
                                       String exclude)
                                throws OperationFailedException,
                                       ApplicationPermissionException,
                                       InvalidAuthenticationException,
                                       UnsupportedCrowdApiException

Specified by:: invalidateSSOTokensForUser in interface CrowdClient
Throws:: OperationFailedException; ApplicationPermissionException; InvalidAuthenticationException; UnsupportedCrowdApiException

getCookieConfiguration

public CookieConfiguration getCookieConfiguration()
                                           throws ApplicationPermissionException,
                                                  InvalidAuthenticationException,
                                                  OperationFailedException

Specified by:: getCookieConfiguration in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface CrowdClient

getCurrentEventToken

public String getCurrentEventToken()
                            throws ApplicationPermissionException,
                                   InvalidAuthenticationException,
                                   OperationFailedException,
                                   IncrementalSynchronisationNotAvailableException

Specified by:: getCurrentEventToken in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException; IncrementalSynchronisationNotAvailableException

getNewEvents

public Events getNewEvents(String eventToken)
                    throws EventTokenExpiredException,
                           ApplicationPermissionException,
                           InvalidAuthenticationException,
                           OperationFailedException

Specified by:: getNewEvents in interface CrowdClient
Throws:: EventTokenExpiredException; ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

getWebhook

public String getWebhook(long webhookId)
                  throws InvalidAuthenticationException,
                         ApplicationPermissionException,
                         OperationFailedException,
                         WebhookNotFoundException

Specified by:: getWebhook in interface CrowdClient
Throws:: InvalidAuthenticationException; ApplicationPermissionException; OperationFailedException; WebhookNotFoundException

registerWebhook

public long registerWebhook(String endpointUrl,
                            @Nullable
                            String token)
                     throws ApplicationPermissionException,
                            InvalidAuthenticationException,
                            OperationFailedException

Specified by:: registerWebhook in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

unregisterWebhook

public void unregisterWebhook(long webhookId)
                       throws ApplicationPermissionException,
                              InvalidAuthenticationException,
                              OperationFailedException,
                              WebhookNotFoundException

Specified by:: unregisterWebhook in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException; WebhookNotFoundException

expireAllPasswords

public void expireAllPasswords()
                        throws ApplicationPermissionException,
                               InvalidAuthenticationException,
                               OperationFailedException

Specified by:: expireAllPasswords in interface CrowdClient
Throws:: ApplicationPermissionException; InvalidAuthenticationException; OperationFailedException

Class RestCrowdClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RestCrowdClient

RestCrowdClient

Method Detail

getUser

getUserWithAttributes

getUserByKey

authenticateUser

userAuthenticated

addUser

addUser

updateUser

renameUser

updateUserCredential

requestPasswordReset

requestUsernames

storeUserAttributes

removeUserAttributes

removeUser

getGroup

getGroupWithAttributes

addGroup

updateGroup

storeGroupAttributes

removeGroupAttributes

removeGroup

isUserDirectGroupMember

isUserNestedGroupMember

isGroupDirectGroupMember

addUserToGroup

addGroupToGroup

removeUserFromGroup

removeGroupFromGroup

testConnection

searchUsers

searchUsersWithAttributes

searchUserNames

searchGroups

searchGroupsWithAttributes

searchGroupNames

getUsersOfGroup

getNamesOfUsersOfGroup

getChildGroupsOfGroup

getNamesOfChildGroupsOfGroup

getGroupsForUser

getGroupsWithAttributesForUser

getNamesOfGroupsForUser

getParentGroupsForGroup

getNamesOfParentGroupsForGroup

getNestedUsersOfGroup

getNamesOfNestedUsersOfGroup

getNestedChildGroupsOfGroup

getNamesOfNestedChildGroupsOfGroup

getGroupsForNestedUser

getNamesOfGroupsForNestedUser

getParentGroupsForNestedGroup

getNamesOfParentGroupsForNestedGroup

getMemberships

findUserFromSSOToken

authenticateSSOUser

authenticateSSOUser

authenticateSSOUserWithoutValidatingPassword

validateSSOAuthentication

validateSSOAuthenticationAndGetSession

invalidateSSOToken

invalidateSSOTokensForUser

invalidateSSOTokensForUser

getCookieConfiguration

shutdown

getCurrentEventToken

getNewEvents

getWebhook

registerWebhook

unregisterWebhook

expireAllPasswords