diff options
Diffstat (limited to 'site/trunk/site-publish/documentation-2x/converting-tuscany-1x-extensions.html')
| -rw-r--r-- | site/trunk/site-publish/documentation-2x/converting-tuscany-1x-extensions.html | 486 |
1 files changed, 486 insertions, 0 deletions
diff --git a/site/trunk/site-publish/documentation-2x/converting-tuscany-1x-extensions.html b/site/trunk/site-publish/documentation-2x/converting-tuscany-1x-extensions.html new file mode 100644 index 0000000000..152bf98fdc --- /dev/null +++ b/site/trunk/site-publish/documentation-2x/converting-tuscany-1x-extensions.html @@ -0,0 +1,486 @@ + + + + + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <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"> + + <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/TUSCANYxDOCx2x/$images/favicon.ico"> + <TITLE>Converting Tuscany 1.x Extensions : Apache Tuscany</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <STYLE> + .spacetree * ul { + padding-left:0px; + margin-left: 0px; + } + .spacetree * li { + margin-left: 5px; + padding-left:5px; + } + </STYLE> + + <BODY onload="init()"> + <!-- topNav --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" align="left" nowrap=""> + <A href="https://cwiki.apache.org/geronimo"> Home</A> > <A href="index.html" title="Apache Tuscany Docs 2.x">Apache Tuscany Docs 2.x</A> > <A href="index.html" title="Index">Index</A> > <A href="development-guides.html" title="Development Guides">Development Guides</A> > <A href="" title="Converting Tuscany 1.x Extensions">Converting Tuscany 1.x Extensions</A> + </TD> + <TD align="right" valign="middle" nowrap=""> + <FORM name="search" action="http://www.google.com/search" method="get"> + <INPUT type="hidden" name="ie" value="UTF-8"> + <INPUT type="hidden" name="oe" value="UTF-8"> + <INPUT type="hidden" name="domains" value=""> + <INPUT type="hidden" name="sitesearch" value=""> + <INPUT type="text" name="q" maxlength="255" value=""> + <INPUT type="submit" name="btnG" value="Google Search"> + </FORM> + </TD> + </TR> + </TABLE> + + + <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="index.html" title="Apache Tuscany Docs 2.x">Apache Tuscany Docs 2.x</A> > <A href="index.html" title="Index">Index</A> > <A href="development-guides.html" title="Development Guides">Development Guides</A> > <A href="" title="Converting Tuscany 1.x Extensions">Converting Tuscany 1.x Extensions</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://tuscany.apache.org/">Tuscany Home</A> | <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> + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD valign="top" align="left" width="22%" bgcolor="#F9F9F9" class="noprint"> + <DIV class="tabletitle">Table of Contents</DIV> + <DIV class="spacetree"> + + + </DIV> + </TD> + <TD align="left" valign="top" width="78%"> + <!-- pageContent --> + <DIV id="PageContent"> + <DIV class="pageheader" style="padding: 6px 0px 0px 0px;"> + <!-- We'll enable this once we figure out how to access (and save) the logo resource --> + <!--img src="http://geronimo.apache.org/images/confluence_logo.gif" style="float: left; margin: 4px 4px 4px 10px;" border="0"--> + <DIV style="margin: 0px 10px 0px 10px" class="smalltext">Apache Tuscany Docs 2.x</DIV> + <DIV style="margin: 0px 10px 8px 10px" class="pagetitle">Converting Tuscany 1.x Extensions</DIV> + + <DIV class="greynavbar" align="right" style="padding: 2px 10px; margin: 0px;"> +<!-- --> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=3475132"> + <IMG src="http://geronimo.apache.org/images/icons/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=3475132">Edit Page</A> + + <A href="https://cwiki.apache.org/confluence/pages/listpages.action?key=TUSCANYxDOCx2x"> + <IMG src="http://geronimo.apache.org/images/icons/browse_space.gif" height="16" width="16" border="0" align="absmiddle" title="Browse Space"></A> + <A href="https://cwiki.apache.org/confluence/pages/listpages.action?key=TUSCANYxDOCx2x">Browse Space</A> + + <A href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANYxDOCx2x&fromPageId=3475132"> + <IMG src="http://geronimo.apache.org/images/icons/add_page_16.gif" height="16" width="16" border="0" align="absmiddle" title="Add Page"></A> + <A href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANYxDOCx2x&fromPageId=3475132">Add Page</A> + + <A href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=TUSCANYxDOCx2x&fromPageId=3475132"> + <IMG src="http://geronimo.apache.org/images/icons/add_blogentry_16.gif" height="16" width="16" border="0" align="absmiddle" title="Add News"></A> + <A href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=TUSCANYxDOCx2x&fromPageId=3475132">Add News</A> +<!-- --> + </DIV> + </DIV> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <H1><A name="ConvertingTuscany1.xExtensions-Converting1.xdependencies"></A>Converting 1.x dependencies</H1> + +<P>You should configure the project pom.xml and</P> + +<DIV class="table-wrap"> +<TABLE class="confluenceTable"><TBODY> +<TR> +<TH class="confluenceTh"> 1.x Dependencies </TH> +<TH class="confluenceTh"> </TH> +<TH class="confluenceTh"> 2.x Dependencies </TH> +</TR> +<TR> +<TD class="confluenceTd"> <dependency> <BR class="atl-forced-newline"> +<groupId>org.apache.tuscany.sca</groupId> <BR class="atl-forced-newline"> +<artifactId>tuscany-assembly</artifactId> <BR class="atl-forced-newline"> +<version>1.6-SNAPSHOT</version> <BR class="atl-forced-newline"> +</dependency> </TD> +<TD class="confluenceTd"> ===> </TD> +<TD class="confluenceTd"> <dependency> <BR class="atl-forced-newline"> +<groupId>org.apache.tuscany.sca</groupId> <BR class="atl-forced-newline"> +<artifactId>tuscany-assembly</artifactId> <BR class="atl-forced-newline"> +<version>2.0-SNAPSHOT</version> <BR class="atl-forced-newline"> +</dependency> </TD> +</TR> +</TBODY></TABLE> +</DIV> + + +<P>The following core modules are not ported yet :</P> + +<UL> + <LI>some policies</LI> +</UL> + + +<P>The following modules are deprecated :</P> + +<UL> + <LI>host-embedded + <UL> + <LI>use the new Node APIs</LI> + </UL> + </LI> +</UL> + + +<H1><A name="ConvertingTuscany1.xExtensions-ConvertingCompositesandotherSCAXMLArtifacts"></A>Converting Composites and other SCA XML Artifacts</H1> + +<DIV class="table-wrap"> +<TABLE class="confluenceTable"><TBODY> +<TR> +<TH class="confluenceTh"> 1.x Namespace</TH> +<TH class="confluenceTh"> </TH> +<TH class="confluenceTh"> 2.x Namespace </TH> +</TR> +<TR> +<TD class="confluenceTd"> <A href="http://www.osoa.org/xmlns/sca/1.0" class="external-link" rel="nofollow">http://www.osoa.org/xmlns/sca/1.0</A> </TD> +<TD class="confluenceTd"> ===> </TD> +<TD class="confluenceTd"> <A href="http://docs.oasis-open.org/ns/opencsa/sca/200912" class="external-link" rel="nofollow">http://docs.oasis-open.org/ns/opencsa/sca/200912</A> </TD> +</TR> +<TR> +<TD class="confluenceTd"> <A href="http://tuscany.apache.org/xmlns/sca/1.0" class="external-link" rel="nofollow">http://tuscany.apache.org/xmlns/sca/1.0</A> </TD> +<TD class="confluenceTd"> ===> </TD> +<TD class="confluenceTd"> <A href="http://tuscany.apache.org/xmlns/sca/1.1" class="external-link" rel="nofollow">http://tuscany.apache.org/xmlns/sca/1.1</A> </TD> +</TR> +</TBODY></TABLE> +</DIV> + + +<H1><A name="ConvertingTuscany1.xExtensions-GeneratingOSGiManifest"></A>Generating OSGi Manifest</H1> + +<P>Configure pom to use Apache Felix <A href="http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html" class="external-link" rel="nofollow">maven-bundle-plugin</A></P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <build> + <plugins> + <plugin> + <groupId>org.apache.felix</groupId> + <artifactId>maven-bundle-plugin</artifactId> + + <configuration> + <instructions> + <Bundle-Version>${tuscany.version}</Bundle-Version> + <Bundle-SymbolicName>org.apache.tuscany.sca.binding.atom</Bundle-SymbolicName> + <Bundle-Description>${pom.name}</Bundle-Description> + <Export-Package>org.apache.tuscany.sca.binding.atom*</Export-Package> + <Import-Package>org.apache.tuscany.sca.assembly.xml;version=<SPAN class="code-quote">"2.0.0"</SPAN>, *</Import-Package> + </instructions> + </configuration> + </plugin> + </plugins> + </build> + +</PRE> +</DIV></DIV> + +<P>Generate the manifest</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +mvn org.apache.felix:maven-bundle-plugin:manifest +</PRE> +</DIV></DIV> + +<P>Copy the generated manifest from target folder to</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<module-root>/META_INF/manifest.mf +</PRE> +</DIV></DIV> + +<P>Add manifest to source control</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +git add META-INF +or +svn add META-INF +</PRE> +</DIV></DIV> + +<P>Make any manual modifications as necessary</P> + +<H1><A name="ConvertingTuscany1.xExtensions-Convertingyourextensionmodel"></A>Converting your extension model</H1> + +<P>Your extension model needs to provide a new getType method</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">interface</SPAN> AtomCBinding <SPAN class="code-keyword">extends</SPAN> Binding { + QName TYPE = <SPAN class="code-keyword">new</SPAN> QName(SCA11_TUSCANY_NS, <SPAN class="code-quote">"binding.atom"</SPAN>); + ... +} + +<SPAN class="code-keyword">public</SPAN> class AtomBindingImpl <SPAN class="code-keyword">implements</SPAN> AtomBinding { + <SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> name; + <SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> uri; + + <SPAN class="code-keyword">public</SPAN> QName getType() { + <SPAN class="code-keyword">return</SPAN> TYPE; + } + + ... +} +</PRE> +</DIV></DIV> + +<H1><A name="ConvertingTuscany1.xExtensions-ConvertingArtifactProcessors"></A>Converting Artifact Processors</H1> + +<P>Make sure you update your META-INF\services\org.apache.tuscany.sca.contribution.processor.StAXArtifactProcessor with new namespace and any other necessary changes to reflect the current 2.x structure.</P> + +<H1><A name="ConvertingTuscany1.xExtensions-ConvertingyouBindingruntimeartifacts"></A>Converting you Binding runtime artifacts</H1> + +<H3><A name="ConvertingTuscany1.xExtensions-ProviderFactory"></A>Provider Factory</H3> + +<UL> + <LI>The provider factory interface has changed to accommodate the new Endpoint/EndPointReference support + <UL> + <LI>Although the interface has changed, all the previous available information are encapsulated and available from the Endpoint and EndpointReference object</LI> + </UL> + </LI> +</UL> + + + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">interface</SPAN> BindingProviderFactory<M <SPAN class="code-keyword">extends</SPAN> Binding> <SPAN class="code-keyword">extends</SPAN> ProviderFactory<M> { + + /** + * Creates a <SPAN class="code-keyword">new</SPAN> reference binding provider <SPAN class="code-keyword">for</SPAN> the given endpoint reference + * + * @param endpointReference defines the component/reference/binding against which to create the provider + * @<SPAN class="code-keyword">return</SPAN> The binding provider + */ + ReferenceBindingProvider createReferenceBindingProvider(EndpointReference endpointReference); + + /** + * Creates a <SPAN class="code-keyword">new</SPAN> service binding provider <SPAN class="code-keyword">for</SPAN> the given component and + * service. + * + * @param endpoint defines the component/service/binding against which to create the provider + * @<SPAN class="code-keyword">return</SPAN> The binding provider + */ + ServiceBindingProvider createServiceBindingProvider(Endpoint endpoint); + +} +</PRE> +</DIV></DIV> + +<UL> + <LI>If you are using ModelFactoryExtensionPoint, it was renamed to FactoryExtensionPoint</LI> +</UL> + + + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +FactoryExtensionPoint modelFactories = extensionPoints.getExtensionPoint(FactoryExtensionPoint.class); +</PRE> +</DIV></DIV> + + +<H3><A name="ConvertingTuscany1.xExtensions-ReferenceBindingProviderandServiceBindingProvider"></A>ReferenceBindingProvider and ServiceBindingProvider</H3> + +<P>The previous SCA Models that were previously passed directly to these SPIs, is now available via Endpoint and EndpointReference as described in the code below:</P> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> class AtomReferenceBindingProvider <SPAN class="code-keyword">implements</SPAN> ReferenceBindingProvider { + + <SPAN class="code-keyword">private</SPAN> RuntimeComponentReference reference; + <SPAN class="code-keyword">private</SPAN> AtomBinding binding; + + <SPAN class="code-keyword">public</SPAN> AtomReferenceBindingProvider(EndpointReference endpointReference, + AtomBinding binding) { + + <SPAN class="code-keyword">this</SPAN>.reference = (RuntimeComponentReference) endpointReference.getReference(); + <SPAN class="code-keyword">this</SPAN>.binding = (AtomBinding) endpointReference.getBinding(); + } + + ... +} + +<SPAN class="code-keyword">public</SPAN> class AtomServiceBindingProvider <SPAN class="code-keyword">implements</SPAN> ServiceBindingProvider { + + + <SPAN class="code-keyword">private</SPAN> MessageFactory messageFactory; + + <SPAN class="code-keyword">private</SPAN> Endpoint endpoint; + <SPAN class="code-keyword">private</SPAN> RuntimeComponent component; + <SPAN class="code-keyword">private</SPAN> RuntimeComponentService service; + <SPAN class="code-keyword">private</SPAN> InterfaceContract serviceContract; + <SPAN class="code-keyword">private</SPAN> AtomBinding binding; + <SPAN class="code-keyword">private</SPAN> ServletHost servletHost; + + ... + + <SPAN class="code-keyword">public</SPAN> AtomServiceBindingProvider(Endpoint endpoint, + MessageFactory messageFactory, + ServletHost servletHost) { + <SPAN class="code-keyword">this</SPAN>.endpoint = endpoint; + <SPAN class="code-keyword">this</SPAN>.component = (RuntimeComponent)endpoint.getComponent(); + <SPAN class="code-keyword">this</SPAN>.service = (RuntimeComponentService)endpoint.getService(); + <SPAN class="code-keyword">this</SPAN>.binding = (AtomBinding) endpoint.getBinding(); + <SPAN class="code-keyword">this</SPAN>.messageFactory = messageFactory; + <SPAN class="code-keyword">this</SPAN>.servletHost = servletHost; + + } + + .... + +</PRE> +</DIV></DIV> + +<H1><A name="ConvertingTuscany1.xExtensions-ConvertingyouImplementationruntimeartifacts"></A>Converting you Implementation runtime artifacts</H1> + +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +... +</PRE> +</DIV></DIV> + +<H1><A name="ConvertingTuscany1.xExtensions-Convertingtestcases"></A>Converting test cases</H1> + +<P>In 2.x we removed the Host-Embedded module and the SCADomain, and the recommended way is to use the Node SPI to build your test cases. We also are recommending using JUnit 4.5 test styles. See below a quick</P> + +<P><B>1.x Style</B></P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> class AtomTestCase { + + <SPAN class="code-keyword">private</SPAN> SCADomain domain; + + @Before + <SPAN class="code-keyword">public</SPAN> void setUp() <SPAN class="code-keyword">throws</SPAN> Exception { + domain = SCADomain.newInstance(<SPAN class="code-quote">"AtomBinding.composite"</SPAN>); + } + + @After + <SPAN class="code-keyword">public</SPAN> void tearDown() <SPAN class="code-keyword">throws</SPAN> Exception { + domain.close(); + } + + .... +} +</PRE> +</DIV></DIV> + +<P><B>2.x Style</B></P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> +<SPAN class="code-keyword">public</SPAN> class AtomTestCase { + + <SPAN class="code-keyword">private</SPAN> <SPAN class="code-keyword">static</SPAN> Node node; + + @BeforeClass + <SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">static</SPAN> void setUp() <SPAN class="code-keyword">throws</SPAN> Exception { + <SPAN class="code-keyword">try</SPAN> { + <SPAN class="code-comment">// use the contribution helper to find the location of the contribution directory +</SPAN> <SPAN class="code-comment">// based on a class that is know to be in the contribution +</SPAN> <SPAN class="code-object">String</SPAN> contribution = ContributionLocationHelper.getContributionLocation(AtomTestCase.class); + + <SPAN class="code-comment">// create a note to load the contribution and run the named composite +</SPAN> node = NodeFactory.newInstance().createNode(<SPAN class="code-quote">"AtomBinding.composite"</SPAN>, <SPAN class="code-keyword">new</SPAN> Contribution(<SPAN class="code-quote">"test"</SPAN>, contribution)); + + <SPAN class="code-comment">// as an alternative to using the helper you can of course specify the location of the +</SPAN> <SPAN class="code-comment">// contribution directly, <SPAN class="code-keyword">for</SPAN> example, +</SPAN> <SPAN class="code-comment">// +</SPAN> <SPAN class="code-comment">// node = NodeFactory.newInstance().createNode(<SPAN class="code-keyword">new</SPAN> Contribution(<SPAN class="code-quote">"test"</SPAN>, +</SPAN> <SPAN class="code-comment">// <SPAN class="code-quote">"my/directory/structure/atom-contribution.zip"</SPAN>)); +</SPAN> <SPAN class="code-comment">// +</SPAN> <SPAN class="code-comment">// Note also that no composite is named here. It is assumed that the contribution +</SPAN> <SPAN class="code-comment">// specifies a deployable composite in the sca-contribution.xml file +</SPAN> + <SPAN class="code-comment">// start the node to make SCA services available +</SPAN> node.start(); + } <SPAN class="code-keyword">catch</SPAN> (Exception e) { + e.printStackTrace(); + } + } + + @AfterClass + <SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">static</SPAN> void tearDown() <SPAN class="code-keyword">throws</SPAN> Exception { + node.stop(); + node.destroy(); + } + + ... +} +</PRE> +</DIV></DIV> + +<P><B>NOTE</B> You will need to add the node-impl as test dependency to your modules</P> +<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> +<PRE class="code-java"> + <dependency> + <groupId>org.apache.tuscany.sca</groupId> + <artifactId>tuscany-node-impl</artifactId> + <version>2.0-SNAPSHOT</version> + <scope>test</scope> + </dependency> +</PRE> +</DIV></DIV> + </DIV> + + </DIV> + </DIV> + </TD> + </TR> + </TABLE> + + <!-- footer --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR> + <TD align="left" valign="middle" class="footer"> + + <IMG src="http://static.delicious.com/img/delicious.small.gif" height="10" width="10" alt="Delicious"> + <A href="http://delicious.com/save" onclick="window.open('http://delicious.com/save?v=5&noui&jump=close&url='+encodeURIComponent(location.href)+'&title='+encodeURIComponent(document.title),'delicious','toolbar=no,width=550,height=550'); return false;">Bookmark this on Delicious</A> + + <IMG src="http://digg.com/img/badges/16x16-digg-guy.gif" width="16" height="16" alt="Digg!"> + <A href="" onclick="window.open('http://digg.com/submit?url='+encodeURIComponent(location.href)+'&title='+encodeURIComponent(document.title)+'&topic=programming');">Digg this</A> + <!-- Slicker, but no text + <script type="text/javascript"> + digg_skin = 'icon'; + digg_window = 'new'; + digg_title = 'Apache Geronimo v2.2 Documentation : Converting Tuscany 1.x Extensions'; + digg_topic = 'programming'; + </script> + <script src="http://digg.com/tools/diggthis.js" type="text/javascript"></script> + --> + + </TD> + <TD align="right" valign="middle" class="footer"> + <A href="http://cwiki.apache.org/GMOxPMGT/geronimo-privacy-policy.html">Privacy Policy</A> - + Copyright © 2003-2010, The Apache Software Foundation, Licensed under <A href="http://www.apache.org/licenses/LICENSE-2.0">ASL 2.0.</A> + </TD> + </TR> + </TABLE> + + </BODY> +</HTML>
\ No newline at end of file |