Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 43 Next »

Module Overview

GroovyWS is taking over GroovySOAP as CXF replaces XFire. The major difference here is that GroovyWS is using Java5 so if you need to stick to 1.4 please continue to use GroovySOAP.

Warning: Most of the documentation is adapted from the former GroovySOAP documentation and will improve in the future. I tried to make it as accurate as possible but feel free to report any error.

Warning: GroovyWS is Java5 dependent (due to CXF) and has been tested using groovy-1.5.

Warning: In order to use GroovyWS, you must ensure that GroovySOAP is not in your classpath (~/.groovy/lib) 



GroovyWS is available in two packages:

  • as a full jar containing all CXF JARs and dependencies. It is located here
  • as a jar containing all except the jetty server and servlet files. It aimed at being deployed into third party containers. It is located here


You just need to place the above mentioned JAR file in your ${user.home}/.groovy/lib directory.


As the pre-requisites are quite tricky to handle, an all-in-one JAR file is distributed  


The javadoc is here

Getting Started

GroovyWS comes with 2 sets of APIS that are briefly described below using a simple example.

When your service is using groovy beans on the server side, you may want to control the fields that are serialized. This is done using a small xml file located next to your script. A small example is demonstrating this:

When consuming a web service, you may also be using some complex types. Those types are automatically generated from the WSDL, compiled and made available via your classloader. The client API is providing you a method to easily instantiate such a complex object from its name. Obviously, knowing the class name can be difficult when using a complex web service and may require to study the contract (WSDL). In order to help the user, GroovyWS is logging the names of the classes generated on the fly.

The client side can be easily embedded in a Grails application. This is demonstrated hereafter

There exists a lot of public web services. We provide two examples that show how easy it is to use GroovyWS to tap on these resources.

More Information

Using proxies

If you are using a proxy for accessing internet, you can use the following environment variables to get rid of it:

  • proxyHost
  • proxyPort
  • proxy.user
  • proxy.password

or directly use the following in your code:

Using basic authentication

If your server use basic authentication, you need to set up the following properties:

  • http.user
  • http.password

or directly use

Setting a time out value

If your want to set a time out value for the connection to the server just use:

Using SOAP 1.2 (in test/review)

If your server is proposing SOAP 1.2 endpoints, then you can use:


 If you have ideas how the API should look, do not hesitate to post on the user list ;-

Known problems (and work around)


Guillaume Alleon

Source Control


The build process is using gradle.  In order to build the sources from svn, just run:

in the directory conting the source tree.



Mailing List(s)


Issue tracker

There is a GroovyWS category in JIRA


#A nice article from Geertjan's blog with several examples:
#An article explaining the difference between the different WSDL styles

  • No labels