Difference between revisions of "Scout/SDK/JAXWS-SDK/Create webservice provider"

Revision as of 04:37, 10 November 2011

The Scout documentation has been moved to https://eclipsescout.github.io/. 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 [1].

Create webservice provider from scratch or based on a WSDL file

First, you are asked whether to create the webservice provider from scratch or based on an existinig WSDL file [2]. Depending on your choice, the next wizard step differs.

Please note
Depending on your choice on this wizard step, the next step differs. By any choice you configure the endpoint and an alias in the next step - meaning at which URL the webservice is to be published (URL pattern) and what would be the name of your webservice provider (alias).

Create webservice provider from scratch

When choosing the option from scratch, you are asked to specify properties to create the WSDL file [3] and to configure the endpoint. When entering the WSDL name, the other fields get auto-completed due to naming convention rules. That is if the checkbox Derive other names from WSDL file name is checked. Nevertheless, the value for those derived fields can be overwritten to your taste.

Create webservice provider based on an existing WSDL file

When choosing the option to use an existing WSDL file in the first wizard step, you are asked to choose the WSDL file either from the filesystem or an URL [4]. If the WSDL file consists of multiple files such as separate files for Port and Binding definitions as well as separate files for XSD Schema types, use the first option and specify those files as related files. If you choose the WSDL from URL, press TAB or click somewhere outside the URL field to validate and download the WSDL file.

Click next to continue. Here you are asked to configure the endpoint - that is which PortType you'd like to publish and at which URL it should be accessible [5].

Create Webservice Provider

Choose to create the webservice provider from scratch or based on an existing WSDL file

Specify WSDL and endpoint publish properties

Choose exising WSDL file

Specify endpoint publish properties

Choose Service and Port

In the next wizard step, you are asked to choose from the available Services and Ports [6] - service and port are used to uniquely resolve the port type to be used the by webservice consumer. If you are not sure which service or port to use, address to the webservice provider about their meaning and usage. Please note, that the port list is based on the service selection. By default, Scout SDK chooses the first service found in WSDL file and derives the associated port.

Control the Stub Generation Process

In the next wizard step, you have the possiblity to specify a custom package name for the stub files to be generated [7]. Please note, that the stub is generatged into a separate JAR-file, so the package name is not that important.

In general, you should not set a custom package because this instruments JAX-WS builder to not apply the default package name algorithm and to ignore any WSDL and schema binding customization for package name. Typically, the default package name algorithm derives the package name based on the targetNamespace of the webservice to be built. In some situations, this name might not be a valid Java package name and requires you to specify a custom package name.

Also, you can specify to create a binding file to customize JAX-WS default bindings [8]. By default, such a file is created. In the default binding-file, there is a global binding configured to unmarshall any xsd:date, xsd:time and xsd:dateTime to a java.util.Date represented as UTC time. If you do not choose to create such a binding-file, you can do it anytime later in Scout SDK. Please note that changes in the binding-file are to instrument the stub build process, meaning that changes require are rebuild of the webservice stub.

Webservice Client

Finally, you can change the default name and default package name of the Scout Service which is created to represent the webservice [9]. This is just like all other services in Scout. Basically, they are plain OSGi services which are registered in plugin.xml and are accessible by SERVICES.get(XyWebServiceClient.class).

Also, you can choose to annotate the service with The Scout documentation has been moved to https://eclipsescout.github.io/.. This allows you to specify an authentication mechanism to be used when connecting to the endpoint service [10]. By default, you can choose from The Scout documentation has been moved to https://eclipsescout.github.io/. and The Scout documentation has been moved to https://eclipsescout.github.io/. as authentication mechanism. If no authentication is to be applied, choose NONE as authentication mechanism. org.eclipse.scout.jaxws.CreateWebServiceProvider_0

Create Webservice Provider

Choose to create the webservice provider from scratch or based on an existing WSDL file

Specify WSDL file and endpoint publish properties

Choose exising WSDL file

Specify endpoint publish properties

Choose Service and Port from WSDL file

Specify custom package name and to create a binding file

Specify name and package for Consumer Service

Choose authentication method to provide user's credentials