Menu
▾
▴
[Andromdaplugins-cvs] CVS update: cartridges/andromda-ejb3/src/site/axdoc samples.xml howto.xml howto21.xml installation.xml project.xml
|
From: Vance K. <va...@us...> - 2007-01-19 13:17:01
|
User: vancek
Date: 07/01/19 05:16:59
Modified: andromda-ejb3/src/site/axdoc samples.xml howto.xml
howto21.xml installation.xml project.xml
Log:
update docs with latest jboss/seam
Revision Changes Path
1.2 +34 -0 cartridges/andromda-ejb3/src/site/axdoc/samples.xml
Index: samples.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/axdoc/samples.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- samples.xml 6 Oct 2006 06:49:58 -0000 1.1
+++ samples.xml 19 Jan 2007 13:16:57 -0000 1.2
@@ -8,10 +8,12 @@
<section name="Samples">
<p>
To help understand the EJB3 cartridge, the following sample applications have been provided.
+ All these samples are located in the <i>andromda-plugins</i> project on SF.net.
</p>
<p>
<ul>
<li><a href="samples.html#Samples_Demo_EJB3">Demo EJB3</a></li>
+ <li><a href="samples.html#Seam_Booking">Seam Booking Example</a></li>
</ul>
</p>
<a name="Samples_Demo_EJB3"/>
@@ -46,6 +48,38 @@
the functionality in each demo sub-package.
</p>
</subsection>
+ <a name="Seam_Booking"/>
+ <subsection name="Seam Booking Example">
+ <p>
+ This sample application is located in the <code>samples/booking-seam</code> directory of the
+ <code>andromda-plugins</code> project on SourceForge.net.
+ </p>
+ <p>
+ The project has the same structure as described in
+ <a href="http://galaxy.andromda.org/docs/samples.html">AndroMDA Samples</a>.
+ </p>
+ <p>
+ This booking system tries to replicate the JBoss Booking System (available from JBoss)
+ to illustrate the JBoss Seam features. It also relies on the EJB3 cartridge.
+ It is built for the MySQL database engine using JBoss 4.0.5 GA or newer.
+ </p>
+ <p>
+ Simply build the demo by executing <code>mvn</code> in the root of the project directory.
+ </p>
+ <p>
+ Once you have build the sample, you need to create the database called <code>booking-seam</code>.
+ You can then deploy the following to JBoss.
+ <ul>
+ <li>booking-seam/app/target/booking-seam-ds.xml</li>
+ <li>booking-seam/app/target/booking-seam-1.0-SNAPSHOT.ear</li>
+ </ul>
+ </p>
+ <p>
+ This example does not contain any view components at this time. As JBoss Seam funtionality
+ improves, this project will serve as a complete example for both EJB 3.0 Seam components and
+ JSF with Facelets view components.
+ </p>
+ </subsection>
</section>
</body>
</document>
1.3 +2 -6 cartridges/andromda-ejb3/src/site/axdoc/howto.xml
Index: howto.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/axdoc/howto.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -w -r1.2 -r1.3
--- howto.xml 6 Oct 2006 02:06:31 -0000 1.2
+++ howto.xml 19 Jan 2007 13:16:58 -0000 1.3
@@ -29,7 +29,7 @@
<li><a href="installation.html#Requirements">Requirements</a></li>
<li><a href="installation.html#Getting_the_Cartridge">Getting the Cartridge</a></li>
<li><a href="installation.html#Building_the_Cartridge">Building the Cartridge</a></li>
- <li><a href="installation.html#Building_Reports">Building Reports</a></li>
+ <li><a href="installation.html#Building_Documentation">Building Documentation</a></li>
</ul>
</li>
<li>
@@ -230,11 +230,7 @@
</ul>
</p>
<p>
- You can download the UML model containing all models for all sections
- <a href="HowToModel.xmi">here</a>.
- </p>
- <p>
- In order to start the tutorial click <a href="installation.html">here</a>.
+ To learn how to install the EJB3 cartridge click <a href="installation.html">here</a>.
</p>
</section>
</body>
1.4 +238 -113 cartridges/andromda-ejb3/src/site/axdoc/howto21.xml
Index: howto21.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/axdoc/howto21.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -w -r1.3 -r1.4
--- howto21.xml 17 Jan 2007 00:50:57 -0000 1.3
+++ howto21.xml 19 Jan 2007 13:16:58 -0000 1.4
@@ -8,10 +8,16 @@
<section name="JBoss Seam Integration">
<p>
The EJB3 cartridge now has the ability to enable your EJB 3.0 components as Seam components.
- This latest addition is work in progress.
+ The JBoss Online Booking example tries to illustrate how you can use the EJB3 cartridge with
+ Seam enabled features.
+ </p>
+ <p class="highlight">
+ Please note that the EJB3 cartridge will NOT generate any view components. A Seam cartridge is
+ planned which will do this job and can be used with the EJB3 cartridge.
</p>
<p>
- Here is the initial roadmap for JBoss Seam integration from the forum.
+ This howto will presume you have an understanding of the JBoss Seam framework. Read about
+ <a href="http://labs.jboss.com/jbossseam">JBoss Seam</a> and try out the examples.
</p>
<p class="highlight">
Remember: You must set the
@@ -20,162 +26,281 @@
namespace properties such that Seam specific project settings are generated and
Hibernate validator specific annotations are generated.
</p>
- <a name="Seam_Roadmap"/>
- <subsection name="Seam Roadmap">
+ <a name="Seam_Version"/>
+ <subsection name="Seam Version">
<p>
- 1. Have a new profile called andromda-profile-seam, as part of the andromdaplugins project
- containing all stereotypes and tagged values pertaining to seam components. Projects need to download
- and build the artifact and manually load the profile module within their UML model.
+ The cartridge will generate the Seam components using <b>JBoss Seam 1.1.0-GA</b>. Read
+ the <a href="http://labs.jboss.com/portal/jbossseam/gettingstarted">JBoss Seam Getting Started</a>
+ guide to learn how to download and setup your Seam environment, plus play around with the examples.
</p>
+ </subsection>
+ <a name="Project_Generator"/>
+ <subsection name="Project Generator">
<p>
- 2. Every entity or session bean which is to be modelled as a Seam component should have an
- extra <![CDATA[<<Seam>>]]> stereotype.
+ The AndroMDApp project generator from <code>3.3-SNAPSHOT</code> in CVS onwards supports JBoss Seam
+ for EJB3 and JSF for web project only. As long as you select these components, all the necessary
+ JBoss Seam properties will be enabled in your project.
</p>
<p>
- 3. #2 will render the @Name stereotype with the value taken as the class name. Should
- provide <code>@andromda.seam.component.name</code> tagged value to override this.
+ Once you run the project generator
+ <i>mvn org.andromda.maven.plugins:andromdapp-maven-plugin:generate</i>, you must select
+ EJB 3.0 as the persistence framework and JSF as the web framework. You will then be prompted
+ to enable JBoss Seams.
</p>
+ </subsection>
+ <a name="Seam_Profile"/>
+ <subsection name="Seam Profile">
<p>
- 4. Provide <code>@andromda.seam.component.scope</code> with enumerated values to set the scope if
- required, otherwise use defaults.
+ There exists a separate Seam profile that needs to be imported into your project UML. This profile
+ contains the Seam specific tags and stereotypes you need to model on your components.
</p>
<p>
- 5. @NotNull on getters is rendered based on attribute multiplicity.
+ You can
+ get this profile by if you have checked out the latest <i>andromda-plugins</i> project from
+ <b>HEAD</b> (follow <a href="installation.html">Installation</a>) and build the
+ <b>Profiles</b> project. Once this is done, the profile will be copied to your M2 repository
+ under <i>M2_REPO/org/andromda/profiles/uml14/andromda-profile-seam/VERSION/</i>.
+ You can then import this <i>andromda-profile-seam-VERSION.zml.zip</i> profile into your
+ model to utilise the Seam components.
</p>
+ </subsection>
+ <a name="Seam_Quick_Start_Guide"/>
+ <subsection name="Seam Quick Start Guide">
<p>
- 6. @Length annotation's max property is taken from
- <code>@andromda.persistence.column.length</code> tagged value. To specify a min
- length, set the tagged value to x,y where x is min, y is max.
- Need to account for this in the facade logic impl.
+ Because we are not going to replace the existing JBoss tutorials here, it is assumed you have
+ followed the links above to understand the Seams framework and where you need the appropriate
+ annotation or metadata. The following sections will briefly explain the more common Seam
+ stereotypes and tagged values and you can always find more documentation on these within
+ the <i>andromda-profile-seam</i>.
</p>
+ </subsection>
+ <subsection name="Seam Component">
<p>
- 7. @In and @Out annotations for bijection are rendered on attributes defined on
- session bean class where <![CDATA[<<In>>]]> and <![CDATA[<<Out>>]]> stereotypes are
- modelled respectively. If attribute multiplicity is 0, 0..1, 0..*, define
- require property in both annotations. If attribute multiplicity is 1, 1..*
- define create property on @In.
+ Every entity or session bean which is to be modelled as a Seam component must have an
+ extra <![CDATA[<<Seam>>]]> stereotype, along with the <![CDATA[<<Entity>>]]> stereotype.
</p>
+ </subsection>
+ <subsection name="Component Name">
<p>
- 8. @Create annotation rendered on session bean operation if a
- <![CDATA[<<Create>>]]> stereotype is modelled on it.
+ If you render the <![CDATA[<<Seam>>]]> stereotype, the <![CDATA[@Name]]> annotation will be
+ generated with the value being the class name. You can override this by modelling the
+ <![CDATA[@andromda.seam.component.name]]> tagged value.
</p>
+ </subsection>
+ <subsection name="Component Scope">
<p>
- 9. @Destroy annotation is rendered on a session bean operation if a
- <![CDATA[<<Destroy>>]]> stereotype is modelled on it.
+ The <![CDATA[@andromda.seam.component.scope]]> tagged value on Seam component classes provides
+ enumerated values to set the scope of the component. The default scope depends on the component
+ type.
</p>
<p>
- 10. Provide tag <code>@andromda.seam.validation.invalid.outcome</code> with enumerated
- list of values to be set on session bean operations (to render @IfInvalid) such that
- Hibernate Validator can validate component state before invoking action listener
- session bean operation (for components with @Valid annotations).
- <code>@andromda.seam.validation.invalid.refreshEntities</code> can be set to true or
- false and if defined, adds the refreshEntities property to the annotation.
+ If you have modelled roles for the component, then you can use the
+ <![CDATA[@andromda.seam.component.role.scope]]> tagged value where the list of scopes must be
+ in the same order as the role names.
</p>
+ </subsection>
+ <subsection name="Logger">
<p>
- 11. <![CDATA[<<Valid>>]]> stereotype can be modelled on session bean attributes
- to render @Valid annotation for validation (see #10).
+ To make use of the JBoss Seam logger, you can model a component attribute of <i>Object</i>
+ type with stereotype <![CDATA[<<Logger>>]]>. You can further specify the name of the log
+ category with <![CDATA[@andromda.seam.bijection.logger.value]]> tagged value.
</p>
+ </subsection>
+ <subsection name="Bijection">
<p>
- 12. Modify andromdapp project generator to ask a further question:
- Would you like to use the JBoss Seam application framework?
- Only if persistence engine is ejb3, a web interface is required and interface type
- is JSF. This will add the jboss-seam artifact as dependency to necessary poms
- and include it in the ear for deployment. Perhaps include a property called
- seamEnabled in the andromda.xml application descriptor in the default namespace.
+ The <![CDATA[@In]]> and <![CDATA[@Out]]> annotations for bijection are rendered on attributes
+ defined on session bean class where <![CDATA[<<In>>]]> and <![CDATA[<<Out>>]]> stereotypes are
+ modelled respectively.
</p>
<p>
- 13. If seamEnabled (# 12), ejb-jar.xml contains necessary interceptor binding
- and application.xml contains the jboss-seam.jar java module definition.
+ If attribute multiplicity is 0, 0..1, 0..*, the
+ <i>require</i> property is defined in both annotations.
</p>
<p>
- 14. As soon as you introduce session bean attributes, the cartridge assumes
- the bean is a stateful session bean. One solution would be to remove this
- default so that the only way to specify a session bean as a sfsb
- is via tagged value <code>@andromda.service.type</code>.
+ If attribute multiplicity is 1, 1..*
+ the <i>create</i> property is defined on the <![CDATA[@In]]> annotation. You can explicity
+ specify this using the <![CDATA[@andromda.seam.bijection.in.create]]> tagged value.
</p>
<p>
- 15. Stereotype <![CDATA[<<DataModel>>]]> can be modelled on attributes
- (of type java.util.List - but I don't think this can be enforced).
- This will render @DataModel on the attribute. An optional tagged value
- <code>@andromda.seam.datatable.datamodel.name</code> can be modelled on such
- attributes to defined the context variable name if more than 1 datamodel exists.
+ To explicity specify the name of the context variable for the <![CDATA[@In]]> annotation,
+ model the <![CDATA[@andromda.seam.bijection.in.value]]> tagged value. This can also be used
+ to specify the JSF EL expression. If not specified, the name will default to the component
+ attribute. The <![CDATA[@andromda.seam.bijection.out.value]]> tagged value can be used for
+ the <![CDATA[@Out]]> annotation.
</p>
+ </subsection>
+ <subsection name="Creating Seam Component">
<p>
- 16. Stereotype <![CDATA[<<DataModelSelection>>]]> can be modelled on attributes
- to inject the selected value from the DataModel into this attribute. This
- will render @DataModelSelection on the attribute. An optional tagged value
- <code>@andromda.seam.datatable.datamodel.selection.name</code> can define the
- name of the context variable defined by the appropriate @DataModel.
+ The <![CDATA[@Create]]> annotation is rendered on session bean operations if a
+ <![CDATA[<<Create>>]]> stereotype is modelled on this method, indicating that the method
+ should be called when an instance of the component is instantiated by Seam.
</p>
+ </subsection>
+ <subsection name="Destruction of Context Variables">
<p>
- 17. Stereotype <![CDATA[<<Factory>>]]> can be modelled on session bean
- component operations with <code>@andromda.seam.component.factory.context.name</code>
- which is modelled on the operation to set the context variable name.
+ The <![CDATA[@Destroy]]> annotation is rendered on a session bean operation if a
+ <![CDATA[<<Destroy>>]]> stereotype is modelled on it. Otherwise, by default,
+ a <b>Destroy</b> method is generated with this annotation.
</p>
+ </subsection>
+ <subsection name="Not Null Validation">
<p>
- 18. Stereotype <![CDATA[<<RequestParameter>>]]> can be modelled on session bean
- component attribute to indicate an attribute is to be injected with the value
- of a request parameter. Optional tagged value
- <![CDATA[@andromda.seam.component.requestParameter.name]]> will define the
- request parameter name.
+ The <![CDATA[@NotNull]]> annotation will be rendered on getters based on attribute multiplicity.
</p>
+ </subsection>
+ <subsection name="Length Validation">
<p>
- 19. Tagged value <code>@andromda.seam.transaction.rollback.outcome</code> on session
- bean component operation, can have multiple values to indicate that transaction
- set for rollback on the specified outcomes.
+ The <![CDATA[@Length]]> annotation's max property is taken from
+ <![CDATA[@andromda.persistence.column.length]]> tagged value. It is planned to specify a min
+ length, set via the same tagged value with format x,y where x is min, y is max.
+ This has currently not been implemented.
</p>
+ </subsection>
+ <subsection name="Component Validation">
<p>
- 20. Not sure if we really need to touch the Java cartridge. If we can add a new
- stereotype to define a class/metafacade as a JavaBean in the EJB3 cartridge
- and apply the Seam component model to it, it would avoid bloating the 'simple' Java cartridge.
+ The <![CDATA[<<Valid>>]]> stereotype can be modelled on session bean component attributes
+ to render the <![CDATA[@Valid]]> annotation for Hibernate Validator to recursively
+ validate this and related objects.
</p>
<p>
- 21. Tagged value <code>@andromda.seam.component.conversational.ifNotBegunOutcome</code>
- if set will render the ifNotBegunOutcome property of the @Conversational annotation
- to indicate the JSF outcome for the action if no long-running conversation is
- active when the component is invoked.
+ The <![CDATA[<<Validator>>]]> stereotype can be modelled on Seam component operations indicating
+ the validator must validate the component before invoking the method.
</p>
<p>
- 22. Stereotype <![CDATA[<<Begin>>]]> can be modelled on session bean component operations
- to indicate a long-running conversation started, which will render a @Begin annotation
- on the operation. Should define extra tagged values for ifOutcome, join, nested and
- pageflow properties of @Begin annotation.
+ This component operation can now model the
+ <![CDATA[@andromda.seam.validation.outcome]]> tagged value to indicate the JSF outcome when
+ validation fails.
</p>
<p>
- 23. Stereotype <![CDATA[<<End>>]]> can be modelled on session bean component operations
- to indicate the end of a long running conversation. Define tagged values for ifOutcome
- and evenIfException properties.
+ The <![CDATA[@andromda.seam.validation.refreshEntities]]> tagged value can also optionally be
+ modelled with values 'true' or
+ 'false' and if defined, adds the <i>efreshEntities</i> property to the annotation. This will
+ indicate any invalid entity in the managed state be refreshed from the database when
+ validation fails. This is used in conjuction with extended persistence context.
</p>
+ </subsection>
+ <subsection name="Stateful Session Bean Components">
+ <p>
+ As soon as you introduce session bean attributes, the cartridge defines
+ the bean as a stateful session bean only if none of the attributes are modelled with Seam related
+ stereotypes or tagged values. If you have only Seam component attributes in the session bean
+ (which by the way, is a Seam component), the bean is not defined as a SFSB. If you wish
+ to explicity define this bean as a SFSB you can do this via the tagged value
+ <![CDATA[@andromda.service.type]]>.
+ </p>
+ </subsection>
+ <subsection name="Data Model">
<p>
- 24. Define similar stereotypes/tags for jBPM tasks/processes.
+ The <![CDATA[<<DataModel>>]]> stereotype can be modelled on component attributes
+ of type List, Map, Set or Object[].
+ This will render <![CDATA[@DataModel]]> on the attribute.
</p>
<p>
- 25. Stereotype <![CDATA[<<Unwrap>>]]> modelled on attributes but is rendered
- on getter method of beans.
+ An optional tagged value
+ <![CDATA[@andromda.seam.data.datamodel.value]]> can be modelled on such
+ attributes to defined the context variable name if more than one datamodel exists.
</p>
<p>
- 26. Everything needs to have XDOC documentation.
+ The exposed attribute will have the scope of the owning component, or the <b>EVENT</b>
+ scope if the owning component itself has a <b>STATELESS</b> scope. You can optinally
+ explicity define the scope using <![CDATA[@andromda.seam.data.datamodel.scope]]> tagged value.
</p>
</subsection>
- <a name="Project_Generator"/>
- <subsection name="Project Generator">
+ <subsection name="Data Model Selection">
<p>
- The AndroMDApp project generator from <code>3.2-SNAPSHOT</code> in CVS onwards supports JBoss Seam
- for EJB3 and JSF for web project only. As long as you select these components, all the necessary
- JBoss Seam properties will be enabled in your project.
+ The <![CDATA[<<DataModelSelection>>]]> stereotype can be modelled on component attributes
+ to inject the selected value from the <b>DataModel</b> into the attribute. The JSF
+ DataModel is the underlying colleciton or map value. This
+ will render <![CDATA[@DataModelSelection]]> on the attribute.
+ </p>
+ <p>
+ An optional tagged value
+ <![CDATA[@andromda.seam.data.datamodelselection.value]]> can define the
+ name of the context variable specified by the appropriate <![CDATA[@DataModel]]>.
+ This tagged value is
+ not needed is there is only one <![CDATA[@DataModel]]> element in the Seam component.
</p>
</subsection>
- <a name="Seam_Profile"/>
- <subsection name="EJB3 Seam Profile">
+ <subsection name="Initializing Context Variable">
<p>
- There exists a separate Seam profile that needs to be imported into your project. This profile
- contains the Seam specific tags and stereotypes you need to model on your components. You can
- get this profile by if you have checked out the latest <i>andromda-plugins</i> project from
- <b>HEAD</b> (follow <a href="installation.html">Installation</a>) and build the
- <b>Profiles</b> project. Once this is done, the profile will be copied to your M2 repository
- under <i>M2_REPO/org/andromda/plugins/profiles/uml14/andromda-plugins-profile-seam/VERSION/</i>.
- You can then import this <i>andromda-plugins-profile-seam-VERSION.zml.zip</i> profile into your
- model to utilise the Seam components.
+ The <![CDATA[<<Factory>>]]> stereotype can be modelled on session bean
+ component operations with the optional <![CDATA[@andromda.seam.bijection.factory.value]]>
+ tagged value which can be modelled on the operation to set the context variable name.
+ If this tagged value is NOT set, the default value is the property name. You can optionally
+ explicity specify the scope of the context variable by using the
+ <![CDATA[@andromda.seam.bijection.factory.scope]]> tagged value.
+ </p>
+ </subsection>
+ <subsection name="Request Parameters">
+ <p>
+ The <![CDATA[<<RequestParameter>>]]> stereotype can be modelled on session bean
+ component attributes to indicate an attribute is to be injected with the value
+ of a request parameter.
+ </p>
+ <p>
+ The optional tagged value
+ <![CDATA[@andromda.seam.component.requestparameter.value]]> will define the
+ request parameter name. If this is NOT set, the name will default to the name of the
+ component attribute.
+ </p>
+ </subsection>
+ <subsection name="Transaction Rollback">
+ <p>
+ You can model the <![CDATA[<<Rollback>>]]> stereotype on component method, which will
+ set the transaction to rollback when the method completes, if the outcome of the method
+ matches any of the listed outcomes or when no outcomes are listed. You set the list
+ of outcomes using the following tagged value.
+ </p>
+ <p>
+ The tagged value <![CDATA[@andromda.seam.transaction.rollback.ifoutcome]]> which can be set
+ on bean component operations that have the <![CDATA[<<Rollback>>]]> stereotype,
+ can have multiple values to indicate the list of outcomes that trigger a rollback.
+ </p>
+ </subsection>
+ <subsection name="Action Outcome in Absence of a Conversation">
+ <p>
+ The tagged value <![CDATA[@andromda.seam.component.conversational.ifnotbegunoutcome]]>
+ an be set to render the <b>ifNotBegunOutcome</b> property on the <![CDATA[@Conversational]]>
+ annotation to indicate the JSF outcome for the action, if no long-running conversation is
+ active when the component is invoked.
+ </p>
+ </subsection>
+ <subsection name="Beginging a Conversation">
+ <p>
+ The<![CDATA[<<Begin>>]]> stereotype can be modelled on Seam bean component operations
+ to indicate a long-running conversation has started. This will render a <![CDATA[@Begin]]>
+ annotation on the operation. The following tagged values can be defined within the context of this
+ component:
+ <ul>
+ <li><![CDATA[@andromda.seam.conversation.begin.flushmode]]></li>
+ <li><![CDATA[@andromda.seam.conversation.begin.ifoutcome]]> - Can have multiple values</li>
+ <li><![CDATA[@andromda.seam.conversation.begin.join]]></li>
+ <li><![CDATA[@andromda.seam.conversation.begin.nested]]></li>
+ <li><![CDATA[@andromda.seam.conversation.begin.pageflow]]></li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="Ending a Conversation">
+ <p>
+ The <![CDATA[<<End>>]]> stereotype can be modelled on Seam bean component operations
+ to indicate the end of a long running conversation. The following tagged values can be
+ defined within the context of this component:
+ <ul>
+ <li><![CDATA[@andromda.seam.conversation.end.ifoutcome]]> - can have multiple values</li>
+ <li><![CDATA[@andromda.seam.conversation.end.evenifexception]]></li>
+ <li><![CDATA[@andromda.seam.conversation.end.beforeredirect]]></li>
+ </ul>
+ </p>
+ </subsection>
+ <subsection name="jBPM Tasks and Processes">
+ <p>
+ Refer to seam profile for docs on stereotypes/tags for jBPM tasks/processes.
+ </p>
+ </subsection>
+ <subsection name="Unwrap Stereotype">
+ <p>
+ The stereotype <![CDATA[<<Unwrap>>]]> can be modelled on attributes but is rendered
+ on getter method of bean components.
</p>
</subsection>
</section>
1.2 +31 -21 cartridges/andromda-ejb3/src/site/axdoc/installation.xml
Index: installation.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/axdoc/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- installation.xml 14 Sep 2006 14:31:26 -0000 1.1
+++ installation.xml 19 Jan 2007 13:16:59 -0000 1.2
@@ -18,17 +18,20 @@
You can install Maven
<a href="http://maven.apache.org/download.html#Installation">here</a>.
</p>
- <p class="highlight">
- If you want to build the site docs, you need to download the latest Maven 2.0.x source
- from https://svn.apache.org/repos/asf/maven/components/branches/maven-2.0.x and follow
- the instructions to build, assemble and set your M2_HOME and PATH variables.
- </p>
<p>
- You need to have an instance of AndroMDA 3.2. At the time of writing this, 3.2 RC1
- was released but the latest 3.2-SNAPSHOT from CVS contains updates to the project generator
- and site plugin; this is more suitable to use with the EJB3 cartridge. Follow the anonymous
+ You need to have an instance of AndroMDA 3.3-SNAPSHOT. At the time of writing this, 3.2
+ was released but the latest 3.3-SNAPSHOT from CVS contains updates to the project generator
+ and site plugin; this is more suitable for use with the EJB3 cartridge. Follow the anonymous
CVS access at <a href="http://sourceforge.net/cvs/?group_id=73047">AndroMDA project</a> to
- checkout and build the latest <b>andromda-all</b> source.
+ checkout and build the latest <b>andromda-all</b> source from the <i>V3_x_HEAD</i> branch.
+ </p>
+ <p>
+ Finally, you will need the JBoss Application Server. It is recommended to download the
+ latest GA JBoss AS. At the time of writing this guide and with the current status of the
+ EJB3 cartridge, it is recommended to download JBoss AS 4.0.5-GA using the JEMS installer
+ (at least 1.2.0.GA) and install with the <i>ejb3</i> profile. Read up more about
+ the <a href="http://labs.jboss.com/portal/jbossas/?prjlist=false">JBoss AS</a> and download
+ the installer.
</p>
</subsection>
<a name="Getting_the_Cartridge"/>
@@ -64,16 +67,26 @@
by running <i>mvn</i> in the latter location.
</p>
</subsection>
- <a name="Building_Reports"/>
- <subsection name="Building Reports">
+ <a name="Building_Documentation"/>
+ <subsection name="Building Documentation">
+ <p class="highlight">
+ You NO LONGER need to download the Maven 2.0.x source to build the cartridge
+ documentation.
+ </p>
<p>
To build the EJB3 cartridge site documentation requires a few extra Maven 2 plugins
- to be downloaded from the Maven 2 sandbox in SVN. The
+ to be downloaded from the Maven 2 SVN. The
<a href="http://maven.apache.org/guides/development/guide-building-m2.html">Maven build</a>
documentation will give you some information on how to access their SVN.
</p>
<p>
- You will need to check out the following plugins from Maven <b>sandbox</b>.
+ Please follow <a href="http://galaxy.andromda.org/forum/viewtopic.php?t=3976">Maven 2 site Docs</a>
+ to download and build the necessary Maven 2 projects prior to building the EJB3 cartridge site
+ docs.
+ </p>
+ <p>
+ You will need to check out <i>maven-plugins</i> from Maven <b>trunk</b>. You only required
+ the following plugins, so you can disable the other modules if you wish.
<ul>
<li>maven-changes-plugin</li>
<li>maven-changelog-plugin</li>
@@ -81,21 +94,18 @@
Once you have built them (mvn install), these plugins will reside in your local repo.
</p>
<p>
- In adopting the existing AndroMDA site format for the documentation, the Maven Doxia
- plugin needs a patch to be applied. You can check out <b>doxia-1.0-alpha-8</b>
- from Maven SVN and apply the patch <a href="http://jira.codehaus.org/browse/MNG-545">here</a>.
- It is not critical to apply this patch, but if it's not applied, the generated XHTML will
- not be formated correctly but still acceptable.
- </p>
- <p>
All other require plugins will be downloaded to your local repo if they don't already
exist.
</p>
<p>
You can download the source examples used in the howto for all sections
- <a href="HowToModel-src.zip">here</a> and extract to the target/site folder of the
+ <a href="howto/HowToModel-src.zip">here</a> and extract to the target/site folder of the
andromda-ejb3 plugin.
</p>
+ <p>
+ You can download the UML model containing all models for all sections
+ <a href="howto/HowToModel.xml.zip">here</a>.
+ </p>
</subsection>
</section>
<section name="Next">
1.2 +1 -1 cartridges/andromda-ejb3/src/site/axdoc/project.xml
Index: project.xml
===================================================================
RCS file: /cvsroot/andromdaplugins/cartridges/andromda-ejb3/src/site/axdoc/project.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -w -r1.1 -r1.2
--- project.xml 14 Sep 2006 14:31:27 -0000 1.1
+++ project.xml 19 Jan 2007 13:16:59 -0000 1.2
@@ -15,7 +15,7 @@
Using the AndroMDApp generator, simply run the following command
</p>
<p>
- <code>mvn andromdapp:generate</code>
+ <code>mvn org.andromda.maven.plugins:andromdapp-maven-plugin:generate</code>
</p>
<p>
And follow the process. The following diagram illustrates how to generate a template
|
