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

...

When you package your application, you might include the deployment plan within the package or not. At deployment time, Geronimo looks for the deployment plan (for example, geronimo-web.xml and deployment descriptor (for example,web.xml, geronimo-application.xml or geronimo-application-client.xml depending on the type of application) in the WEB-INF directory within your packaged application. If Geronimo can not cannot find those information, it will attempt attempts 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 . In the following sections, we will discuss further these alternatives.

...

To install a new application via by using the Geronimo Administration Console the Install New Applications portlet is available by selecting , select Deployer on the Console Navigation menu on the left hand side . This portlet also allows you to launch the Install Applications portlet. You can choose to start automatically the application automatically right after it was deployedis deployed by selecting the start application after installation check box. This check box is selected by default.

For this example, we will be using use the simple JSP HelloWorld sample that was created in the Quick start - Apache Geronimo for the impatient section. In that section, however, we used the --inPlace deployment option , in other words we and did not need to package the application into a WAR file. To create the WAR file type, run the following command from the <app_home> directory:

jar -cvf HelloWorld.war *

This WAR has already has included the deployment plans in the package the deployment plans.

Back in the Geronimo Administration Console, from the Install New Applications portlet, click on Browse to specify the path to the HelloWorld.war in the Archive: section. Make sure that the Start app after install checkbox application after installation check box is selected (by default is checked) and then click on Install.

You should see the " The application was successfully deployed. " and " The application was successfully started. " confirmation messages on the top of the portlet.

Another way to verify that the application has been is successfully installed and started is by checking the Installed Web Applications portlet, which is available by selecting Web App WARs on the Console Navigation menu on the left hand side. You should see the application listed as hello and with the status running.

Since Because the application we installed is HelloWold.WAR, we use this Installed Web Applications portlet to verify the installation. When you install an EAR, you would check the status by 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.

To remove the applications through by using the Geronimo Administration Console you would use these two portlets, , use either the Installed Web Applications portlet or the Installed Application EARs portlets depending on the application to uninstall.

...

For our example, access the Installed Web Applications portlet and click on Uninstall for the application that has the Component Name listing sample.applications/HelloWorldApp/1.0/war. This will stop the application first and then uninstall it. The confirmation message " Uninstalled application " should be listed at the bottom of the portlet.

These are the basic steps for installing and uninstalling applications via by using the Geronimo Administration Console, the . The following two sections will focus on the command line options.

...

Apache Geronimo has support for Hot Deployment, which means that you can copy an application JAR file into the <geronimo_home>/deploy directory and the application will be deployed automatically. This will also work works for uninstalling or refreshing applications previously deployed via by using this method. Alternatively, you may can also copy the directory (unpacked) for the application module instead of copying a single JAR file.

Note that with this deployment method, you have to include the deployment plan in the application package , because this method does not support external deployment plans. Also note that applications deployed via by using the Deployer tool or the Geronimo Administration Console will are not be listed in the <geronimo_home>/deploy directory.

When you copy an application in into the deploy directory, for example HelloWorld.war, you will see a confirmation message in the geronimo.log, which locates is located in the <geronimo_home>/var/log directory.

...

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 geronimo.log, which locates is located in the <geronimo_home>/var/log directory.

...

Via Deployer tool
Anchor
deployertool
deployertool

The You can use the deployer tool will allow you, among other things, to install and uninstall applications via by running a command line. In this section, we will focus focuses on just these two tasks for the sample application, the . The remaining functionality is fully covered in the Deployer tool section.

To deploy the HelloWorld.war sample application by using the Deployer tool, open a command line window and type the following command from the <geronimo_home>\bin directory:

...

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 to the previous command.

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 . You do not need to use the geronimo-XYZ.xml form. In our example, we do not need to specify any additional deployment plans as because we have the Geronimo specific ones already included in the package.

Once deployed After you deploy the application, you should see a confirmation message similar to this the following one with the moduleID sample.applications/HelloWorldApp/1.0/war, which is assigned to this application within your deployment plan: No FormatbgColor#000000. The confirmation message is displayed in the command window, which is different from the case when you deploy by using the Geronimo Administration Console.

No Format
borderStylesolid

D:\geronimo-tomcat7-javaee6-3.0\bin>deploy --user system --password manager deploy \HelloWorld_1.0\HelloWorld.war
Using GERONIMO_BASE:   D:\geronimo-tomcat7-javaee6-3.0
Using GERONIMO_HOME:   D:\geronimo-tomcat7-javaee6-3.0
Using GERONIMO_TMPDIR: D:\geronimo-tomcat7-javaee6-3.0\var\temp
Using JRE_HOME:        C:\Java\jdk1.6.0_21\\jre
    Deployed sample.applications/HelloWorldApp/1.0/war @ /hello

As a difference from the deployment via the Geronimo Administration Console, using the command line tool you receive instant information in the command line for confirmation. Alternatively, if you have not yet packaged your application, you could use the --inPlace option for deploying your application directly from the directory where 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:

...

To uninstall an application, run the following command from the <geronimo_home>\bin directory using with the moduleID specified in the deployment plan.

deploy --user system --password manager undeploy sample.applications/HelloWorldApp/1.0/war

This command will first stop the running application and then uninstall it. You should see a confirmation message similar to thisthe following one:

No Format

...

...

borderStylesolid

D:\geronimo-tomcat7-javaee6-3.0\bin>deploy --user system --password manager undeploy sample.applications/HelloWorldApp/1.0/war
Using GERONIMO_BASE:   D:\geronimo-tomcat7-javaee6-3.0
Using GERONIMO_HOME:   D:\geronimo-tomcat7-javaee6-3.0
Using GERONIMO_TMPDIR: D:\geronimo-tomcat7-javaee6-3.0\var\temp
Using JRE_HOME:        C:\Java\jdk1.6.0_21\\jre
    Module sample.applications/HelloWorldApp/1.0/war unloaded.
    Module sample.applications/HelloWorldApp/1.0/war uninstalled.

    Undeployed sample.applications/HelloWorldApp/1.0/war

These There are other options and commands available for this deployer tool, please visit the Tools and commands section for additional details.

...