Getting Started with Tuscany (TUSCANY) edited by Luciano Resende
Page: http://cwiki.apache.org/confluence/display/TUSCANY/Getting+Started+with+Tuscany
Changes: http://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=67902&originalVersion=13&revisedVersion=14
Comment:
---------------------------------------------------------------------
Updating images for Release 1.1
Change summary:
---------------------------------------------------------------------
Updating images for Release 1.1
Change summary:
---------------------------------------------------------------------
Updating images for Release 1.1
Change summary:
---------------------------------------------------------------------
Updating images for Release 1.1
Change summary:
---------------------------------------------------------------------
Updating images for Release 1.1
Content:
---------------------------------------------------------------------
h1. Ready, Set, Go - Getting started with Tuscany
h2. Install the Tuscany Distribution&nbsp;
The first thing you do is to create a folder on you disk into which you will download the
TUSCANY distribution.
!tuscany_folder.jpg!
Next you download the latest release distribution. Launch your browser and enter the following
URL.
Latest Release - [http://cwiki.apache.org/TUSCANY/sca-java-releases.html]
Download both the *{_}bin zip{_}* as well as the *{_}src zip{_}* to the folder that you created
on your disk. Once you completed the download you should see the following on your disk.
!release_zips.jpg!
&nbsp;
Next you unzip the *{_}bin zip{_}* in place, you should see the following folder file structure
on your disk after unzip is complete.
!folder_structure.jpg!
h2. Setup Eclipse for Tuscany
Start Eclipse and create a User Library to contain the TUSCANY runtime jar's as well as their
depending jar's.
>From the menu bar select *{_}Window{_}* and then *{_}Preferences..._* . The Preferences
dialog will appear,
in its left navigation tree select *{_}Java{_}*, followed by *{_}Build Path{_}*, and followed
by *{_}User Libraries{_}*.
Select the *{_}New..._* pushbutton on the right of the New Libraries dialog to create a new
user library.
!New_User_Lib.png!
The user library created is empty, select the *{_}Add JARs..._* pushbutton on the right to
add all the
jar's from your Tuscany installation *{_}lib folder{_}*. When completed all the jar's will
appear under the
TUSCANY user library.
!Tuscany_User_Lib.png!
Since some of you maybe interested in *{_}debugging{_}* also the Tuscany runtime code we will
attach
the Tuscany source to the Tuscany runtime jar in the following step. In the User Libraies
dialog
scroll down until you see the *{_}Tuscany runtime jar{_}* and select its *{_}Source attachment._*
!source_attachment.jpg!
Select the *{_}Edit..._* pushbutton on the right and in the Edit dialog use the *{_}External
File..._* pushbutton
to the select the Tuscany *{_}src zip{_}* that we downloaded earlier.
!source_attachment_config.jpg!
Select *{_}OK{_}* to complete this and the Preferences dialog, and you are done with the Tuscany
setup
for Eclipse.
h2. Create your 1st Composite Service Application
The following shows the composition diagram for the composite service application you are
about
to create.
!first_composite.png!
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.
h2. 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 !new_java_project.png!&nbsp; in the toolbar
to launch the project creation dialog.
Next you enter "store" as the *{_}Project name{_}*, and for *{_}Project Layout{_}* select
*{_}Create separate{_}*
*{_}folders for sources and class files._*
!new_java_project_dlg.png!
&nbsp;
!project_layout.png!
&nbsp;
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 user library to the project.
&nbsp;
!new_java_project_lib.png!
&nbsp;
&nbsp;
Hit the *{_}Finish{_}* button to complete the *{_}New Java Project{_}* dialog to create the
"store" java project.&nbsp;
&nbsp;
!new_java_project_folder.png!
&nbsp;
&nbsp;
h2. Construct Services
First you create two package folders into which later in this step you place service implementations.
Select the "store" project and click on the *{_}New Java Package{_}* button !new_java_pkg_btn.png!
in the toolbar to launch
the package creation dialog.
Next you enter "services" as the package *{_}Name{_}*, and press the *{_}Finish{_}* button
to complete the
dialog.
!new_java_pkg_dlg.png!
&nbsp;
Repeat the previous step to create another package named "ufservices". The store project now
should look as follows.
&nbsp;
!new_java_pkg_folder.png!
&nbsp;
In the following you will place in the "services" package the regular services, and in the
"ufservices"
package the user facing services of the composite service application you create.
h3. _Catalog_
In this step you create the Catalog service interface and implementation.
Select the "services" package. Next you click on the dropdown arrow next to the *{_}New Java
Class{_}*
button&nbsp; !class_btn.png!&nbsp; and select the *{_}New Java Interface{_}*&nbsp;&nbsp;&nbsp;!interface_btn.png!
option from the dropdown list. In the dialog
enter "Catalog" 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}
package services;
import org.osoa.sca.annotations.Remotable;
@Remotable
public interface Catalog {
String[] get();
}
{code}
Select the "services" package again. Select the *{_}New Java Class{_}* button !class_btn.png!
. In the dialog enter
"CatalogImpl" as the *{_}Name{_}* of the class, add "Catalog" as the interface this class
implements, and
then select *{_}Finish{_}* to complete the dialog.
The Java editor will open on the new created Java class. Replace the content of the editor
by
*{_}copy-paste{_}* of the following Java class code snippet.
{code}
package services;
import java.util.ArrayList;
import java.util.List;
import org.osoa.sca.annotations.Init;
import org.osoa.sca.annotations.Property;
import org.osoa.sca.annotations.Reference;
public class CatalogImpl implements Catalog {
@Property
public String currencyCode = "USD";
@Reference
public CurrencyConverter currencyConverter;
private List<String> catalog = new ArrayList<String>();
@Init
public void init() {
String currencySymbol = currencyConverter.getCurrencySymbol(currencyCode);
catalog.add("Apple - " + currencySymbol +
currencyConverter.getConversion("USD", currencyCode, 2.99f));
catalog.add("Orange - " + currencySymbol +
currencyConverter.getConversion("USD", currencyCode, 3.55f));
catalog.add("Pear - " + currencySymbol +
currencyConverter.getConversion("USD", currencyCode, 1.55f));
}
public String[] get() {
String[] catalogArray = new String[catalog.size()];
catalog.toArray(catalogArray);
return catalogArray;
}
}
{code}
After completing these steps the content of the "store" project will look as follows.
!store_project.png!
&nbsp;
*Note:* CatalogImpl is red x'ed because it makes use of the CurrencyConverter interface that
we
have not implemented yet.
&nbsp;
h3. _CurrencyConverter_
In this step you create the CurrencyConverter service interface and implementation.
You follow the same steps that you learned previously to create the interface and implementation.
First create a Java interface in the "services" package named "CurrencyConverter" and *{_}copy-paste{_}*
the following Java interface code snippet into it.
&nbsp;&nbsp;
{code}
package services;
import org.osoa.sca.annotations.Remotable;
@Remotable
public interface CurrencyConverter {
public float getConversion(String fromCurrenycCode,
String toCurrencyCode, float amount);
public String getCurrencySymbol(String currencyCode);
}
{code}
Next create a Java class in the "services" package named "CurrencyConverterImpl" and *{_}copy-paste{_}*
the following Java class code snippet into it.
{code}
package services;
public class CurrencyConverterImpl implements CurrencyConverter {
public float getConversion(String fromCurrencyCode,
String toCurrencyCode, float amount) {
if (toCurrencyCode.equals("USD"))
return amount;
else if (toCurrencyCode.equals("EUR"))
return amount*0.7256f;
return 0;
}
public String getCurrencySymbol(String currencyCode) {
if (currencyCode.equals("USD"))
return "$";
else
if (currencyCode.equals("EUR"))
return "€";
return "?";
}
}
{code}
After completing these steps the content of the "store" project will look as follows.
!store_project_1.png!
h3. _ShoppingCart_
In this step you create the ShoppingCart service implementation.
You follow the same steps that you learned previously to create the implementation.
Create a Java class in the "services" package named "ShoppingCartImpl" and *{_}copy-paste{_}*
the
following Java class code snippet into it.
{code}
package services;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.UUID;
import org.apache.tuscany.sca.binding.feed.collection.Collection;
import org.apache.tuscany.sca.binding.feed.collection.NotFoundException;
import com.sun.syndication.feed.atom.Content;
import com.sun.syndication.feed.atom.Entry;
import com.sun.syndication.feed.atom.Feed;
import com.sun.syndication.feed.atom.Link;
public class ShoppingCartImpl implements Collection {
// needs to change to instance var once conversation scope works
private static Map<String, Entry> cart = new HashMap<String, Entry>();
public Feed getFeed() {
Feed feed = new Feed();
feed.setTitle("shopping cart");
Content subtitle = new Content();
subtitle.setValue("Total : " + getTotal());
feed.setSubtitle(subtitle);
feed.getEntries().addAll(cart.values());
return feed;
}
public Entry get(String id) throws NotFoundException {
return cart.get(id);
}
public Entry post(Entry entry) {
String id = "cart-" + UUID.randomUUID().toString();
entry.setId(id);
Link link = new Link();
link.setRel("edit");
link.setHref("" + id);
entry.getOtherLinks().add(link);
link = new Link();
link.setRel("alternate");
link.setHref("" + id);
entry.getAlternateLinks().add(link);
entry.setCreated(new Date());
cart.put(id, entry);
return entry;
}
public void put(String id, Entry entry) throws NotFoundException {
entry.setUpdated(new Date());
cart.put(id, entry);
}
public void delete(String id) throws NotFoundException {
if (id.equals(""))
cart.clear();
else
cart.remove(id);
} private String getTotal() {
float total = 0;
String symbol = "";
if (!cart.isEmpty()) {
Entry entry = cart.values().iterator().next();
String item = ((Content)entry.getContents().get(0)).getValue();
symbol = item.substring(item.indexOf("-")+2, item.indexOf("-")+3);
}
for (Entry entry : cart.values()) {
String item = ((Content)entry.getContents().get(0)).getValue();
total += Float.valueOf(item.substring(item.indexOf("-")+3));
}
return symbol + String.valueOf(total);
}
}
{code}
*Note:* Since the Tuscany conversational support is not ready yet the cart is realized through
a hack.
The cart field is defined as static.
After completing these steps the content of the "store" project will look as follows.
!store_project_2.png!
&nbsp;
h3. *{_}Store{_}*
In this step you create the user facing Store service that will run in a Web browser and provide
the
user interface to the other services you created.
Select the "ufservices" package. *{_}Right click{_}* to get the context menu, select *{_}New{_}*,
and then *{_}File{_}*. In
the *{_}New File{_}* dialog enter "store.html" for the *{_}File name{_}*, and then select
*{_}Finish{_}* to complete the
dialog.
The Text editor will open on the new created html file. Replace the content of the editor
by *{_}copy-paste{_}*
of the following html snippet.
{code}
<html>
<head>
<title>Store</TITLE>
<script type="text/javascript" src="store.js"></script>
<script language="JavaScript">
//@Reference
var catalog = new Reference("catalog");
//@Reference
var shoppingCart = new Reference("shoppingCart");
function catalog_getResponse(items) {
var catalog = "";
for (var i=0; i<items.length; i++)
catalog += '<input name="items" type="checkbox" value="' +
items[i] + '">' + items[i]+ ' <br>';
document.getElementById('catalog').innerHTML=catalog;
}
function shoppingCart_getResponse(feed) {
if (feed != null) {
var entries = feed.getElementsByTagName("entry");
var list = "";
for (var i=0; i<entries.length; i++) {
var item = entries[i].getElementsByTagName("content")[0].firstChild.nodeValue;
list += item + ' <br>';
}
document.getElementById("shoppingCart").innerHTML = list;
document.getElementById('total').innerHTML = feed.getElementsByTagName("subtitle")[0].firstChild.nodeValue;
}
}
function shoppingCart_postResponse(entry) {
shoppingCart.get("", shoppingCart_getResponse);
}
function addToCart() {
var items = document.catalogForm.items;
var j = 0;
for (var i=0; i<items.length; i++)
if (items[i].checked) {
var entry = '<entry xmlns="http://www.w3.org/2005/Atom"><title>cart-item</title><content
type="text">'+items[i].value+'</content></entry>'
shoppingCart.post(entry, shoppingCart_postResponse);
items[i].checked = false;
}
}
function checkoutCart() {
document.getElementById('store').innerHTML='<h2>' +
'Thanks for Shopping With Us!</h2>'+
'<h2>Your Order</h2>'+
'<form name="orderForm" action="store.html">'+
document.getElementById('shoppingCart').innerHTML+
'<br>'+
document.getElementById('total').innerHTML+
'<br>'+
'<br>'+
'<input type="submit" value="Continue Shopping">'+
'</form>';
shoppingCart.del("", null);
}
function deleteCart() {
shoppingCart.del("", null);
document.getElementById('shoppingCart').innerHTML = "";
document.getElementById('total').innerHTML = "";
}
catalog.get(catalog_getResponse);
shoppingCart.get("", shoppingCart_getResponse);
</script>
</head>
<body>
<h1>Store</h1>
<div id="store">
<h2>Catalog</h2>
<form name="catalogForm">
<div id="catalog" ></div>
<br>
<input type="button" onClick="addToCart()" value="Add to Cart">
</form>
<br>
<h2>Your Shopping Cart</h2>
<form name="shoppingCartForm">
<div id="shoppingCart"></div>
<br>
<div id="total"></div>
<br>
<input type="button" onClick="checkoutCart()" value="Checkout">
<input type="button" onClick="deleteCart()" value="Empty">
<a href="../ShoppingCart/">(feed)</a>
</form>
</div>
</body>
</html>
{code}
After completing these steps the content of the "store" project will look as follows.
&nbsp;!store_project_3.jpg!
h2. Compose Services
Now that you have all the required service implementations you compose them together to provide
the store composite service. The composition is stored in a .composite file.
Select the "src" folder of the "store" project. *{_}Right click{_}* to get the context menu,
select *{_}New{_}*, and
then *{_}File{_}*. In the *{_}New File{_}* dialog enter "store.composite" for the *{_}File
name{_}*, and then select *{_}Finish{_}*
to complete the dialog.
The Text editor will open on the new created composite file. Replace the content of the editor
by
*{_}copy-paste{_}* of the following composite snippet.
{code}
<?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:s="http://store"
name="store">
<component name="store">
<t:implementation.widget location="ufservices/store.html"/>
<service name="Widget">
<t:binding.http/>
</service>
<reference name="catalog" target="Catalog">
<t:binding.jsonrpc/>
</reference>
<reference name="shoppingCart" target="ShoppingCart">
<t:binding.atom/>
</reference>
</component>
<component name="Catalog">
<implementation.java class="services.CatalogImpl"/>
<property name="currencyCode">USD</property>
<service name="Catalog">
<t:binding.jsonrpc/>
</service>
<reference name="currencyConverter" target="CurrencyConverter"/>
</component>
<component name="ShoppingCart">
<implementation.java class="services.ShoppingCartImpl"/>
<service name="Collection">
<t:binding.atom/>
</service>
</component>
<component name="CurrencyConverter">
<implementation.java class="services.CurrencyConverterImpl"/>
</component>
</composite>
{code}
After completing these steps the content of the "store" project will look as follows.
!store_project_4.jpg!
&nbsp;
h2. Launch Services
In this step you create the code to launch the Tuscany runtime with the new store composite
service you created.
Select the "store" project and click on the *{_}New Java Package{_}* button !new_java_pkg_btn.png!&nbsp;
in the toolbar to start the
package creation dialog. Use the dialog to create a new package named "launch".&nbsp;
Select the "launch" package. Select the *{_}New Java Class{_}* button !class_btn.png!&nbsp;
. In the dialog enter "Launch"
as the *{_}Name{_}* of the class, check the *{_}checkbox for creating a main method stub{_}*,
and then select
*{_}Finish{_}* to complete the dialog.
The Java editor will open on the new created Java class. Replace the content of the editor
by
*{_}copy-paste{_}* of the following Java class code snippet.
{code}
package launch;
import org.apache.tuscany.sca.host.embedded.SCADomain;
public class Launch {
public static void main(String[] args) throws Exception {
System.out.println("Starting ...");
SCADomain scaDomain = SCADomain.newInstance("store.composite");
System.out.println("store.composite ready for big business !!!");
System.out.println();
System.in.read();
scaDomain.close();
}
}
{code}
&nbsp;After completing these steps the content of the "store" project will look as follows.
!store_project_5.jpg!
Congratulations you completed your 1st composite service applications, now its time to take
it into
action.
h2. Use Services
In this step you launch and use the store composite service application you created.
First select the "Launch" class in the "launch" package of your "store" project. *{_}Right
click{_}* to get the
context menu, select *{_}Run As{_}*, and then *{_}Java application{_}*. The Tuscany runtime
will start up adding
the store composition to its domain.
The Eclipse console will show the following messages.
&nbsp;!eclipse_console.png!
&nbsp;Next Launch your Web browser and enter the following address:
[http://localhost:8080/store/store.html]&nbsp;
&nbsp;You get to the Store user facing service of the composite service application.
!store_page.png!
You can select items from the Catalog and add them to your Shopping Cart.
*Note:* When adding items for the first time you will be asked for *{_}userid and password{_}*
by the
browser. Enter "admin" for both.
!store_page_1.png!
Since the ShoppingCart service is bound using the ATOM binding, you can also look at the
shopping card content in ATOM feed form by clicking on the feed icon !atom_feed.png!. You
get the browsers default rendering for ATOM feeds.
&nbsp;!atom_feeds_page.png!
&nbsp;Use the browser back button to get back to the Store page.
!store_page_2.png!
And then you can Checkout to complete your order.
!store_page_3.png!
h2. Explore the Samples from the Tuscany Distribution
The sample folder of the Tuscany distribution provides a rich set of samples ready for you
to explore.
!tuscany_samples_folder.jpg!
&nbsp;
In Eclipse create a New Java Project, specify the project name, select Create project from
existing source, and specify the folder that contains the sample source.
!New_Calc_Java_Project.png!
&nbsp;
Use *{_}Next{_}* to get to the next page in the New Java Project dialog. There go to the *{_}Libraries{_}*
tab, use
the *{_}Add Library{_}*... pushbutton to add the JUnit library and the user library *{_}TUSCANY{_}*.
!New_Calc_Java_Project_lib.png!
&nbsp;
Finish the New Java Project dialog. You now have the sample project available in the Eclipse
workbench.
!calculator_proj_dlg.png!
&nbsp;
For the calculator sample that we've chosen go to its *{_}CalculatorClient{_}* class and select
*{_}Run As \->_*
*{_}Java Application._* You will see the following output in the console.
&nbsp;!calculator_eclipse_console.png!
---------------------------------------------------------------------
CONFLUENCE INFORMATION
This message is automatically generated by Confluence
Unsubscribe or edit your notifications preferences
http://cwiki.apache.org/confluence/users/viewnotifications.action
If you think it was sent incorrectly contact one of the administrators
http://cwiki.apache.org/confluence/administrators.action
If you want more information on Confluence, or have a bug to report see
http://www.atlassian.com/software/confluence
---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org