Child pages
  • Grouper Web Services Versioning
Skip to end of metadata
Go to start of metadata

Grouper Web Services

Grouper 2.0 web service servers will accept clients coded against the Grouper 1.6 or previous WS API's.  The 2.0 protocol is not exactly compatible with the 1.6 protocol, so both protocols run in the Grouper 2.0 WS server.

Grouper RESTlike is automatic marshaling to/from XML/JSON based on Javabean, but the marshaling will not marshal null data (this is good).  The Grouper WS client passes in its version, and if it is less than 2.0, the new fields will be null, and the response is backwards compatible (does not contain the field).

Grouper SOAP uses auto-marshaling from Axis2 which does not support conditional fields (if null, it send back the field and says it is null).  So there is a new source path for 2.0, WSDL, and a new endpoint, aar, build script entry, etc.  The 1.6 WSDL is on the 2.0 server under the same name, the new one is:GrouperService_v2_0.wsdl.  the new WSDL does have a new target namespace too:

<wsdl:definitions xmlns:wsdl=""
xmlns:xs="" xmlns:mime=""

The 1.6 Javabeans are in a new source folder in 2.0, and there are facilities to auto-transform the 1.6 beans into 2.0 beans and vice versa.

Bottom-line, the SOAP and RESTlike web services are completely backward compatible, and for SOAP, if you are coding against 2.0 (or upgrading), change the endpoint URL from GrouperService to GrouperService_v2_0.  Note, it will be 2.0 until there is a change that is not backwards compatible... that might be 2.1, or 2.2, or whatever.

Note, if your servlet is not grouperWs (e.g. grouper-ws) then adjust accordingly.

Developer information

Note, this means developer as in developers who work on Grouper itself, not developers who are writing web service clients or implementing Grouper.

If you are changing a transfer object, or editing the signatures in coresoap.GrouperService, then you also need to edit the corresponding GrouperService that you want it to be available for.  Typically we dont edit the historical backwards compatible versions, you would only add it to the latest version, e.g. soap_v2_0.GrouperService, or the soap_v2_0.WhateverTransferObject

  • No labels