...
When you package your application you may include the deployment plan within the package or not. At deployment time, Geronimo will look for the deployment plan geronimo-web.xml
and deployment descriptor web.xml
deployment plans (or geronimo-application.xml
or geronimo-application-client.xml
depending the type of application) in the WEB-INF
directory within your packaged application. If Geronimo can not find those descriptors information it will attempt to deploy the application using defaults. If using defaults fails you will have to either provide a deployment plan repackaged in the application or provide an external deployment plan, in the following sections we will discuss further these alternatives.
...
Since the application we installed is HelloWold.WAR
, we use this Installed Web Applications portlet, when . When you install an EAR, you would check the status using the Installed Application EARs portlet available by selecting Application EARs on the Console Navigation menu on the left hand side. The installation procedure is the same for both WAR and EAR applications.
...
When you copy an application in the deploy
directory, let's say for example HelloWorld.war, you will see a confirmation message in the console where Geronimo is running stating the application was deployed and the context to access that application geronimo.log
which locates in the <geronimo_home>/var/log
directory.
No Format bgColor #000000 borderStyle solid
11:45:23,500 INFO [DirectoryHotDeployer] Deploying HelloWorld.war
11:45:23,953 INFO [DirectoryHotDeployer] Deployed sample.applications/HelloWorldApp/2.0/war @
http://hcunico:8080/hello
To remove the application, just delete the WAR or EAR file from the deploy
directory. When the application has been removed you should see a confirmation message in the console where Geronimo is running stating the application was undeployed geronimo.log
which locates in the <geronimo_home>/var/log
directory.
No Format bgColor #000000 borderStyle solid
11:46:17,953 INFO [DirectoryHotDeployer] Undeploying HelloWorld.war
11:46:18,281 INFO [DirectoryMonitor] Hot deployer notified that an artifact was removed: sample.applications/HelloWorldApp/2.0/war
11:46:18,281 INFO [DirectoryHotDeployer] Undeployed sample.applications/HelloWorldApp/2.0/war
h1. Via Deployer tool{
:deployertool}
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|deploy] 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 Anchor deployertool deployertool
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 Geronimo specific ones already included in the package.
Once deployed you should see a confirmation message similar to this one with moduleID sample.applications/HelloWorldApp/2.0/war
assigned to this application within your deployment plan: No Format bgColor #000000 borderStyle solid one:
{color:white}{noformat:borderStyle=solid| bgColor=#000000}
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.1
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.1
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.1\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 the Geronimo Administration Console, using the command line tool you receive more instant information in the command line for confirmation message. For instance you receive the Component Name (also known as 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.1
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.1
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.1\var\temp
Using JRE_HOME: C:\Java\jdk1.5.0_06\\jre
Found 85 modules
+ org.apache.geronimo.configs/activemq-broker/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/activemq-ra/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis2/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis2-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis2-ejb/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/axis2-ejb-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/ca-helper-tomcat/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/client-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/clustering/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/connector-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/cxf/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/cxf-ejb/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/dojo-legacy-tomcat/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/dojo-tomcat/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/hot-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/j2ee-corba-yoko/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/j2ee-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/j2ee-server/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/jasper/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/jasper-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/javamail/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/jaxws-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/jaxws-ejb-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/jsr88-rar-configurer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/mejb/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/myfaces/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/myfaces-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/openejb/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/openejb-corba-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/openejb-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/openjpa/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/persistence-jpa10-deployer/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/remote-deploy-tomcat/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/sharedlib/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/spring/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/system-database/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/tomcat6/2.1-SNAPSHOT/car
+ org.apache.geronimo.configs/tomcat6-clustering-builder-wadi/2.1-SNAPSHOT/car
Look for the sample.applications/HelloWorldApp/2.0/war
entry, that 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
directory using the Component Name you identified while listing the modulesmoduleID specified in the deployment plan.
deploy --user system --password manager undeploy sample.applications/HelloWorldApp/2.0/war
...
No Format bgColor #000000 borderStyle solid
D:\geronimo-tomcat6-jee5-2.0-M22\bin>deploy --user system --password manager undeploy sample.applications/HelloWorldApp/2.0/war
Using GERONIMO_BASE: D:\geronimo-tomcat6-jee5-2.12
Using GERONIMO_HOME: D:\geronimo-tomcat6-jee5-2.12
Using GERONIMO_TMPDIR: D:\geronimo-tomcat6-jee5-2.12\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:
These are not the only These are other options and commands available for this deployer tool, please visit the Tools and commands section for additional details.
...