Page History

{toc

:maxlevel

=2}

h2. Introduction

{excerpt}The Extensible Administration Console is a new Administration Console designed to mirror the flexibility of Geronimo's architecture.{excerpt} While the previous console was static, allowing configuration only for pre-defined components, the new Extensible Console changes dynamically with the components installed on your server.

This framework allows Geronimo plugin developers to package extensions to the Administration Console (called ACEs) with their components. On installation of a plugin, this new content will automatically be added to the Extensible Administration Console, so that the user can manage all of the configuration and tools from one place.

h3. Objective

After reading this document, a Geronimo user will be able to
# Install the Extensible Administration Console into a Geronimo Framework assembly (Tomcat or Jetty)
# Download and install an Administrative Console Extension

h3. Scope

This document covers installing Geronimo's Administration Console into a Geronimo minimal assembly and the process to install an ACE plugin. For more information about the underlying architecture and ACE development, see the Administration Console Extension Developer's Guide.

h3. Who should read this document

These instructions are geared towards a basic user of Geronimo who wants to install new components on the administration console. Knowledge of the internal workings of the server is not necessary.

h3. Assumptions

The reader should be familiar with the Geronimo application server and its applications. The reader should also be familiar with the basics of Geronimo's plugin framework. For more information about the architecture, this guide may also be a valuable resource: [http://media.wiley.com/product_ancillary/31/04717854/DOWNLOAD/Pro_Apache_Geronimo_ch17.pdf].

