Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Scout/SDK/JAXWS-SDK/Create webservice provider"
Line 14: | Line 14: | ||
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 [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_25.png]. | 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 [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_25.png]. | ||
+ | == 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 [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_30.png]. Please note, that the stub is generatged into a separate [http://en.wikipedia.org/wiki/JAR_%28file_format%29 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 [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_30.png]. By default, such a file is created. In the default binding-file, there is a global binding configured to unmarshall any <code>xsd:date</code>, <code>xsd:time</code> and <code>xsd:dateTime</code> to a <code>java.util.Date</code> 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. | ||
+ | == Implementing Port Type == | ||
+ | Finally, you configure the name and location of the implementing port type. That is the class to process webservice requests, meaning that you implement the business logic of the webservice in there [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_40.png]. | ||
+ | |||
+ | Furthermore, you configure the authentication mechanism to be installed and how the request's credentials are to be validated. By default, {{ScoutLink|Concepts|JAXWS-RT|BasicAuthenticationHandler}} is used as authentication mechanism and {{ScoutLink|Concepts|JAXWS-RT|ConfigIniCredentialValidationStrategy}} as credential validation strategy. [http://en.wikipedia.org/wiki/Basic_access_authentication Basic Access Authentication] means, that the caller must provide his credentials in HTTP headers. If you choose {{ScoutLink|Concepts|JAXWS-RT|ConfigIniCredentialValidationStrategy}}, the provided username and password are validated against valid credentials configured in config.ini. | ||
+ | |||
+ | |||
+ | <pre>org.eclipse.scout.jaxws216.security.provider.ConfigIniCredentialValidationStrategy#credentials=sean\=XXXX;jack\=XXXX;kimberley\=XXXX</code></pre> | ||
+ | |||
+ | |||
+ | caller must include his credentials in the a BASIC HTTP header | ||
+ | |||
+ | to be installed and the session context on its behalf the request is run. | ||
+ | |||
+ | Finally, you can change the default name and default package name of the Scout Service which is created to represent the webservice [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateConsumer_50.png]. 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 <code>SERVICES.get(XyWebServiceClient.class)</code>. | ||
+ | |||
+ | Also, you can choose to annotate the service with {{ScoutLink|Concepts|JAXWS-RT|ScoutWebServiceClient}}. This allows you to specify an authentication mechanism to be used when connecting to the endpoint service [http://wiki.eclipse.org/Image:Org.eclipse.scout.jaxws.CreateConsumer_55.png]. By default, you can choose from {{ScoutLink|Concepts|JAXWS-RT|BasicAuthenticationHandler}} and {{ScoutLink|Concepts|JAXWS-RT|WsseUsernameTokenAuthenticationHandler}} as authentication mechanism. If no authentication is to be applied, choose NONE as authentication mechanism. | ||
Line 26: | Line 46: | ||
[[Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_25.png|thumb|Specify endpoint publish properties]] | [[Image:Org.eclipse.scout.jaxws.CreateWebServiceProvider_25.png|thumb|Specify endpoint publish properties]] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
org.eclipse.scout.jaxws.CreateWebServiceProvider_0 | org.eclipse.scout.jaxws.CreateWebServiceProvider_0 | ||
Revision as of 04:58, 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].
Contents
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.
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].
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 [6]. 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 [7]. 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.
Implementing Port Type
Finally, you configure the name and location of the implementing port type. That is the class to process webservice requests, meaning that you implement the business logic of the webservice in there [8].
Furthermore, you configure the authentication mechanism to be installed and how the request's credentials are to be validated. By default, The Scout documentation has been moved to https://eclipsescout.github.io/. is used as authentication mechanism and The Scout documentation has been moved to https://eclipsescout.github.io/. as credential validation strategy. Basic Access Authentication means, that the caller must provide his credentials in HTTP headers. If you choose The Scout documentation has been moved to https://eclipsescout.github.io/., the provided username and password are validated against valid credentials configured in config.ini.
org.eclipse.scout.jaxws216.security.provider.ConfigIniCredentialValidationStrategy#credentials=sean\=XXXX;jack\=XXXX;kimberley\=XXXX</code>
caller must include his credentials in the a BASIC HTTP header
to be installed and the session context on its behalf the request is run.
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