Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

This topic is organized in the following sections:

...

Installing as prebuilt plugins

The recommended practice for Geronimo is to set up a workflow using Geronimo plugins and maven from development through test and production. To demonstrate this, the samples are built into plugins suitable for the Jetty and Tomcat Web containers in Geronimo. Many samples require database access. This is encapsulated into a separate plugin (sample-datasource).

...

...

TODO: Demonstrate how to swap databases using plugins; see also the roller plugin

...

In any case, to install samples as plugins you need to build them first.

...

For this you can use any Geronimo server such as one of the minimal assemblies or even the framework assembly. After starting geronimo, run deploy:list-plugins in the same 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

...

...

you can find a server with the sample installed in directories such as

...

...

Building from source

Downloading the source code

...

You need svn and maven installed on your system.

...

...

Maven v 2.2.1 or later is required for building Geronimo 3.0 samples.

...

To check out the 3.0M1 samples:

...

...

Alternatively, you could choose to work with the active 3.0 trunk 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:
svn co https://svn.apache.org/repos/asf/geronimo/samples/trunk gsamples-trunk

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 the samples using this command:

...

...

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 this command:

...

...

Deploying the built samples as Java EE artifacts

...

After building the sample projects you can find suitable geronimo plans for a sample <sample> in

...

...

(or the equivalent -tomcat directory). For most samples you will have to install the sample-datasource plugin first. Samples can be deployed from the administrative console "deploy new" on a suitable server or using Karaf Shell deploy:deploy-modules. Note that in this case you have to start with a server with all the required bits already installed, not the framework server. Since this installation method is not tested automatically it is more likely to be broken than the plugin method.

...

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:

...

...

replacing 3.0M1 with the appropriate sample version and adjusting the right hand side as necessary. Be sure Geronimo is stopped when you edit artifact_aliases.properties.

...

Maven Generated Site for viewing javadoc or source xref

...

...

Geronimo Samples 3.0M1 release did not generate the maven site for javadoc and source xref view. Cause Geronimo site scheme for 3.0M1 has some problem.

...

To navigate to javadoc and source code (xref) for each sample do the following:

...

Available Java EE sample applications

...

...