Crowd 2.1 SOAP Java Client Migration guide

This page tells you how to update your SOAP based-client application code when updating from Crowd 2.0.x to Crowd 2.1.0.

SOAP API is no longer available

SOAP API has been removed in Crowd 5.0. For information on how to migrate to REST API, see Crowd SOAP to REST migration guide.

Step 1. Add additional dependency

Add a dependency on crowd-integration-client-api.

1
2
<dependencies>
  <dependency>
    <groupId>com.atlassian.crowd</groupId>
    <artifactId>crowd-integration-client-api</artifactId>
  </dependency>
</dependencies>

Step 2. Update the package names

Some of the classes have moved to a different package.

Class	Update
SecurityServerClient	Old package: `com.atlassian.crowd.integration.service.soap.client` New package: `com.atlassian.crowd.service.soap.client`
UserConstants	Old package: `com.atlassian.crowd.integration.model` New package: `com.atlassian.crowd.model.user`
SearchContext	Old package: `com.atlassian.crowd.integration` New package: `com.atlassian.crowd.model.user`
PasswordCredential	Old package: `com.atlassian.crowd.integration.authentication` New package: `com.atlassian.crowd.embedded.api`
<All exception classes>	Old package: `com.atlassian.crowd.integration.exception` New package: `com.atlassian.crowd.exception`

Step 3. Update exceptions and exception handling

As noted above the exception classes have moved to a new package (com.atlassian.crowd.exception). As well as this the ObjectNotFoundException is now separated into UserNotFoundException, GroupNotFoundException, and DirectoryNotFoundException. Methods which previously threw an ObjectNotFoundException will now throw one or more of these exceptions classes.

Some other changes to exception throwing to highlight:

SecurityServerClient#findPrincipalByName now throws an InvalidAuthenticationException.
SecurityServerClient#searchGroups and SecurityServerClient#searchRoles also throws an InvalidAuthenticationException