General Instructions
Maven Generated Site for viewing javadoc or source xref
There is a maven generated site for samples which can be used to view javadoc and source. It can be found here:
To navigate to javadoc and source code (xref) for each sample do the following:
- select "Geronimo Samples :: Samples" under Modules in the left-hand navigation
- select a specific sample from the left-hand navigation under Modules
- to view javadoc or source (xref) you must navigate down to a module that includes source such as a war or ejb. For example, if you are interested in viewing the servlets associated with the bank sample you would choose the following modules:
- under Modules select "Geronimo Samples :: bank"
- under Modules select "Geronimo Samples :: bank :: WAR"
- once you are at a module that contains source you can then select "Project Reports" and from the information provided choose either JavaDocs or Source Xref
Obtaining and building
The first time building samples it is required that you build from the top level directory. After the initial build, you can do subsequent builds of specific samples as necessary.
...
To check out the 2.1.2 samples:
| Code Block | ||||
|---|---|---|---|---|
| ||||
svn co https://svn.apache.org/repos/asf/geronimo/samples/tags/samples-parent-2.1.2/ gsamples-2.1.2 |
| Note |
|---|
This assumes the Geronimo Alternatively, you could choose to work with the active 2.1 .2 samples have been released. Prior to release you can checkout the snapshot versions viabranch of samples. This will allow you to work with the latest changes in samples but will also expose you to a branch that is under active development and so things may be in flux from day to day: |
Depending on when you look you may find earlier or released versions of the samples under samples/branches and samples/tags. You can browse in any web browser to see what's there. The trunk for samples always contains samples for the highest level version under development https://svn.apache.org/repos/asf/geronimo/samples/trunk
Build using
| Code Block | ||||
|---|---|---|---|---|
| ||||
mvn clean install |
| Note |
|---|
If you run into the "Could not scan module for TLD files...Filename too long" problem when using Windows platform, please check out samples to a short directory (14 characters or less). |
There are minimal integration tests to assure that the sample plugins can be installed on the framework server. To run this tests use
| Code Block | ||||
|---|---|---|---|---|
| ||||
mvn clean install -Pit |
| Note |
|---|
The integration tests are not available prior to Geronimo Samples 2.2 |
...
For this you can use any geronimo server such as one of the minimal assemblies or even the framework assembly. After starting geronimo, run ./bin/gsh deploy/list-plugins in another terminal window and follow the instructions. Installing a sample plugin will install the sample-datasource plugin and all other dependencies. Alternatively if you build using
| Code Block | ||||
|---|---|---|---|---|
| ||||
mvn clean install -Pit |
you can find a server with the sample installed in directories such as
| Code Block | ||||
|---|---|---|---|---|
| ||||
<sample>/<sample>-jetty/target/geronimo-framework-<version>/. |
| Note |
|---|
-Pit is currently only available in the samples trunk (2.2-SNAPSHOT) and not branches/2.1 (2.1.2 or 3-SNAPSHOT) or tags/samples-parent-2.1.2 (2.1.3-SNAPSHOT2) |
Deploying samples as javaee artifacts.
...
After building the sample projects you can find suitable geronimo plans for a sample <sample> in
| Code Block | ||||
|---|---|---|---|---|
| ||||
<sample>/<sample>-jetty/target/resources/META-INF/plan.xml |
...
Create a new datasource using the admin console database wizard, selecting the derby-embed-xa type and naming the database "SampleDatabase" and the datasource "SampleTxDatasource". The admin console will come up with a module Id different from what the samples need, so you have to map them in var/config/artifact_aliases.properties. Insert a line like this:
| Code Block | ||||
|---|---|---|---|---|
| ||||
org.apache.geronimo.samples/sample-datasource/2.1.2-SNAPSHOT/car=console.dbpool/SampleDatabase/1.0/car |
...