Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: for the plan.

Jump to: navigation, search

Scout/Tutorial/3.9/webservices/Webservices with JAX-WS

< Scout‎ | Tutorial‎ | 3.9‎ | webservices(Redirected from Scout/Tutorial/3.9/webservices)

Wiki Home


This tutorial is a guide to developing JAX-WS webservices in Eclipse Scout. JAX-WS stands for Java API for XML Web Services. The JAX-WS version supported by Eclipse Scout is JAX-WS RI 2.1.6 bundled with Java SE 6. We are not using the lastest version (such as JAX-WS RI 2.2.5) because we encountered a lot of problems in having a newer version aside the Java built-in internal JAX-WS RI 2.1.6 implementation.

The scope of this tutorial is to create a simple Scout application with a webservice consumer and a webservice provider installed. The application will load company data from a Derby database and allow the user to request a company's stock price with a 20 minute delay from the public StockQuoteService. Also, a webservice will be published to access the application's company data from within another application.


The completed projects for this tutorial can be downloaded from this Git repository org.eclipsescout.demo/jaxws (GitHub).

In order to run the tutorial you need to have the Derby database installed on your system. A ready-to-go database can be downloaded from Alternatively, the database can be created from scratch by using the SQL script create_database.sql. Learn more on how to setup the derby database from scratch.


For this tutorial to work, you will have to use a JDK (Java Development Kit).

Also, if you have multipe JDK versions installed, make sure you use the same version in your workspace as you use to run Eclipse itself. To check this go to Window > Preferences > Java > Installed JREs. In the list on the right hand side ensure that only one version is listed and that this version matches the one that the running Eclipse is using.

Installed JREs.png

Go to Window > Preferences. Click on Java > Installed JREs and make sure, that a jdk-version is installed. Choose the jdk-version and click on Edit.... Check, if there is a file named tools.jar. If it does not, click on Add External JARs... and choose the file {sdk_folder}/lib/tools.jar.

During this tutorial we will analyze and edit WSDL files. To do this in a convenient way we need to install the Eclipse WSDL editor if not already installed. To check this go to Help > About Eclipse and press the Installation Details button. On the next dialog switch to the Features tab and check if there exists an entry named Eclipse XML Editors and Tools (column Feature Name).

Org.eclipse.scout.jaxws.WSDLExisting 01.png

If this entry exists, the WSDL Editor is already installed and you can jump to the next section. Otherwise continue with the following steps:

  1. Go to Help > Install New Software....
  2. Select the 'Kepler' updatesite from the 'Work with' listbox.
  3. Under the category Web, XML, Java EE and OSGi Enterprise Development check Eclipse XML Editors and Tools.
  4. Click next, next, read and accept the license and press finish.
  5. After the download and the installation has been completed restart Eclipse and the WSDL Editor has been installed successfully.

Preliminary work

First of all, you have to create a new Scout project.

Afterwards, create a Derby SQL Service to access company data and to persist webservice log entries.

In order to display data from the database, create a Company Table Page.

To display stock quote information for a company, create a Company Form.

To track webservice requests, they are logged into the database for this tutorial. This is why a WS Log Table Page and WS Log Form are to be created.

Ensure JAX-WS support is enabled for your project

In order to have JAX-WS support available in the project, select the project node org.eclipsescout.demo.jaxws in the Scout Explorer. In the Scout Object Properties scroll to the Technologies section and ensure the checkbox Webservices with JAX-WS RI 2.1.6 is enabled. If not yet checked, enable the technology and confirm the popup dialog with Ok.

If JAX-WS support is enabled correctly you should see the Webservices (JAX-WS RI 2.1.6) under the server node in the Scout Explorer.

Org.eclipse.scout.tutorial.jaxws.EnableJaxWsSupport 1.png

Create Webservice Consumer

On server node, go to the node Webservices (JAX-WS RI 2.1.6) > Consumer > Services. Right-click on that node to create a new webservice consumer.

Create webservice consumer

In the first wizard step, choose the 2nd option WSDL FROM URL and enter the URL to the WSDL file of the stock quote service provider. In the course of this tutorial this would be

Create webservice consumer

By pressing TAB or clicking somewhere outside the URL field, the WSDL file is evaluated. If this is about a valid WSDL file, click Finish to create the webservice consumer. (The page Create webservice consumer provides more information about webservice consumer creation). In case you encounter problems to build the webservice stub, refer to the Console Output for more information.

Please find the created webservice consumer StockQuoteServiceSoapWebServiceClient in Scout Explorer.

Webservice Consumer

In the Scout Property View of this consumer, you can access the various files such as the WSDL file or the service type. Also, there you find links to rebuild the webservice stub, to change build properties for stub generation process, to edit binding customization files and more. Also, the authentication mechanism can be changed in the section Authentication. (The page Webservice consumer Property View provides information on that Property View.)

Next, we have to configure the endpoint URL of the webservice which is For the sake of convenience, we hard-code this URL by specifying the property URL in the Property View.

Set URL of webservice Endpoint

In real life, this would be done in config.ini to distinguish the different systems such as development, integration and production.

Integrate Webservice Consumer in application

Finally, the webservice is ready to be used by our tutorial application. Open the service CompanyService and follow the two steps described below:

Add data conversion methods

Because data provided by the webservice is only of the type xsd:string, we have to convert them to their corresponding types. Please add the following conversion methods to your service.

The corresponding source code is provided here: Conversion methods for StockQuote service.

Please note: use java.util.Date for the Date class and not e.g. java.sql.Date!

Change load-method to access webservice

