Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Installing the extensible administration console into a Geronimo minimal assembly
  2. Installing an ACE in the .war format from disk
  3. Installing an ACE in the .car format from an online repository
    Noteinfo
    titleWhich kind of file format do I want ?
    • Need console extensions for a component you already have? If you are planning to add Administration Console portlets for a component that is already installed on your server, a .war file is simplest. A .war-format ACE has only the needed portlets, and is dependent on the component already being installed.
    • Need the component and its extensions? If you need to install both a new component and its associated Admin Console portlets, a .car file is the right choice. This will look up and download all the necessary components and dependencies, and will also install the new ACE file. A .car file can also be used if the component is already installed.
    • Not sure? If you aren't sure that you have all the pre-requisites installed, a .car is the safest option. This will work regardless of whether the component is pre-installed or not.
    Noteinfo
    titleWhat about installing a .car file from disk?

    Unfortunately, it is not possible to install a .car file from disk with the current Geronimo Administration Console. However you can still use the "deploy install-plugin" tool from the command line. For more information, read up on the deployer tool at http://cwiki.apache.org/GMOxDOC11/deployer-tool.html

...

Once updated, we need to verify this (and subsequent) steps.

Noteinfo

Now you can point your web browser to http://localhost:8080/console and see the newly installed console.

Installing an ACE in .war format from an archive file

An ACE in .war format will install only the console extension. Its pre-requisite must already be installed on your system. For example, if you were installing a console extension to monitor a Derby database, Derby would need to be pre-installed on your server.
Prerequisites

  1. You have a .war-format ACE to be installed.
  2. The Extensible Administration Console is already deployed, as described above.
  3. Any pre-requisites for the ACE are already installed.
    Instructions
  4. Open the administrative console in an internet browser at address http://localhost:8080/console.
  5. Select Deployer on the left navigation bar.
  6. Click Browse and navigate to the ACE file.
  7. Click Install.
  8. Refresh your browser. Your new component will show up on the left side navigation menu.

Installing an Administration Console Extension in .car format from a repository

An ACE in the .car format installs a component and adds its configuration portlets to the Extensible Administration Console.
Prerequisites

  1. Your plugin provider already has specified a repository URL. For a larger selection of available plugins, checking http://geronimo.apache.org/plugins/geronimo-3.0/ is a good place to start.
  2. The Extensible Administration Console already installed, as described in the previous section.

Instructions

  1. Access the Extensible Administration Console by pointing a web browser to the following address http://localhost:8080/console.
  2. Select Plugins on the left navigation bar.
  3. Under Install Geronimo Plugins, click Update Repository List to add the default plugin repositories of Geronimo 3.0 into the repository list.
    • If the correct address does not appear in the Repository list, select Add Repository.
    • Type the repository's address in the New Repository textbox. Make sure to include the forward-slash( / ) at the end of the address. Select Add Repository.
    • Click Update Repository List. The new address will now appear in the Repository list.
      Note

  4. With the correct repository displayed in the Repository box, select Show Plugins in selected repository.
  5. Choose the plugin from the Available Plugins list by clicking directly on the plugin name.
    • If the Installable field of the desired plugin is marked as a red-cross, the plugin may already be installed on your server. Check for its name on the System Modules tab to make sure it is running, and to start or uninstall it if necessary.
    • If the list of Available Plugins does not display, or the desired plugin is not listed, you may have entered the wrong repository address. Try entering it again. If problems continue, contact the plugin provider or email the user mailing list at user@geronimo.apache.org.
      6. Select the plugins to be added and then click *Install at the bottom of the page.
      7. When the plugin installation is complete, refresh your browser. A new menu item will appear on the left. You can now configure this plugin's settings from the newly installed portlets.

...

Panel
titleDependency relationship of the pieces
indent
0
0
	PortalContainer 
indent
1
1
	\|\-PortalContainerServiceGBean 
indent
2
2
	\|\-AdminConsoleExtensionGBean 
indent
1
1
	\|\-Pluto Portal 
indent
2
2
	\|\-Administration Console 
indent
3
3
	\|\-New Portlet 

The PortalContainer is the base requirement for the administration console. The Pluto Portal and the PortalContainerServiceGBean are the base requirements to install anything into the framework of the console. The administration console and the AdminConsoleExtensionGBean depends on the PortalContainerServiceGBean and the Pluto Portal. In order to add new console extensions, all of the described components must be in place.

...

Panel
titlesample structure for a simple war

HelloWorldPortlet.war

indent
1
1
 \|\-WEB-INF/
indent
2
2
 \|\-classes/
indent
3
3
 \|\-(portlet class files)
indent
2
2
 \|\-geronimo-web.xml
indent
2
2
 \|\-portlet.xml
indent
2
2
 \|\-web.xml

Deploying the application

...