{scrollbar}

Similarly you can use the GShell deploy/assemble command specifying the same information on the command line interactively. For more information about how to use deploy/assemble, please use --help as followed.

User@server:/>deploy/assemble -help
assemble
 --

  --secure                         Use secure channel
  -a (--artifact) VAL              server artifact name
  -f (--format) VAL                zip or tar.gz
  -g (--groupId) VAL               server groupId
  -h (--help)                      Display this help message
  -l (--list)                      refresh plugin list
  -m (--mode) VAL                  custom assembly mode
  -p (--port) N                    Port, default 1099
  -s (--hostname, --server) VAL    Hostname, default localhost
  -t (--path) VAL                  assembly location
  -u (--username) VAL              Username
  -v (--version) VAL               server version
  -w (--password) VAL              Password

By default, target location of newly assembled server is directory /var/temp/assembly, target packge format is tar.gz and version number is 1.0. User will have to input groupId and artifactId.

# run using ./bin/gsh
User@server:/>deploy/assemble -g org.apache.geronimo.asseblies -a testServer -v 1.0 -u system -w manager

Then GShell will ask you with a list of assembly modes.

Available custom assembly modes:
 1:    Function Centric
 2:    Application Centric
 3:    Expert Users
Please select a custom assembly mode [1,2,3]

• Choose 1 or 2 then you have to select the framework plugin group (Geronimo Plugin Group :: Framework) which includes several plugins used to start the server.

• Choose 3 to assemble a server using plugins as an experienced user.

This page introduces how to customize a server with plugins from the existing one to meet requirements of your application.

Assembling a server from an existing server.

Just as with installing plugins, this can be done from the admin console, gshell, and the Geronimo Eclipse Plugin. In the admin console you specify the groupId and artifactId of the server you want, the version, the target path and the archive type and then select the plugins you want installed. The server will be assembled in var/temp by default.

Similarly you can use the gshell deploy/assemble command specifying the same information on the command line interactively.

...

• In order to get a working server you must include the

...

• plugin

...

• (Geronimo Assemblies :: Boilerplate) which includes several files used to start the server.

TODO: The groupId is not currently used but the intention is to copy the assembled server into an appropriate maven repository.

Here's an example of a gshell script to install the roller plugin into the framework assembly and extract a server that only supports roller (and does not include the admin console or any deployment capabilities)

TODO: use something like this: snippet:url=geronimo/plugins/roller/trunk/roller-jetty-commands

TODO: get gshell to accept line continuations as in the following (these DO NOT WORK IN REAL LIFE):

# assembles a server containing roller-jetty from the geronimo-framework server.
# run using ./bin/gsh < roller-jetty-commands
deploy/list-plugins -u system -w manager -r file:/Users/david/.m2/repository/\
 org.apache.geronimo.plugins/roller-jetty/0.0.2-SNAPSHOT/car\
 org.apache.geronimo.plugins/roller-themes/0.0.2-SNAPSHOT/car

deploy/assemble -g org.apache.geronimo.assemblies -a geronimo-roller-jetty -v 1.0-SNAPSHOT\
 org.apache.geronimo.assemblies/geronimo-boilerplate-minimal/2.1-SNAPSHOT/jar\
 org.apache.geronimo.plugins/roller-jetty/0.0.2-SNAPSHOT/car\
 org.apache.geronimo.plugins/roller-themes/0.0.2-SNAPSHOT/car

Note: look into Plugins Group for more details about differences between framework plugin group and boilerplate plugin.

After you input your choice, you will have to select plugin or plugins group you intend to install and click Enter. A few seconds later, your assembly will be ready for use.

**** Installation Complete!
Used existing: cglib/cglib-nodep/2.1_3/jar
...
Installed new: org.apache.geronimo.framework/jsr88-cli/2.2-SNAPSHOT/car

Downloaded 23085 kB in 25s (923 kB/s)

Go to <GERONIMO_HOME>/var/temp, you will find the package of newly assembled server with minimizing footprint and the fewest components you need only. By copying and extracting the package to any places you like, you can start the assembly as an independent server. Startup duration and system modules loaded are greatly reduced. Here is a snapshot of an assembly only with framework plugin group selected after startup.

Booting Geronimo Kernel (in Java 1.6.0)...
Module  1/11 org.apache.geronimo.framework/j2ee-system/2.2-SNAPSHOT/car
                              started in   .000s
Module  2/11 org.apache.geronimo.framework/transformer-agent/2.2-SNAPSHOT/car
                              started in   .000s
Module  3/11 org.apache.geronimo.framework/gshell-framework/2.2-SNAPSHOT/car
                              started in   .000s
Module  4/11 org.apache.geronimo.framework/gshell-geronimo/2.2-SNAPSHOT/car
                              started in   .000s
Module  5/11 org.apache.geronimo.framework/gshell-remote/2.2-SNAPSHOT/car
                              started in   .000s
Module  6/11 org.apache.geronimo.framework/jee-specs/2.2-SNAPSHOT/car
                              started in   .000s
Module  7/11 org.apache.geronimo.framework/rmi-naming/2.2-SNAPSHOT/car
                              started in   .453s
Module  8/11 org.apache.geronimo.plugins.classloaders/geronimo-javaee-deployment
_1.1MR3_spec/2.2-SNAPSHOT/car started in   .000s
Module  9/11 org.apache.geronimo.framework/plugin/2.2-SNAPSHOT/car
                              started in   .516s
Module 10/11 org.apache.geronimo.framework/j2ee-security/2.2-SNAPSHOT/car
                              started in   .140s
Module 11/11 org.apache.geronimo.framework/server-security-config/2.2-SNAPSHOT/c
ar                            started in   .047s
Startup completed in 1.969s seconds
  Listening on Ports:
    1099 0.0.0.0 RMI Naming
    9999 0.0.0.0 JMX Remoting Connector

Geronimo Application Server started

Refer to Plugins Group if you want to learn moreThe use of the GEP to assemble a custom server is very similar to the other methods. While the Geronimo server is running, use the server's popup menu to launch the Custom Server Assembly dialog. Specify the artifact name, group, version, archive type, path (relative to the running server), and plugins that you want installed. Once again, remember that the framework plugin group must be included to get a working server.