The reader should have Apache Geronimo 3.0 Minimal+Web Container assembly installed and running, with either Tomcat7 or Jetty8 as the web container. The Java EE assemblies already have the Extensible Aministration Console installed.  For more information about getting started or getting updated to the right version, see this website: [http://cwiki.apache.org/GMOxDOC30/installation.html].

h2.

 Installation Planning

This section will prepare the user to install an ACE by providing the necessary terminology and introducing the installation scenarios that will be discussed.

h3.

 Common Terminology

	*Plugin* - An archive file (.car or .war) that can be installed into Geronimo to install a specific new service, such as ActiveMQ. For more about plugins, or to look at available plugins, check out geronimoplugins.com or geronimoplugincentral.org.

	*.CAR file* (Configuration ARchive) - An archive file that stores Geronimo-specific configurations, as well as the classes, libraries, web pages, and other information associated with an application.

	*.WAR file* (Web ARchive)- An archive file that contains a web application, including all of its classes, libraries, HTML and JSP pages, and other information. It can be deployed on any Java Enterprise compatible servlet container.

	*ACE* (Administration Console Extension) - An archive file (either a .car or a .war), that includes Administration Console portlets. These portlets will be added to the Extensible Administration Console when the ACE is activated.

	*Extensible Administration console* - A flexible version of Geronimo's original administration console. Once installed it is available at http://localhost:8080/console

, and includes some portlets that correspond to the currently activated services in Geronimo.

 
	*Service* - a component or set of functionality for Geronimo - it may be pre-installed, such as the Tomcat or Jetty web container, or it may be installed as a plugin.

	*Minimal console* - The administration console as it is first installed - with only the services necessary for basic functionality.

	*Portlet* - A web user interface component that can be assembled together with other similar components to create a web (portal) page. See the Portlet Specification JSR 286.

h3. Installation Scenarios

# Installing the extensible administration console into a Geronimo minimal assembly

# Installing an ACE in the .war format from disk

# Installing an ACE in the .car format from an online repository

{note

:title

=Which 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.

{note}
{note:title=What 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

]
{note}

h2.Installing the Extensible Administration Console

This section covers all the necessary steps to install the new Extensible Administration Console on your Geronimo 3.0 Minimal Server. The Geronimo 3.0 Java EE servers already have the console installed.

h3. Prerequisites

# Geronimo 3.0 - Minimal is installed ("Little-G")

# No other Geronimo administration console is currently installed

h3. Install as a plugin

# Start Geronimo

# Use the *deploy:list-plugins* command to download and install the administration console from the online plugin repository. Depending on the web container support in your minimal server, choose:

{noformat

} deploy:list-plugins -r http://geronimo.apache.org/plugins/geronimo-3.0/ org.apache.geronimo.plugins/console-tomcat/3.0/car

{noformat}
or
{noformat}deploy:list-plugins -r http://geronimo.apache.org/plugins/geronimo-3.0/ org.apache.geronimo.plugins/console-jetty/3.0/car

{noformat}


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

#* Click *Update Repository List*. The new address will now appear in the Repository list.{note}
# With the correct repository displayed in the Repository box, select *Show Plugins in selected repository*.
# 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.

h2. Examples

h3. Installing the HelloWorld ACE (.war file)

This is an example of a simple ACE file. It is not attached to any components - it simply adds a new "Hello World" portlet to the Extensible Administration Console.

1. Download example-extension-new.war [^example_extension_new.war]
2. Access the Extensible Administration Console by pointing your web browser to [http://localhost:8080/console].

3. Select Deploy New on the left navigation bar.

4. Click browse next to Archive and select the example-extension-new.war file. Leave the Plan box blank, Start app after install checked, and Redeploy application unchecked

.
!helloworld1.jpg!
5. Click Install. Your new component will show up on the left side navigation menu.

!helloworld2.jpg!

h2. Customization

Often times when a user installs Geronimo, the Administration Console will be the first place they go in order to configure their application server. For this reason, it is important that the administration console be a feature that provides users with the necessary functionality to easily manage plugins and components of the server.  The administration console allows  dynamic control over administration features. As such, it reflects the highly flexible and pluggable underlying architecture of Geronimo. What we have done here is to provide a framework for plugin developers to include administration console extensions for their plugins. The aim has been to provide an easy and flexible solution with a simple architecture such that users of Geronimo can intuitively configure components, and developers can easily expand upon the foundation laid out here.

The purpose of the remainder of this document is to provide developers with the necessary instructions to utilize the infrastructure provided by the administration console to add customized console extensions for their Apache Geronimo plugins. The first portion will describe the plumbing of the system and how it works, and the latter portions will provide a solid example of what to expect in order to actually create your own functioning console extension.

h2. Architecture
Below we have a high level view of the interactions between a new plugin and Pluto. This is essentially the 'plumbing' beneath the administration console.
{center}
!HighLevelPluto.jpg!
Figure 1 - High level view of Pluto's interaction with a deployable WAR
{center}

We have a WAR file containing portlet information and the definition of an Administration Console Extension (ACE) GBean on the left. The ACE GBean is the way in which we can invoke operations on Pluto (this will be covered shortly).

The portlet container that we use is Apache Pluto 1.2. Pluto allows for dynamically adding and removing pages and portlets without restarting the portlet container. The approach is important from a user interface standpoint, because we are not forced into performance bottle necks by restarting server components unnecessarily.

The dashed box around Pluto and its Pluto's API is intended to describe the approach taken to decouple Pluto's implementation from our own. This is a design decision to allow Pluto to be replaced by a different portlet engine for possible future development. 

h3. Understanding Through Usecases
Let's dig into the architecture a bit more now. It should be noted that the intended purpose of this architecture is to leverage Geronimo's flexible nature, as well as have the actual administration console be reflective of Geronimo's pluggability. The infrastructure should be simple to understand and easy to build on top of.

The first use case we will look at will also be used to describe the individual pieces that make administration console function.
{center}
!startcase.jpg!
Figure 2 - Use case for adding features to the console
{center}

On the left, we begin with a simple Geronimo deployment plan, for example, geronimo-web.xml. This deployment plan is the same deployment plan included in any archive that you may wish to deploy into Geronimo. In this case, the deployment plan includes the definition for a special {{AdminConsoleExtensionGBean}}. The specifics of what goes into an {{AdminConsoleExtensionGBean}} will be described in more detail later.

On the right, we have Pluto. When Pluto starts, a {{PortalContainerServicesGBean}} is started. This is how we access Pluto. When we deploy our archive, an {{AdminConsoleExtensionGBean}} containing portlet configuration information is started (based on the configuration specified in the deployment descriptor). The {{AdminConsoleExtensionGBean}} is where the developer specifies the information for the portlets and pages they are adding to the administration console.

The {{AdminConsoleExtensionGBean}} implements {{GBeanLifecycle}}. When the {{AdminConsoleExtensionGBean}} is started, it asks the kernel for the {{PortalContainerServicesGBean}} (1). The {{AdminConsoleExtensionGBean}} gets the service (2) - now the {{AdminConsoleExtensionGBean}} can access Pluto through its API. We want to add a portlet to our administration console, so we invoke Pluto's addPortlet method, which will update Pluto's internal model.

In the above image, each of the grayed out GBeans is an {{AdminConsoleExtensionGBean}} instantiated by a deployment descriptor. Each {{AdminConsoleExtensionGBean}} modifies or adds exactly one page in the administration console. This essentially means that portlets may be added to an existing page by specifying the name of an existing page, or a separate page can be created if one with the specified name does not exist.

A deployment plan may also include definitions for multiple {{AdminConsoleExtensionGBeans}}. This means that a deployment plan, if it chooses to do so, may add as many pages to the console as it wants to.
{center}
!stopcase.jpg!
Figure 3 - Use case for removing features from the console
{center}

Removing pages (Figure 3) from the console follows a similar process. Because the {{AdminConsoleExtensionGBean}} implements the {{GBeanLifecycle}}, when the installed component is stopped, its {{AdminConsoleExtensionGBean}} will also be stopped. When this happens, we once more ask the kernel for the {{PortalContainerServiceGBean}}, which is used to call {{removePortlet}} on Pluto through its API. From the view of the administration console, the user will see the page has disappeared from the navigation menu (Figure 4). If the user starts the component again, the {{dostart()}} method of {{GBeanLifecycle}} calls{{addPortlet()}} method on Pluto Container, and the administration console extension reappears on the navigation menu (Figure 5).

{center}
!noext.jpg!
Figure 4 - We see no administration extensions to the left for the stopped component


!withext.jpg!
Figure 5 - We see the administration feature for the HelloWorldPortlet appear in the navigation
{center}

h2. Class/Dependency Structure
{panel|title=Dependency relationship of the pieces}
{indent:0}	PortalContainer {indent}
{indent:1}	|-PortalContainerServiceGBean {indent}
{indent:2}	|-AdminConsoleExtensionGBean {indent}
{indent:1}	|-Pluto Portal {indent}
{indent:2}	|-Administration Console {indent}
{indent:3}	|-New Portlet {indent}
{panel}

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.

The key here is that the requirements for adding a console extention is an {{AdminConsoleExtensionGBean}} and the New Portlet files. This means that the required dependencies that need to be specified in the deployment descriptor are the Administration Console and the {{PortalContainerServicesGBean}}. 


h2. How to Develop an Administrator Console Extension (ACE)
In order to develop your own console extension, you will need to perform the following steps:
# Create a portlet
# Add an {{AdminConsoleExtensionGBean}} to the deployment plan
# Build the WAR or CAR
# Deploy the application
# Verify the installation

Each step is further detailed below.

h3. Different ways of structuring
The whole concept behind creating an ACE for Geronimo is that you are adding an extension in the form of portlets to the administrator console.  You can package this however you like.  Some options are as follows:
# Your portlets
# Your portlets + your related component
# Your portlets which declares a dependency on your related component

h3. Create a portlet
In their most fundamental state, an ACE defines where to place new/old portlets in your console.  Portlets are the fundamental building block of the administrator console.  We are using Pluto 2.x as our portal engine since it closely conforms to JSR 286 [[link to JSR 2868]].  We will not go into the details of how to develop portlets since you can find many tutorials and tools that are much better at this. You will need the appropriate {{web.xml}} and {{portlet.xml}} files defined. As a simple example, refer to the {{HelloWorldPortlet}} defined at the end of this section.

h3. Add an {{AdminConsoleExtensionGBean}}
To add an {{AdminConsoleExtensionGBean}} to your deployable archive file, you need to include the following to your {{geronimo-web.xml}} deployment plan:  
# Declare a dependency on the {{pluto-porta}} plugin
{code:XML|borderStyle=solid}
<dependencies>
    ...
<dependency>
    <groupId>org.apache.geronimo.plugins</groupId>
    <artifactId>pluto-support</artifactId>
</dependency>
</dependencies>

{code}
# Define an {{AdminConsoleExtensionGBean}}
{code:XML|borderStyle=solid}
<gbean name="example" class="org.apache.geronimo.pluto.AdminConsoleExtensionGBean">
    <attribute name="pageTitle">Testing</attribute>
    <attribute name="portletContext">/HelloWorldPortlet</attribute>
    <attribute name="portletList">[HelloWorldPortlet]</attribute>
</gbean>
{code}

where the attributes are defined as follows:

app>
{code}

h3. Putting it together
Add your modified "geronimo-web.xml" deployment plan to your WAR or CAR in the WEB-INF folder.  Also, if you are including portlets, your archive file should contain the appropriate class files as well as the "web.xml" and "portlet.xml" files.

{panel

:title

=sample structure for a simple

Deploy the archive as you normally would either using the *deploy* command or by using *Deployer* portlet from the Administration Console.

# _Command Line_:

 
Example:

{noformat

} deploy:deploy c:/HelloWorldPortlet.war

{noformat} 
# _Using the Admin Console_:
{center}
!InstApp.jpg!
{center}


h3. Verifying installation
Go to http://localhost:8080/console/

 to verify that the portlets were added to the correct page.  (You may need to refresh the browser if you deployed the application from the command line.)

h2. Sample Extension

This is a working simple example of an Administration Console Extension.

[Download the example