THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
This page describes various options to configure your development environment.
Editing a server configuration
In order to edit the configuration of a server, double click on server in the Servers view to open the overview of the server as shown below.
- General Information
Edit the fields in this section to change the name of the server or to associate the Geronimo Server with a different Apache Geronimo v2.1 Runtime or to change the hostname with which the Geronimo Server is associated. - Security Credentials
The default User ID is system with a password manager. If your server installation uses a different set of credentials, change these accordingly. These security credentials configured here are used to detect server status as well as deploying and undeploying of applications. - Automatic Publishing
All servers use the default publishing settings. The server can be configured to not publish automatically by selecting the Never publish automatically option. The default publish setting can be overridden by selecting the Override default settings option and providing a new Publish interval. - Port Configuration
The default HTTP and RMI ports are 8080 and 1099 respectively. If your server installation uses a different HTTP and/or RMI port, edit these values accordingly. Altering the values here does not change the corresponding ports in the associated Geronimo Server Runtime. - Console Output
The default server console output log level is INFO. If you want to enable debug output to console, select DEBUG. - Server Startup
The settings under this section control the ping thread that polls to the server to detect the server status when the server is started from within eclipse. Ping delay specifies the time the ping thread will wait before polling the server. Ping interval controls the time between successive pings. Maximum Pings is the number of times the ping thread will poll the server to detect a successful startup. If the server startup can not be confirmed, the ping thread will stop the server.
In case of a remote server, Ping interval controls the time between successive pings to update the server status. - Server VM Arguments
Any additional arguments to be passed on to the server VM can be specified here.
Converting Applications into Geronimo Plugins
In this section we discuss how to use the Geronimo Eclipse Plugin to convert Applications into Geronimo Plugins and install them to the server.
Creating Geronimo Plugins
In order to convert applications into Geronimo Plugins, the Geronimo Server must be installed and started. Clicking on the server's "Launch Plugin Manager" popup menu item will bring up the Plugin Manager wizard that is shown below.
Enter or create a directory and select the "create Geronimo plugin" radio button. The directory is a temporary place to save the application and will give you a chance to make any manual updates if necessary.
The next page of the dialog contains a drop down list of all the objects that can be converted into Geronimo plugins. Many of the objects in this list are already plugins that are used by the Geronimo server. Selecting your application objects (one at a time) and clicking next will bring up pages that will allow you to change the geronimo-plugin.xml before saving. All fields on the next two pages are data that will be saved with the plugin and will help with installation.
- Name
A human-readable name that will be displayed for this plugin. - id
The globally unique ID for this plugin. This is determined from the installation in the server you're exporting. This defines the version number for the plugin, so make sure it's correct. - Download Repos
A list of repositories to check for any dependencies that need to be downloaded. This should be a list of one URL per line, with values such as http://geronimoplugins.com/repository/
and http://www.ibiblio.org/maven2/. Note that the repository this plugin is deployed to should typically be the first one listed. - Category
The category this plugin falls into. Plugins in the same category will be listed together. If this plugin is intended to be listed on geronimoplugins.com then you should use one of the category names there if any of them fit. Otherwise, you can select this freely, or according to the categories acceptable to the repository where you plan to post this. - Description
A description of this plugin. You should use plain text only, with blank lines to separate paragraphs. - Plugin URL
A URL to get more information about the plugin (e.g. the plugin home page). - Author
The author of the plug, which may be a person, company, open source project, etc. - Geronimo Versions
An optional list of Geronimo versions supported by this plugin. If no values are listed, the plugin can be installed in any version of Geronimo. Otherwise, list one acceptable Geronimo version per line. - JVM Versions
An optional list of JVM version prefixes supported by this plugin. If no values are listed, the plugin can be installed in Geronimo running in any version of the JVM. Otherwise, list one acceptable JVM version prefix per line. - Dependencies
A list of JARs or other module IDs that this plugin depends on. These will be downloaded automatically when this plugin is installed. Normally you shouldn't change this list. However, you can move entries from the dependency list to the prerequisite list if the user must install the dependency manually before installing the plugin (e.g. for a database pool where a plugin wouldn't know what server to connect to). Each entry in this list should use the Unique ID format like is used for this plugin above. You may remove the version number if you'd like to work with any version of the dependency, though that may be risky. Each value should be on a separate line. - Obsoletes
A list of module IDs that this plugin replaces. Those plugins or modules will be removed when this one is installed. That may include previous versions of this plugin if you want installing it to "upgrade" rather than just offering an additional alternative. This should be a list with one module ID per line.
The next page has 2 tables. The data in both the License table and Prerequisite table can be updated using the Add, Edit, and Remove buttons.
- Licenses
The name of the license that this plugin is covered by. Ideally, it would be prefixed by the class of license, like "BSD – (name)" or "GPL – (name)". Specify whether the license is an OSI-approved open source license (see http://www.opensource.org/licenses/index.php). - Prerequisites
The module IDs of prerequisites for this plugin. These are modules that must be present in the server before the plugin can be installed. They may be something like a specific web container for a web application (geronimo/jetty//car) or something like a database pool or security realm that the user must install because the plugin author can't create a value that will be valid in the destination server. You may want to leave out as many segments of the module ID as possible in order to accommodate more users (e.g. */mypool//* rather than myapp/mypool/1.2/car).
Clicking Next on this page saves the plugin and the geronimo-plugin.xml file and returns the user back to the first page.
For saving multiple projects or applications, repeat the above steps. If you need to update the geronimo-plugin.xml file after saving, you can edit this file manually. When it is installed in the next step, the updates will be saved.
Installing Geronimo Plugins
If you haven't done so already, remove the projects from the server. From the main page of the Plugin Manager wizard, select "install Geronimo plugins" and click Next.
Select all the Geronimo plugins that you want to install on the server. If Installable is false, then the plugin cannot be selected. The most common reasons that a plugin cannot be installed are if the version of the plugin is already installed on the server or if prerequisites are not available. Clicking next will install all selected plugins.
Creating and using a custom server assembly
In this section we discuss how to use the Geronimo Eclipse Plugin to create and use a custom server assembly.
Creating a custom server assembly
In order to create a custom server assembly, you must already have a Geronimo Server installed and started. The popup menu on the running server has a "Launch Server Custom Assembly" menu on it. Clicking this menu item will bring up the Server Custom Assembly dialog that is shown below.
Enter in the pertinent information and select all the plugins that you desire to have in the new server. The "Geronimo Assembly :: Boilerplate Minimal" plugin MUST be selected in order to create a working server. The working server will be placed in the specified directory. A tar ball or zip file will also be placed in the "var/temp" directory of the running server for easy distribution.
Using a custom server assembly
Now that we have created the custom server assembly above, it is time to use it. Stop the original server and uninstall it (easiest done by using the Windows Preferences dialog via the Server Runtime Environments page). Use the same method that you used to install the original server with one small difference. This time, point to the directory where the newly created server is.
In place of the full Geronimo server that you started with, you should now have a valid custom Geronimo Server.