...

The geronimo command lets you perform the previous two actions, that is start and stop the server in different modes depending on the parameters you specify. This command has the following syntax:

*{{*<geronimo_home>/bin/geronimo \[*{*}{_}options{_}{*}*\]*}}*

The available options are:

...

You can start the Apache Geronimo server in two different ways by running the following commands:

<geronimo_home>java -Djava.endorsed.dirs=lib/endorsed -javaagent:bin/jpa.jar -jar bin/server.jar

or simply

<geronimo_home>/bin/startup

The startup command invokes server.jar.

In both cases this command accepts the following:

...

-vv --veryverbose
Sets the console log level to DEBUG, resulting in even more console output.

 *\-override \[*{*}{_}configId{_}{*}*\]*
Overrides the configurations in *<geronimo_home>/var/config.list* such that only the configurations listed on the command line will be started.  Note that many J2EE
features depend on certain configs being started, so you should be very careful what you omit.  Any arguments after *\-override* are assumed to be configuration names.

...

If the startup command starts the Apache Geronimo server, shutdown will definitively stop it. This command has the following syntax:

*{{*<geronimo_home>/bin/shutdown \[*{*}{_}options{_}{*}*\]*}}*

The available options are:

*\--user \[*{*}{_}user_name{_]*
}{*}*\]*
Specifies the user name with the authority to stop the server. By default you would normally use *system* as the user name.

*\--password \[*{*}{_}password{_}{*}*\]*
Specifies the password for the user name you just entered. By default you would normally use *manager* as the password.

*\--port \[*{*}{_}port_number{_}{*}*\]*
Specifies the RMI naming port to connect to the server (for example JMX connection port). By default you would normally use port *1099*.

If you do not specify any parameters, this command will prompt you for a user name and password and will assume port 1099 by default and will not prompt for any port.

Deployer tool

Anchor
Deployer tool Deployer tool

The deployer application is a Java application that manages J2EE artifacts and GBean components in the Geronimo server. If Geronimo is running, it will connect to the server and perform its action through the server's deployment service. If it cannot find a running server, it will throw an error stating it could not connect to the server or the server is unavailable.

...

Typically, the deployment tool is started by just using the deploy script, but you can also run the application by starting a Java virtual machine using the following syntax:

java -jar deployer.jar <general_options> <command> <command_options>

where <general_options> specify common options that apply to all commands and control how the application behaves, <command> is a command name that specifies the action to be performed, and <command_options> are options unique to the command specified.

...

This section lists all the available general options for the Geronimo deployer tool.

• Wiki Markup

  *\--uri* <identifier> Where <identifier> is a Universal Resource Identifier (URI) that specifies how the deployer is to contact the server. If this flag is not specified, the deployer will attempt to contact the server using the standard port on localhost. The identifier must have the following form: deployer:geronimo:jmx:rmi:///jndi/rmi:\[//host\[:port\]\]/JMXConnector where <host> is replaced with the host name or TCP/IP address of the system where the server is running and <port> is replaced with the port number where the server is listening. If unspecified, localhost and the default port will be used.

...

Additionally, you can type help for further details on a given command, the syntax is as follows:

java -jar deployer.jar help <commands>

Back to top

Deploy

Anchor
deploy deploy

Use the deploy command to add and start a new module. The deploy command has the following syntax:

java -jar deployer.jar <general_options> deploy <module> <deployment_plan>

The <module> specifies the application file name and location. The <deployment_plan> specifies the file name and location of the XML with the deployment plan. Sometimes the application module already has included in the package a deployment plan or the application is so simple that does not require any deployment plan, in these cases this parameter can be omited.

...

To use this option you should type:

java -jar deployer.jar <general_options> deploy --inPlace <app_home>

Where <app_home> indicates the home directory where you have your application (exploded).

You can also deploy applications if Geronimo is not running by using the --offline option, the syntax for this command would be:

java -jar deployer.jar <general_options> --offline deploy <module>

Off course, you can also combine --offline and --inPlace

java -jar deployer.jar <general_options> --offline deploy --inPlace <app_home>

Back to top

Login

Anchor
login login

Use the login command to save the username and password for the current connection to the file .geronimo-deployer in the current user's home directory. Future connections to the same server will try to use this saved authentication information instead of prompting where possible.

