Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Build your first Web Services with Tuscany

(star) "Creating Your First Web Service with Apache Tuscany video"
This guide will give you step by step instructions on how to build your first web services.
The first part, we will learn how we can add the Tuscany Runtime to Eclipse IDE.
The second part, will show how easy is to create a webservices using Apache Tuscany.

Include Page
Tools - Install the Latest Tuscany Eclipse

...

The first thing you do is to start Eclipse and go to Help -> Software Updates -> Find and Install,
select "Search for new features to install" and then click next

Image Removed

On the next dialog, click on "New Remote Site..." to create a new site entry. Give it a name such as
"Tuscany" and add the site URL as *http://people.apache.org/~jsdelfino/tuscany/tools/updatesite/*Image Removed

Image Removed

Make sure the "Remote  Site" that was just created is selected, and click "Finish"

Image Removed

Select the "Apache Tuscany SCA Tools" and click "Next", and then, on the next dialog, click "Finish"

Image Removed

Accept the "Plugin License"

Image Removed

and next click on "Install All"

Image Removed

When asked to "restart eclipse", click the  "yes" button. 

Image Removed

Create your 1st Composite Service Application

The following shows the composition diagram for the composite service application you are about
to create.

Image Removed

The composite service application you will create is a composition of four services. The composed
service provided is that of an on-line store.
There is a Catalog service which you can ask for catalog items, and depending on its currency
code property configuration it will provide the item prices in USD or EUR. The Catalog service is not
doing the currency conversion itself it references a CurrencyConverter service to do that task. Then
there is the ShoppingCart service into which items chosen from the catalog can be added, it is
implemented as a REST service. The Catalog is bound using the JSONRPC binding, and the
ShoppingCart service is bound using the ATOM binding. Finally there is the Store user facing
service that provides the browser based user interface of the store. The Store service makes use of
the Catalog and ShoppingCart service using the JSONRPC, and ATOM binding respectively.

Plugin
Tools - Install the Latest Tuscany Eclipse Plugin

Create your Service Business Logic

Create a Java Project

In this step you create a Java Project in Eclipse to hold the composite service application.
Click on the New Java Project button   in the toolbar to launch the project creation dialog.
Next you enter "ws" as the Project name, and for Project Layout select Create separate
folders for sources and class files.
Image Removed Image Added
 
Image Removed Image Added
 
Hit the Next button, and on the following page go to the Libraries tab. Use the Add Library...
button on the right to add the Tuscany Library library to the project.
 
Image Removed Image Added
 
 
Hit the Finish button to complete the New Java Project dialog to create the "storews" java project. 
 
Image Removed Image Added
 
 

Construct Services

...

Next you enter "helloworld" as the package Name, and press the Finish button to complete the
dialog.
Image Removed Image Added
 

HelloWorld

In this step you create the HelloWorld service interface and implementation.
Select the "helloworld" package. Next you click on the dropdown arrow next to the New Java Class
button    and select the New Java Interface    option from the dropdown list. In the dialog
enter "HelloWorld" as the Name of the interface and select the Finish button to complete the dialog.
The Java editor will open on the new created Java interface. Replace the content of the editor by
copy-paste of the following Java interface code snippet.

Code Block
package helloworld;
import org.osoa.sca.annotations.Remotable;
@Remotable
public interface HelloWorld {
    String[] sayHello(String name);
}

Select the "helloworld" package again. Select the New Java Class button . In the dialog enter
"HelloWorldImpl" as the Name of the class, add "Catalog" as the interface this class implements, and
then select Finish to complete the dialog.

...

After completing these steps the content of the "ws" project will look as follows.
Image Removed
 
Note: CatalogImpl is red x'ed because it makes use of the CurrencyConverter interface that we
have not implemented yet.
Image Added
 

Compose Services

Now that you have all the required service implementations you compose them together to provide
the store helloworld composite service. The composition is stored in a .composite file.

...

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<composite	 xmlns="http://www.osoa.org/xmlns/sca/1.0"
			    xmlns:t="http://tuscany.apache.org/xmlns/sca/1.0"
			    xmlns:c="http://helloworld"
    targetNamespace="http://helloworld"
			    name="helloworld">


	<component name="HelloWorldComponent">
		<implementation.java class="helloworld.HelloWorldImpl"/>
		<service name="HelloWorld">
			<binding.ws uri="http://localhost:8080/HelloWorld"/>
		</service>
	</component>
</composite>

After completing these steps the content of the "storews" project will look as follows.

Image AddedImage Removed
 

Congratulations you completed your 1st composite service applications, now its time to take it into
action.

...

The Eclipse console will show the following messages.

 Image RemovedImage Added

 Next Launch your Web browser and enter the following address:

http://localhost:8080/HelloWorld?wsdl 

You should now have your web service live, and the url should give you back a generated wsdl for the service.

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://helloworld" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:ns0="http://helloworld" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:ns1="http://org.apache.axis2/xsd" xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
  <wsdl:types>
    <xs:schema attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://helloworld" xmlns:ns="http://helloworld">
         <xs:element name="sayHello">
            <xs:complexType>
               <xs:sequence>
                  <xs:element minOccurs="0" name="param0" nillable="true" type="xs:string"/>
               </xs:sequence>
            </xs:complexType>

         </xs:element>
         <xs:element name="sayHelloResponse">
            <xs:complexType>
               <xs:sequence>
                  <xs:element minOccurs="0" name="return" nillable="true" type="xs:string"/>
               </xs:sequence>
            </xs:complexType>
         </xs:element>
      </xs:schema>

  </wsdl:types>
  <wsdl:message name="sayHelloRequest">
    <wsdl:part name="parameters" element="ns0:sayHello">
    </wsdl:part>
  </wsdl:message>
  <wsdl:message name="sayHelloResponse">
    <wsdl:part name="parameters" element="ns0:sayHelloResponse">
    </wsdl:part>
  </wsdl:message>

  <wsdl:portType name="HelloWorldPortType">
    <wsdl:operation name="sayHello">
      <wsdl:input message="ns0:sayHelloRequest" wsaw:Action="urn:sayHello">
    </wsdl:input>
      <wsdl:output message="ns0:sayHelloResponse" wsaw:Action="urn:sayHelloResponse">
    </wsdl:output>
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="HelloWorldHttpBinding" type="ns0:HelloWorldPortType">

    <http:binding verb="POST"/>
    <wsdl:operation name="sayHello">
      <http:operation location="HelloWorld/sayHello"/>
      <wsdl:input>
        <mime:content part="sayHello" type="text/xml"/>
      </wsdl:input>
      <wsdl:output>
        <mime:content part="sayHello" type="text/xml"/>
      </wsdl:output>

    </wsdl:operation>
  </wsdl:binding>
  <wsdl:binding name="HelloWorldSOAP11Binding" type="ns0:HelloWorldPortType">
    <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
    <wsdl:operation name="sayHello">
      <soap:operation soapAction="urn:sayHello" style="document"/>
      <wsdl:input>
        <soap:body use="literal"/>
      </wsdl:input>

      <wsdl:output>
        <soap:body use="literal"/>
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="HelloWorld">
    <wsdl:port name="HelloWorldSOAP11port_http" binding="ns0:HelloWorldSOAP11Binding">
      <soap:address location="http://192.168.209.1:8080/HelloWorld"/>
    </wsdl:port>

    <wsdl:port name="HelloWorldHttpport" binding="ns0:HelloWorldHttpBinding">
      <http:address location="http://192.168.209.1:8080/HelloWorld"/>
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

You are finished. You have created the HelloWorld web service using Apache Tuscany.