We have to change the implementation of CompanyService#load(CompanyFormData) to access the stock quote webservice and include quote information for that company in the FormData.

Please change the service's implementation as following:Source code for the CompanyService.

Finally, if you launch the application, you should see something like this:

Application displaying stock quote consumed by webservice

Log Webservice Consumer's SOAP messages

In order to log the SOAP messages for request and response, we have to add a LogHandler to the webservice client. In Scout, there already exists a simple version of such a log handler, but the log is only written to the logging facade, not to the database. That is why we write our own DatabaseLogHandler that inherits from the Scout LogHandler.

Because handlers can be used in both, consumers and providers, they are located in Webservices (JAX-WS RI 2.1.6) > Handlers. Right-click on that node to create a new Handler.

Create new Handler

In the dialog, enter the following values:

  • Name: DatabaseLogHandler
  • Package: <do not change>
  • Super Type: LogHandler (click on 'Browse' to search for that type)
  • Run in Scout transaction: check because we are writing to database
  • Session factory: <do not change>

Create new DatabaseLogHandler

Double-click on the handler and implement it as following: source code for DatabaseLogHandler

After the handler is created, go back to the webservice consumer StockQuoteServiceSoapWebServiceClient. In Scout Property View, click on Exec Install Handlers to register the handler

Register Handler on consumer

Simply add the DatabaseLogHandler to the list of handlers. Click here to get the source code.

Finally, if you launch the application and open a company, the SOAP messages are written into the database. In turn, if you open a log message, you should see something like this:

Webservice Log in application

Create Webservice Provider

On server node, go to the node Webservices (JAX-WS RI 2.1.6) > Provider > Services'. Right-click on that node to create a new webservice provider.

Create webservice provider

In the first wizard step, choose the 1st option to create a webservice provider from scratch, meaning not based on an existing WSDL file

Choose how to create the webservice provider.

Click next (two times) to enter the WSDL name which is CompanyWebService.wsdl. Also, change the name for the service operation to getCompanies .

Specify webservice properties

Click Finish to create the webservice provider. (The page Create webservice provider provides more information about webservice provider creation). In case you encounter problems to build the webservice stub, refer to the Console Output for more information.

Please find the created webservice provider CompanyWebService in Scout Explorer.

Webservice provider

In the Scout Property View of this provider, you can access the various files such as the WSDL file, implementation class or the JAX-WS service type. Also, there you find links to rebuild the webservice stub, to change build properties for stub generation process, to edit binding customization files and more. Also, the authentication mechanism can be changed in the section Authentication and session context. For more information on that Property View, please see the page Webservice provider Property View.

So far, our webservice consists of a single operation to return companies. To open the WSDL file in the WSDL editor, click on the link CompanyWebService.wsdl in the Scout Property View

Open WSDL file of the CompanyWebService.

To open the implementing port type, double click the webservice node or click on the CompanyWebService link in the PropertyView

Open webservice Port Type.

As you can see, this webservice consists of a single operation getCompanies with a String as its return value and a String as its parameter. We will change that to return a list of company objects with no input parameter. Because this webservice is a Contract-First webservice, meaning that we are designing the WSDL file by ourself rather than generating it based on Java classes, open the WSDL editor to change the service:

Org.eclipse.scout.jaxws.CreateWebServiceProvider 50.png

Detailed instructions are provided here: Change WSDL file to return a list of companies. Alternatively, you can download the changed WSDL file from the repository: CompanyWebService.wsdl.

As you changed the WSDL file, you have to regenerate the stub anew. Thereto, click on Rebuild webservice stub in the Scout Property View of the provider.

Rebuild webservice stub.

If the WSDL file is valid, the stub generation will succeed. Otherwise, please refer to the Console Output to see what went wrong. Because we changed the method getCompanies, compilation errors are shown in the CompanyWebService Port Type:

Compilation errors in Port Type due to change of WSDL file

Remove this wrong getCompanies method and add the unimplemented method instead:

Add unimplemented methods of port type interface.

As you can see, the method returns a list of companies. That is exactely what we wanted to have.

Finally, you have to implement the method getCompanies accordingly. Here, we simply return a list of all companies in database. Click here to get the source.

One last thing we still have to do. Because we configured the webservice to have authentication installed and to validate the request's credentials against config.ini, we have to specify the list of valid credentials in config.ini.

Authentication and credential validation settings

Thereto, add the following line to the config.ini: That allows the user eclipse/scout to access our webservice.\=scout;

Log Webservice Providers's SOAP messages

To log the SOAP requests and response, click on Webservices (JAX-WS RI 2.1.6) > Provider > Services > CompanyWebService > Handler Registration.

Add DatabaseLogHandler to CompanyWebService

Click on the link Add handler chain to create a handler chain and Add handler to add a handler to the chain

Add DatabaseLogHandler to CompanyWebService

By clicking on the Browse button, choose DatabaseLogHandler as the log handler.

Test the Webservice Provider

Launch the server and open your browser. Enter the URL http://localhost:8080/tutorial_server/jaxws/ and you get a list of all your installed webservice providers.

This looks as follows:


To test your webservice implementation, download a webservice testing tool such as SoapUI.

In SoapUI, create a new SoapUI project and enter http://localhost:8080/tutorial_server/jaxws/CompanyWebService?wsdl as your initial WSDL file. By double-clicking on the Request 1 node, the request dialog opens. On the property page, enter eclipse as username and scout as password. By clicking on the green play button, the request is sent to your webservice and the SOAP response appears on the right side.

Test webservice with SoapUI

See Also

Back to the top