diff options
Diffstat (limited to 'site/trunk/site-publish/starting-with-das.html')
| -rw-r--r-- | site/trunk/site-publish/starting-with-das.html | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/site/trunk/site-publish/starting-with-das.html b/site/trunk/site-publish/starting-with-das.html new file mode 100644 index 0000000000..2a19d69aea --- /dev/null +++ b/site/trunk/site-publish/starting-with-das.html @@ -0,0 +1,219 @@ + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE- 2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <!-- generateKeywords macro --> + <META name="description" content="Apache Tuscany"> + <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource"> + <!-- generateKeywords macro end --> + + <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css"> + <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico"> + <TITLE>Apache Tuscany : Starting with DAS</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <BODY onload="init()"> + <!-- topNav macro --> + <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg"> + <TR> + <TD valing="top" align="left"> + <A href="https://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A> + </TD> + <TD> + <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A> + </TD> + + <TD width="100%"> + + </TD> + + <!-- Adds the edit page link to the top banner--> + <TD valign="bottom"> + <DIV style="padding: 2px 10px; margin: 0px;"> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=54705"> + <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + </DIV> + </TD> + + </TR> + </TABLE> + <!-- topNav macro end --> + + <!-- breadCrumbs macro --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%"> + <A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="das-overview.html" title="DAS Overview">DAS Overview</A> > <A href="das-java.html" title="DAS Java">DAS Java</A> > <A href="das-java-documentation-menu.html" title="DAS Java Documentation Menu">DAS Java Documentation Menu</A> > <A href="das-java-developer-guide.html" title="DAS Java Developer Guide">DAS Java Developer Guide</A> > <A href="rdb-das-java.html" title="RDB DAS Java">RDB DAS Java</A> > <A href="" title="Starting with DAS">Starting with DAS</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A> + </TD> + </TR> + </TABLE> + <!-- breadCrumbs macro end --> + + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD align="left" valign="top"> + + <!-- pageContent macro --> + <DIV id="PageContent"> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR> +<TD class="confluenceTd" valign="top" width="15%"> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="home.html" title="Home">Home</A><BR> +<A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License </A><BR> +<A href="das-java-get-involved.html" title="DAS Java Get Involved">Get Involved</A><BR> +<A href="das-java-found-a-bug.html" title="DAS Java Found A Bug">Found a Bug?</A></P> +</DIV></DIV> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>DAS Java</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="das-java.html" title="DAS Java">DAS Java Home</A><BR> +<A href="das-java-faq.html" title="DAS Java - FAQ">FAQ</A><BR> +<A href="das-java-releases.html" title="DAS Java Releases">Downloads</A><BR> +<A href="das-java-documentation-menu.html" title="DAS Java Documentation Menu">Documentation</A><BR> +<A href="https://svn.apache.org/repos/asf/tuscany/java/das/" class="external-link" rel="nofollow">Source Code</A></P> +</DIV></DIV></TD> +<TD class="confluenceTd" valign="top" width="85%"> +<H1><A name="StartingwithDAS-StartingwithDAS"></A>Starting with DAS</H1> + +<P>This page provides links to DAS samples and explains a simple "how to" and gives step-by-step instructions to check one of the DAS features - ColumnConverter. Other DAS features can be tried on similar lines.</P> + +<P>Many sample examples demonstrating different DAS features are available on +<A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/das/samples" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/java/das/samples</A> e.g.</P> + +<OL> + <LI>companyweb-webapp - tomcat based web sample</LI> + <LI>customer - J2SE based standalone application</LI> +</OL> + + +<P>Check readme files e.g. For companyweb +<A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/das/samples/company-webapp/readme.htm" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/java/das/samples/company-webapp/readme.htm</A><BR> +for basic steps on how to get the sample running. </P> + +<P>Once the sample is running, parts of sample can be modified based on the requirement or new code can be added from-scratch. Many features supported by DAS are listed in User Guide - +<A href="http://incubator.apache.org/tuscany/rdb-das-user-guide.html" class="external-link" rel="nofollow">http://incubator.apache.org/tuscany/rdb-das-user-guide.html</A> </P> + +<P>This document details the changes needed to different part of the web sample (companyweb) to experiment with more features of DAS than just basic CRUD.Let us take example of checking how to use ColumnConverters. For details on feature testing, check Tests under <A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/das/rdb/src/test/" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/java/das/rdb/src/test/</A></P> + +<P>1> As a first step you need to implement <B>Converter</B> interface in a class to achieve the required<BR> +column conversion. Check org.apache.tuscany.das.rdb.test.mappings.StringObfuscationConverter from the svn repository for example of converter. Make your converter class available in (Tomcat root)webapps/companyweb-webapp/WEB-INF/classes. </P> + +<P>2> DAS functions based on external Configuration, e.g. CompanyConfig.xml file in companyweb sample. The purpose of this Config file to supply information for DataSource connection, Commands (SQL) (that DAS can execute against Database) and Database schema like - Table/Columns, Relationship and so forth. Please check Architecture Guide for complete details about Config.xsd ()<BR> +at <A href="http://incubator.apache.org/tuscany/rdb-das-architecture-guide.html" class="external-link" rel="nofollow">http://incubator.apache.org/tuscany/rdb-das-architecture-guide.html</A>. Modify Config to get converter working. The <ConnectionInfo> element should match the resource name from server.xml for DataSource.Add a <Table> which has a column with converter class name of the class you just created. Add a <Command> with kind="Select" for this table/column e.g.</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><Command name="getFirstCustomer" SQL="Select * from CUSTOMER where ID = 1" kind="Select"/> + +<Table tableName="CUSTOMER"> +<Column columnName="ID" primaryKey="true"/> +<Column columnName="LASTNAME" converterClassName="org.apache.tuscany.das.rdb.test.mappings.StringObfuscationConverter"/> +</Table> +</PRE> +</DIV></DIV> +<P>3> Now the code and config setup is complete. What remains is calling the new command from .jsp and<BR> +servlet. Follow the technique similar to CompanyClient.java and Company.jsp to call the new command. The returned results will verify that the converter is called and the column value from database is converted based on converter logic. <BR> +4> For more details check the test cases from ConverterTests in <A href="https://svn.apache.org/repos/asf/incubator/tuscany/java/das/rdb/src/test/" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/java/das/rdb/src/test/</A>.</P> + +<P><B>Assumption:</B> Tomcat version 5.5.* or 6.0.10 , Derby version 10.1.2.1.</P> + +<P><B>Troubleshooting Checkpoints:</B> Check the following and if still having issues , report at +<A href="http://incubator.apache.org/tuscany/issue-tracking.html" class="external-link" rel="nofollow">http://incubator.apache.org/tuscany/issue-tracking.html</A></P> +<OL> + <LI>All libraries are present in (Tomcat root)/webapps/companyweb/WEB-INF/lib (these libs can<BR> +be taken from companyweb sample or can be downloaded from web)<BR> +i) common-(latest version).jar <BR> +ii) ecore-(latest version).jar <BR> +iii) ecore-change-(latest version).jar<BR> +iv) ecore-xmi-(latest version).jar<BR> +v) log4j-(latest version).jar <BR> +vi) sdo-api-xxx.jar <BR> +vii) tuscany-das-rdb-xxx.jar <BR> +viii) tuscany-sdo-xxx.jar<BR> +ix) xsd-(latest version).jar <BR> +x) derby driver jar - or whichever database you are planning to use</LI> + <LI>The Database exists with required tables and data.</LI> + <LI>WEB-INF/web.xml has entry under welcome-file-list for required .jsp like - +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><web-app> + <display-name>Tuscany DAS sample Company WEB</display-name> + + <welcome-file-list id="WelcomeFileList"> + <welcome-file>Company.jsp</welcome-file> + </welcome-file-list> +</web-app> +</PRE> +</DIV></DIV></LI> + <LI>META-INF/context.xml has entry for the datasource the sample is using like - +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><?xml version="1.0" encoding="UTF-8"?> +<Context path="/DAS Stand alone app" debug="5" reloadable="true" crossContext="true"> + <Manager pathname=""/> + <ResourceLink name="jdbc/dastest" global="jdbc/dastest" type="javax.sql.DataSource" /> +</Context> +</PRE> +</DIV></DIV></LI> + <LI>(Tomcat root)/conf server.xml has entry similar to below for the datasource - +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE><Resource name="jdbc/dastest" + type="javax.sql.DataSource" auth="Container" + description="Derby database for DAS Company sample" + maxActive="100" maxIdle="30" maxWait="10000" + username="" password="" + driverClassName="org.apache.derby.jdbc.EmbeddedDriver" + url="jdbc:derby:c:\apache-tomcat-5.5.20\Databases/dastest;create=true"/> +</PRE> +</DIV></DIV></LI> +</OL> + +</TD></TR></TBODY></TABLE> + </DIV> + </DIV> + </DIV> + <!-- pageContent macro end --> + + </TD> + </TR> + </TABLE> + + <!-- footer macro --> + <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> + </SCRIPT> + <SCRIPT type="text/javascript"> + _uacct = "UA-1174707-5"; + urchinTracker(); + </SCRIPT> + + <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A> + + <DIV class="footer"> + Copyright � 2003-2012, The Apache Software Foundation </BR> + Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation. + </DIV> + <!-- footer macro end --> + + </BODY> +</HTML> |