SOAP interface

Architecture

The SOAP toolkit Axis from Apache has been integrated with DSpace in order to facilitate a SOAP interface.

User import

updateEPerson

The class org.dspace.webservice.DSpace constitute the Web service implemention of DSpace. The interface to the Web service consist of two methods:

updateEPerson(String username,
              String password,
              String email,
              EPersonField[] fields,
              EPersonGroup[] includedInGroups,
              EPersonGroup[] excludedFromGroups)

updateEPersons(String username,
               String password,
               EPersonUpdate[] epersonUpdate)

If an email does not exist, an user with the specific email is created. Password is the same as the email. If a group specified in includedInGroups does not exist, the update aborts. If a group specified in excludedFromGroups does not exist, it is ignored.

When building war file the web service is automatically included. Axis configuration file is etc/dspace.wsdd which is included in the war file.

Example client

A client, org.dspace.webservice.client.DSpaceClient, that uses the web service has been implemented. Use it as inspiration for your own clients.