...

The login command has the following syntax:

java -jar deployer.jar --user <user_name> --password <password> login

So, next time you run a different command that originally required user name and password, you can run the command directly, for example:

deploy list-modules

...

Use the redeploy command to stop, replace and restart a module that has been deployed before. The redeploy command has the following syntax:

java -jar deployer.jar <general_options> redeploy <module> <deployment_plan>

Just like the deploy command, the redeploy command accepts the following modules file types:

...

Use the start command to start a previously deployed module. The start command has the following syntax:

java -jar deployer.jar <general_options> start <moduleIDs>

Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.

...

Use the stop command to stop a running module. The stop command has the following syntax:

java -jar deployer.jar <general_options> stop <moduleIDs>

Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.

...

Use the undeploy command to stop and remove a module (running or not) and its deployment information from the server. The undeploy command has the following syntax:

java -jar deployer.jar <general_options> undeploy <moduleIDs>

Where <moduleIDs> is a list of one or more modules (configID) separated by blank space. The module identification (or ConfigID) is defined at deployment time in the respective deployment plan for each module previously deployed.

This command has the same ability as with deploy to uninstall applications when the server is not running, this command has the following syntax:

java -jar deployer.jar <general_options> --offline undeploy <moduleID>

Back to top

Distribute

Anchor
distribute distribute

Use the distribute command to add a new module to the server. This command does not start the module nor mark it to be started in the future. The distribute command has the following syntax:

java -jar deployer.jar <general_options> distribute <module> <deployment_plan>

Just like with the deploy command, <module> specifies the application file name and location. The <deployment_plan> specifies the file name and location of the XML with the deployment plan. Sometimes the application module already has included in the package a deployment plan or the application is so simple that does not require any deployment plan, in these cases this parameter can be omited.

...

Use the list-modules command to list all available modules on the server, note that for running this command the server must be running. The list-modules command has the following syntax:

*{{{*}java \-jar deployer.jar <general_options> list-modules \[\-\-all\|\-\-started\|\-\-stopped\]*}}*

• --all : is used by default when no other option is specified. It will list all the available modules.
• --started : this option will list only the modules that are running.
• --stopped : this option will list only the modules that are not running.

...

Use the list-targets command to lists the targets known to the server you have connected to. The list-targets command has the following syntax:

java -jar deployer.jar <general_options> list-targets

In the case of Geronimo, each configuration store is a separate target. Geronimo does not yet support clusters as targets.

...

Use the install-plugin command to install a Geronimo plugin previously exported from a Geronimo server or downloaded from a repository. A Geronimo plugin can be an application, a configuration such data sources and drivers or a combination. The install-plugin command has the following syntax:

java -jar deployer.jar install-plugin <plugin_file>

Back to top

Search-plugins

Anchor
search-plugins search-plugins

Use the search-plugins command to list all the Geronimo plugins available in a Maven repository. The search-plugins command has the following syntax:

java -jar deployer.jar search-plugins <maven_repository_URL>

Back to top

deploy

The deployer tool is used for installing, uninstalling, reinstalling, starting and stopping applications and modules and for installing and uninstalling configurations (for example some configuration specific deployment plans, security realms, database connection pools etc.). Due to the number of options in this case, this tool is covered in detail in the Deployer tool section.

...

As with the startup command, the deployment tool can also be invoked in two different ways:

*{{{*}java \-jar deployer.jar \[*{*}{_}general_options{_}{*}*\] <*{*}{_}command{_}{*}*> \[*{*}{_}command_options{_}{*}*\]*}}*

or simply

*{{{*}deploy \[*{*}{_}general_options{_}{*}*\] <*{*}{_}command{_}{*}*> \[*{*}{_}command_options{_}{*}*\]*}}*

Please refer to Deployer tool for a fully detailed description of this tool options and usage.

...

The client.jar launches the client application container. This command has the following syntax:

*{{{*}java \-jar client.jar config-name \[app arg\] \[app arg\] ...*}}*

The first argument identifies the Geronimo configuration that contains the application client you want to run. The rest of the arguments will be passed as arguments to the client application when it is started.

...

In order to get runtime enhancement you need to start the server with our jpa agent with a command line like this:

<geronimo_home>java -javaagent:bin/jpa.jar -jar bin/server.jar