Archetype documentation

parent d85b9453
......@@ -91,6 +91,18 @@
<orgname>INRIA</orgname>
</affiliation>
</author>
<author>
<honorific>Mr</honorific>
<firstname>Antonio</firstname>
<surname>de Almeida Souza Neto</surname>
<affiliation>
<orgname>INRIA</orgname>
</affiliation>
</author>
</authorgroup>
</bookinfo>
......@@ -209,10 +221,10 @@
</chapter>
<xi:include href="../../../examples/src/docbkx/examples.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="../../../distribution/standalone/src/docbkx/distribution.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<chapter>
<title>Create your first application</title>
......@@ -234,7 +246,7 @@
<mediaobject>
<imageobject>
<imagedata fileref="images/helloworld-uml.png" />
<imagedata fileref="images/helloworld-uml.png"/>
</imageobject>
</mediaobject>
</screenshot>
......@@ -452,7 +464,7 @@ public class Client implements Runnable {
<mediaobject>
<imageobject>
<imagedata fileref="images/helloworld-pojo-composite.png" />
<imagedata fileref="images/helloworld-pojo-composite.png"/>
</imageobject>
</mediaobject>
</screenshot>
......@@ -604,7 +616,7 @@ public class Client implements Runnable {
</section>
</section>
<section>
<section id="scaAnnotations">
<title>SCA Java annotations</title>
<para>The SCA specification defines a set of SCA Java annotations that
......@@ -618,9 +630,9 @@ public class Client implements Runnable {
<para>First, the PrintService Java interface implemented by the server
is described with the <code>&lt;service/&gt;</code> tag from lines 22 to
24 of the <code>helloworld-pojo.composite</code> file, in <xref
linkend="hw-pojo-composite" />. These lines can be omitted when using
the <code>@Service</code> annotation on the <code>PrintService</code>
Java interface:</para>
linkend="hw-pojo-composite"/>. These lines can be omitted when using the
<code>@Service</code> annotation on the <code>PrintService</code> Java
interface:</para>
<programlisting linenumbering="unnumbered">package org.ow2.frascati.examples.helloworld.annotated;
......@@ -633,7 +645,7 @@ public interface PrintService {
<para>Concerning the server component, its Java implementation can also
be annotated for the description of its property (header), described
line 26 in the SCA composite of <xref linkend="hw-pojo-composite" />.
line 26 in the SCA composite of <xref linkend="hw-pojo-composite"/>.
This annotation exempts also the developper to write getters and setters
for SCA properties defined with this annotation. Thus, the
<code>Server</code> Java class now looks like:</para>
......@@ -714,6 +726,39 @@ public class Client implements Runnable {
&lt;/composite&gt;
</programlisting></para>
</section>
<section>
<title>FraSCAti Archetype</title>
<para>An easy way to start your SCA application on FraSCAti is
generating a FraSCAti Archetype using Maven. Doing that, Maven will
generate the necessary structure for a SCA application executing on
FraSCAti.</para>
<para>A helloworld application with annotations (<xref
linkend="scaAnnotations"/>) will be created to help you to understand
how a simple application works on FraSCAti and also a POM file, a
default log configuration and some java files. You can use this
structure to develop your application. All files can be changed or
simply deleted.</para>
<para>To generate this Archetype using a SNAPSHOT version, type in the
command line:</para>
<para><programlisting>mvn archetype:generate -DarchetypeCatalog=https://frascati-repo.inria.fr/nexus/content/groups/public/ -DarchetypeGroupId=org.ow2.frascati.mojo -DarchetypeArtifactId=frascati-archetype -U</programlisting>Maven
will guide you to define some parameters corresponding to your
application such as groupId, artifactId, version and package (by default
the same as groupId). Then, a folder with the artifactId name will be
created.</para>
<para>If you want to generate your SCA application based in a release
version of the Archetype, you can use the maven central repository
catalog (from 1.5 version), typing just:</para>
<para>
<programlisting>mvn archetype:generate -DarchetypeGroupId=org.ow2.frascati.mojo -DarchetypeArtifactId=frascati-archetype -U</programlisting>
</para>
</section>
</chapter>
<chapter>
......@@ -900,7 +945,7 @@ public class Client implements Runnable {
<mediaobject>
<imageobject>
<imagedata fileref="images/weather-composite.png" />
<imagedata fileref="images/weather-composite.png"/>
</imageobject>
</mediaobject>
</screenshot>
......@@ -1004,23 +1049,22 @@ Library weather.jar created!
</chapter>
<xi:include href="../../../frascati/intents/src/docbkx/intents.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="../../../frascati/modules/frascati-explorer/src/docbkx/explorer.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="../../../frascati/modules/frascati-fscript/core/src/docbkx/fscript.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="reconfig.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="reconfig.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="../../../frascati/modules/frascati-introspection/src/docbkx/remote.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="../../../frascati/modules/frascati-jmx/src/main/docbkx/jmx.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="../../../frascati/modules/src/docbkx/ow2-frascati-spl.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="../../../frascati/modules/src/docbkx/ow2-frascati-spl.xml"
xmlns:xi="http://www.w3.org/2001/XInclude"/>
</book>
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment