...
These are the basic steps for installing and uninstalling applications via the Geronimo Administration Console, the following two sections will focus on the command line options.
Deployer tool
The deployer tool will allow you, among other things, install and uninstall applications via a command line. In this section we will focus on just these two tasks for the sample application, the remaining functionality is fully covered in the Deployer tool section.
To deploy the HelloWorld.war sample application using the Deployer tool open a command line window and type the following command from the <geronimo_home>\bin directory:
deploy --user system --password manager deploy <app_home>\HelloWorld.war
If your application does not include the Geronimo specific deployment plan in the WEB-INF directory you can still, just like with the Geronimo Administration Console, specify it externally. You just need to add to the previous command the path and file name of the deployment plan.
deploy --user system --password manager deploy <app_home>\HelloWorld.war <deployment_plan_home>\plan.xml
Note that when specifying the deployment plan externally you can use any file name to identify that plan, there is no need to use the geronimo-XYZ.xml
form. In our example we do not need to specify any additional deployment plans as we have the Geroniom specific ones already included in the package.
Once deployed you should see a confirmation message similar to this one:
No Format bgColor #000000 borderStyle solid
D:\geronimo-tomcat6-jee5-2.0-M2\bin>deploy --user system --password manager deploy \HelloWorld_2.0\HelloWorld.war
Using GERONIMO_BASE: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.0-M2\var\temp
Using JRE_HOME: C:\Java\jdk1.5.0_06\\jre
Deployed sample.applications/HelloWorldApp/2.0/war @
http://hcunico:8080/hello
As a difference from the deployment via de Geronimo Administration Console, using the command line tool you receive more information in the confirmation message. For instance you receive the Component Name (a.k.a. moduleId) and you also receive the context root and port where the application was deployed. This is very useful when installing, testing and uninstalling several different applications where it would be hard to remember all these values.
Alternatively, if you have not yet packaged your application you could use the --inPlace option for deploying your application directly from the directory you are actually developing the application. This option is used to deploy this sample application in the [ Quick start - Apache Geronimo for the impatient] section.
In this case you would use this command from the <geronimo_home>\bin directory:
deploy --user system --password manager deploy --inplace <app_home>
The Deployer tool can also be used to list all the installed applications. The list-modules command allows you to list all the applications, it also lets you narrow down the query by asking for just the started or stopped applications. The list-modules command without additional parameter will list by default all the started applications.
To uninstall an application you may want to list it first to get the right Component Name (or moduleId). Run the following command from the <geronimo_home>\bin directory:
deploy --user system --password manager list-modules
You will receive a list similar as the one shown in the following example.
No Format bgColor #000000 borderStyle solid
D:\geronimo-tomcat6-jee5-2.0-M2\bin>deploy --user system --password manager list-modules
Using GERONIMO_BASE: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.0-M2\var\temp
Using JRE_HOME: C:\Java\jdk1.5.0_06\\jre
Found 47 modules
+ console.dbpool/LocalDB/1.0/rar
+ console.dbpool/jdbc%2FTradeDataSource/1.0/rar
+ org.apache.geronimo.configs/activemq/2.0-M2/car
+ org.apache.geronimo.configs/activemq-broker/2.0-M2/car
+ org.apache.geronimo.configs/axis/2.0-M2/car
+ org.apache.geronimo.configs/axis-deployer/2.0-M2/car
+ org.apache.geronimo.configs/axis2/2.0-M2/car
+ org.apache.geronimo.configs/axis2-deployer/2.0-M2/car
+ org.apache.geronimo.configs/client-deployer/2.0-M2/car
+ org.apache.geronimo.configs/connector-deployer/2.0-M2/car
+ org.apache.geronimo.configs/cxf/2.0-M2/car
+ org.apache.geronimo.configs/cxf-deployer/2.0-M2/car
+ org.apache.geronimo.configs/dojo-tomcat/2.0-M2/car @ http://hcunico:8080/dojo
+ org.apache.geronimo.configs/geronimo-gbean-deployer/2.0-M2/car
+ org.apache.geronimo.configs/hot-deployer/2.0-M2/car
+ org.apache.geronimo.configs/j2ee-deployer/2.0-M2/car
+ org.apache.geronimo.configs/j2ee-security/2.0-M2/car
+ org.apache.geronimo.configs/j2ee-server/2.0-M2/car
+ org.apache.geronimo.configs/j2ee-system/2.0-M2/car
+ org.apache.geronimo.configs/javamail/2.0-M2/car
+ org.apache.geronimo.configs/jee-specs/2.0-M2/car
+ org.apache.geronimo.configs/openejb/2.0-M2/car
+ org.apache.geronimo.configs/openejb-deployer/2.0-M2/car
+ org.apache.geronimo.configs/persistence-jpa10-deployer/2.0-M2/car
+ org.apache.geronimo.configs/remote-deploy-tomcat/2.0-M2/car @ http://hcunico:8080/remote-deploy
+ org.apache.geronimo.configs/rmi-naming/2.0-M2/car
+ org.apache.geronimo.configs/sharedlib/2.0-M2/car
+ org.apache.geronimo.configs/system-database/2.0-M2/car
+ org.apache.geronimo.configs/tomcat6/2.0-M2/car
+ org.apache.geronimo.configs/tomcat6-deployer/2.0-M2/car
+ org.apache.geronimo.configs/transaction-jta11/2.0-M2/car
+ org.apache.geronimo.configs/webconsole-tomcat/2.0-M2/car
`-> standard.war @ http://hcunico:8080/console-standard
`-> framework.war @ http://hcunico:8080/console
+ org.apache.geronimo.configs/webservices-common/2.0-M2/car
+ org.apache.geronimo.configs/welcome-tomcat/2.0-M2/car @ http://hcunico:8080/
+ sample.applications/HelloWorldApp/2.0/war @ http://hcunico:8080/hello
org.apache.geronimo.configs/ca-helper-tomcat/2.0-M2/car
org.apache.geronimo.configs/client/2.0-M2/car
org.apache.geronimo.configs/client-security/2.0-M2/car
org.apache.geronimo.configs/client-system/2.0-M2/car
org.apache.geronimo.configs/client-transaction/2.0-M2/car
org.apache.geronimo.configs/directory/2.0-M2/car
org.apache.geronimo.configs/ldap-realm/2.0-M2/car
org.apache.geronimo.configs/online-deployer/2.0-M2/car
org.apache.geronimo.configs/openjpa/2.0-M2/car
org.apache.geronimo.configs/shutdown/2.0-M2/car
org.apache.geronimo.configs/transformer-agent/2.0-M2/car
org.apache.geronimo.configs/uddi-tomcat/2.0-M2/car
Look for the sample.applications/HelloWorldApp/2.0/war
entry, thas is the value you will have to use when trying to uninstall the application.
To uninstall the application run the following command from the <geronimo_home>\bin diretory using the Component Name you identified while listing the modules.
deploy --user system --password manager undeploy sample.applications/HelloWorldApp/2.0/war
This command will first stop the runnning application and then uninstall it. You should see a confirmation message similar to this:
No Format bgColor #000000 borderStyle solid
D:\geronimo-tomcat6-jee5-2.0-M2\bin>deploy --user system --password manager undeploy sample.applications/HelloWorldApp/2.0/war
Using GERONIMO_BASE: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.0-M2
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.0-M2\var\temp
Using JRE_HOME: C:\Java\jdk1.5.0_06\\jre
Module sample.applications/HelloWorldApp/2.0/war unloaded.
Module sample.applications/HelloWorldApp/2.0/war uninstalled.
Undeployed sample.applications/HelloWorldApp/2.0/war
In this example you have used the same tool with three different commands:
- deploy
- list-modules
- undeploy
These are not the only options and commands available for this tool, please visit the Tools and commands section for additional details.