GlassFish v3 Pluggability One Pager

1. Introduction

1.1. Project/Component Working Name:

Pluggability/Extensibility and Branding.

1.2. Name(s) and e-mail address of Document Author(s)/Supplier:

Sreenivas Munnangi, sreenivas.munnangi@sun.com: authored extensions for monitoring
Ken Paulsen, Ken.Paulsen@Sun.COM: authored extensions for admin console
Hong Zhang, Hong.Zhang@Sun.COM: authored extensions for deployment

1.3. Date of This Document:

06/24/08

2. Project Summary

2.1. Project Description:

Enable the extensibility of application server by providing for plug-in capabilities. The newly added module should be able to expose its configuration, management, and monitoring like any other native module. It should also be possible to access configuration, management and monitoring thru common interfaces like CLI, and GUI.

In this release for Prelude, we are planning to expose Pluggability infrastructure only for CLI, GUI, Deployment and Monitoring.

Enable GF V3 to be OEM'd by external vendors, such as ISVs, OEMs, System Integrators.

Please refer to

• Deployment one-pager for deployment pluggability.
• Admin Command SPI for CLI pluggability.

2.2. Risks and Assumptions:

Note any risks, and assumptions that must be considered along with the proposal. Include technical risks.

Complete this for each of the pluggable extensions.

2.2.1 Admin Console

Specific Integration Points for the GlassFish Admin Console may depend on Woodstock and / or JavaServer Faces. Woodstock does not have dedicate staff, which could make support difficult for developers as well as for obtaining bug fixes. JavaServer Faces, while adequately supported, is not the development platform of choice for all users wishing to integrate with the admin console. Exposure to these dependencies will be minimized as much as possible in this release, however, there is the potential that this cannot be completely eliminated.

Pluggability in the Admin Console requires the admin console application to be able to load classes from plugins, as well as for plugins to be able to access shared utility classes. These classes should be isolated to ensure they do not have side effects on applications besides the Admin Console.

2.2.2 CLI

The admin command SPI referred above assumes that all commands reside on the server and can be discovered at runtime. There are certain local commands, similar to create-domain which do not reside on the server. Further it is possible that there can be multiple services impleneting the same command name. If there are multiple commands with the same name, the first one is picked at random. For the subsequent commands, a warning or similar message needs to be logged and this is expected post prelude.

2.2.3 Monitoring

It is assumed that the pluggable module will implement provider interface for exposing its' monitoring objects. Otherwise it has to be done in a non-provider way by instrumenting just method entry and exit which will be availoable post prelude.

3. Problem Summary

3.1. Problem Area:

Provides for extending the functionality and capabilities of application server by community similar to FireFox addons.

Complete this for each of the pluggable extensions.

3.1.1 Admin Console

The Admin Console will provide the ability to add functionality to the console through plugins. The console application itself will consist of some core infrastructure code and a set of plugins. Additional plugins may be created via the GlassFish project, or by 3rd party projects. Plugins may be distributed and installed/upgraded by the Update Center, or manually installed.

Admin Console Plugins will be OSGi bundles which provide additional pages and/or Java code in order to extend the functionality of the Admin Console application. This means an Admin Console Plugin is delivered as a single OSGi bundle. The following use cases will be supported:

• Addition of TreeNodes in the navigation tree
• Addition of new Pages to the application
• Addition of additional images, JavaScript, or other resources
• Addition of new tabs to tabsets
• Addition of new help content
• Integration with page-specific functionality (e.g. add new deployment types, add log levels)
• Changes which effect the "branding" or "theme" of the application

Each specific supported instances of the above use cases will be documented at V3IntegrationPoint. These use cases are intended to allow arbitrary additions to the Admin Console, as well as the ability to alter the existing look and feel.

Plugins will leverage the Update Center in order to deliver or upgrade plugins. The Update Center will manage plugin dependencies and compatibility with other plugins. Plugin bundles may also be installed manually by placing the bundle in the modules directory of the server. When plugins are upgraded or first installed, the Admin Console application will need to be reloaded.

3.1.2 CLI

It should be possible to discover the commands dynamically as the modular archcitecture supports the addition of modules at runtime.

3.1.3 Monitoring

Dynamically added modules would like to manage and monitor its' data similar to native modules. For example. JRuby would like to monitor runtime pool for optimizing performance. Similarly Portal Container, JBI and other modules would like to monitor their data to observe runtime behavior and tweak it. These modules need a pluggable infrastructure to expose its monitoring.

3.2. Justification:

GlassFish V3 is based on OSGI modular architecture and this is done deliberately to facilitate the addition of incremental modules/features as they are needed.

Complete this for each of the pluggable extensions.

3.2.1 Admin Console

The GlassFish Admin Console provides administration capabilities to all the features of GlassFish. In GlassFish v3, the functionality provided by the server is not static, therefor the GlassFish Admin Console must adapt to the reflect the functionality provided by the server. The plugin features planned for the GlassFish v3 Admin Console will allow admin content to be bundled with features that are added to the server. This will enable anyone adding features to GlassFish to provide administration capabilities for those features -- this is must-have functionality for GlassFish v3. An additional benefit of this modularity is the decoupling of the Administration Console from the release of the GlassFish distributions. This will allow us to do asynchronous updates of portions of the application, or even the application itself.

3.2.2 CLI

Provides for administration of dynamically added modules thru a common framework which is AdminCommand SPI.

3.2.3 Monitoring

Monitoring is a critical part of runtime management to maintain the desired/optimum performance of a given container/application. The pluggable modules like JRuby, JBI and Portal Container would like to expose its' monitoring data natively (similar to Web Container) thru the same GUI/CLI interface for a uniform experience. This enables the system administrator browse a common interface, monitor the data and resolve the issues in advance to maintain desired performance.

4. Technical Description:

4.1. Details:

To the extent known, how is this project going to be done? This information is used by the reviewer to get a feel for the complexity and risk involved, and the architectural constraints that this project is working under. Try to present alternatives and show relationships to existing or proposed projects/standards.

Complete this for each of the pluggable extensions.

4.1.1 Admin Console

• Console Plugin Service
  
  The Console Plugin Service is the HK2 @Service responsible for acting as a facade to the all GlassFish v3 Admin Console Plugins. This enables the Admin Console to query Integration Points (see below) so it may perform the necessary actions for the integration (e.g. add a tree node, new tab, etc.). The Console Plugin Service provides the following API's:
  
  
  • public void addIntegrationPoints(List points, String id)
  • public void addIntegrationPoint(IntegrationPoint point, String id)
  • public List getIntegrationPoints(String type)
  • public ClassLoader getModuleClassLoader(String moduleName)

• Console Provider
  
  Console Provider is an HK2 @Contract and interface which must be implemented by all Admin Console Plugins as an HK2 @Service. This allows the GlassFish v3 runtime to efficiently locate all plugins. It also defines the interface in which plugins define their IntegrationPoints. The Console Plugin Service queries each Console Provider implementation for its Integration Points. The following API is declared by the Console Provider interface:
  
  
  • public URL getConfiguration()

• console-config.xml
  
  This file is provided via a URL from each Console Provider. It acts as the interface for declaring Integration Points (see below). It is read into an Integration Point @Configured Object by the HK2 infrastructure. The following is an example of a simple console-config.xml file which declares a single Integration Point:
  
  

  <?xml version="1.0" encoding="UTF-8"?>
  <console-config id="javaone">
    <integration-point
  	  id="JavaOneNode"
  	  type="tree"
  	  priority="210"
  	  parentId="tree"
  	  content="treenode-ex1.json" />
  </console-config>

  
  The "id" is intended to identify this particular integration point, this may be used in some cases for locating an Integration Point from another Integration Point. Type "type" of Integration Point is used to target what this Integration Point should effect, for example type="tree" will target the navigation tree. "priority" and "parentId" are used to locate where the integration should occur within a page, or to provide other integration-specific details to help consume this Integration Point. The "content" attribute must point to a resource which describes the content to add, or use the content attribute's String value to directly define the new content. The meaning of all these fields may be "type" specific, this will be documented at V3IntegrationPoint.

• Integration Point
  
  Integration Points are specified in the console-config.xml files of each GlassFish Admin Console Plugin bundle. They are consumed by the Admin Console application code, or other plugins. Integration Points for a particular type can be retrieved via the Console Plugin Service. Integration Points are objects which describe what should happen for a particular "type" of integration with the Admin Console. Integration points which are supported are documented on the following Wiki page: V3IntegrationPoint. In addition to the fields provided via the console-config.xml file, the Integration Point instances provide access to the console-config.xml file "id" which declared the Integration Point. This may be used to look for resources relative to the plugin in which it was defined (i.e. via the Console Plugin Service's getModuleClassLoader(String) method). Integration Points provide the following API:
  
  
  • public String getId()
  • public String getType()
  • public String getParentId()
  • public String getContent()
  • public int getPriority()
  • public String getConsoleConfigId()

• Re-branding / Theming
  
  As part of the plugin support in the GlassFish v3 Admin Console, a set of Integration Points will be defined specifically to effect the branding and theme (CSS / Images) of the console. The login screen, images which define the identity of the server will be customizable via Integration Points. CSS and Images which effect the global look and feel of the application will be changeable via Woodstock's Theming feature (see: https://woodstock.dev.java.net/docs/specs/ThemeFS.html) NOTE: In a future release of GlassFish, Woodstock theming support may be replaced by a different interface.

• Class Loading / OSGi
  
  OSGi bundles are used in order to provide the modularity described by this feature in the Admin Console. This allows the Admin Console to leverage the class loading features provided by OSGi to detect and load classes from plugins that are placed in the "modules" directory of GlassFish. OSGi also ensures only 1 version of the classes are loaded, can check dependencies, and keep track of bundle versions. Without this capability, the Web Application class loader could not be made aware of plugin Java code, configuration files (such as the faces-config.xml files), or resources provided by plugins.
  
  Below is a diagram which attempts to illustrate the interaction between the Admin Console application and its dependencies:
  
  
  
  The first key piece of functionality to make this work is an HK2 feature which allows the Admin Console to add the following to its MANIFEST.MF file:
  
  

  Glassfish-require-services: org.glassfish.api.admingui.ConsoleProvider

  
  This line causes the Admin Console application to have visibility into all OSGi bundles which implement the ConsoleProvider @Contract. This solves the issue of locating config files such as the faces-config.xml file, as well as executing plugin Java code directly from the Admin Console.
  
  Another piece of the puzzle is solved by a JSFTemplating feature which enables resolution of pages and resources via a custom class loader. The GlassFish v3 Admin Console takes advantage of this by providing a class loader which is capable of locating specific plugin module class loaders by the prefix of the resource request. This enables resources belonging to a specific plugin to be accurately be loaded. For example, the following URL loads the "test.jsf" page from the "my" plugin (NOTE: "my" is the plugin's console-config.xml "id" attribute value):
  
  

  http://localhost:4848/my/test.jsf

  
  This area of the plugin design has been the most difficult part to figure out as there are no standards in this area of Java EE (in fact the idea of going outside the web application for class loading seems to go against Java EE web application design). As such, we should NOT share any OSGi bundles which maintain state for the application, or bundles in which the console requires a specific version.

• Update Center Integration
  
  The Update Center will be critical both in delivery of the GlassFish Admin Console application itself, but also its dependencies. The Update Center may be used to initially download the GlassFish Admin Console. Its API's will then be used by the Admin Console so that updates and new bundles can be detected and presented to the user. If the user chooses to install updates or new plugin bundles, they will be downloaded and installed for the user. The Update Center will provide the ability to track versions of plugin bundles, and declare dependencies between plugin bundles.
  

4.1.2 CLI

Please refer to AdminCommandSPI for details.

4.1.3 Monitoring

V3 Monitoring solution is being architected in a pluggable manner so that even the native modules like Web Container use same pluggable infrastructure which we expose to pluggable modules like JRuby, Portal Container, JBI, etc. We expect these modules to use the same pluggable monitoring infrastructure which is used for native modules.

To start with, the pluggable module has monitoring data which is being gathered during run time. It is possible for the module to use probes infrastructure if needed. The probes infrastructure enables the module to define its basic probes using provider interface. If the monitoring requirement is simple, probes infrastructure can define the default probes (post prelude) for the module. Once the probes are available, it is possible to register a listener and start monitoring the probes and populate the monitoring data objects. These monitoring data objects form the basis for reporting monitoring, which is discussed below.

Please refer to Monitoring Onepager for details.

The module will expose the monitoring data through hk2 service by implementing monitoring contract, for example.

import org.jvnet.hk2.annotations.Contract;
import javax.management.j2ee.statistics;
@Contract
public interface Monitor {
    public Statistic getMonitorData(String monitorAttr);
    public String toString();
}

import org.jvnet.hk2.annotations.Service;
import javax.management.j2ee.statistics;
@Service (name="JRuby")
@Scoped(Singleton.class)
public class JRubyMonitor implements Monitor {
    public Statistic getMonitorData(String monitorAttr) {
       // process and return the requested data
    }
    public String toString() {
        // return formatted monitoring data
        final ActionReport report = context.getActionReport();
        // append titles        
        report.setMessage("Response Time     Runtime Pool Count");
        // append data for each row
        for (each row of data) {
            report.getTopMessagePart().setChildrenType("");
            ActionReport.MessagePart part = 
                     report.getTopMessagePart().addChild();
            part.setMessage(respTime + "          " + poolCount);
        }
        report.setActionExitCode(ActionReport.ExitCode.SUCCESS);
    }
}

When V3 runtime comes up, the above service 'JRubyMonitor' is available in the habitat and one could query directly for the service by name 'JRubyMonitor' or by contarct type 'Monitor'. It is possible that multiple services implement the same contract.

Let us see how this works with GlassFish V2 asadmin monitor command.

> asadmin monitor --type jruby server

    JRuby Monitoring Data

Response      Runtime
Time (ms)      Pool
    2            5

The above command is passed to the admin adapter on the server side, which determines that it is a monitoring command based on sub command 'monitor'. Based on this information it looks for corresponding service "JRuby" in the habitat which implements "Monitor" contract.

There are 2 versions possible for implementing the Service. The first one is based on method processing and the second one is based on annotations. For example, to return the monitor attribute JRubyContainerStats.CurrentRequestData.ProcessingTime. two implementation will be as follows.

First version using method processing:

import org.jvnet.hk2.annotations.Service;
@Service (name="JRuby")
@Scoped(Singleton.class)
public class JRubyMonitor implements Monitor {

    public Object getMonitorData(String monitorAttr) {
       if (monitorAttr.startsWith("JRubyContainerStats")) {

          // get hold of JRubyContainerStats
          // pass the command to JRubyContainerStats object
          // return the value

          // JRubyContainerStats object may do some thing similar to this for
          // getting hold of the final monitor attribute requested and return it

       } else if (monitorAttr.equals("JRubyContainerStats.CurrentRequestData")) {
       } else if (monitorAttr.equals("JRubyContainerStats.CurrentRequestData.ProcessingTime")) {
       } else {
       }
    }

    public String toString() {
        return ("Formatted JRuby monitoring data ...");
    }
}

Second version using annotations:

import org.jvnet.hk2.annotations.Service;
@Service (name="JRuby")
@Scoped(Singleton.class)
public class JRubyMonitor implements Monitor {

    @MonitorData (name="JRubyContainerStats")  
    JRubyContainerStats jrcs;
   
    public Object getMonitorData(String monitorAttr) {
       // parse monitorAttr into components, for ex.
       // JRubyContainerStats, CurrentRequestData and ProcessingTime
       //
       // get the annotation for the first component which is JRubyContainerStats
       // and the corresponding object instance is jrcs
       //
       // get the object corresponding to next component which is "CurrentRequestData"
       // jrcs.getMonitorData("CurrentRequestData") which is crd
       //
       // repeat the above for last component "ProcessingTime"
       // which returns pt
       //
       // return pt;
    }
    ...
}

public class JRubyContainerStats {  
    @MonitorData (name="CurrentRequestData")
    CurrentRequestData crd;

    public  Object getMonitorData(String monitorAttr) {
       return crd;
    }
    ...
}

public class JRubyContainerStats {  
    @MonitorData (name="ProcessingTime")
    ProcessingTime pt;

    public  CurrentRequestData getMonitorData(String monitorAttr) {
       return pt;
    }
    ...
}

To maintain V2 compatibility, the monitoring data will be exposed thru JMX/AMX.

Exposing monitor data through the GlassFish Admin Console:

Please refer to the GlassFish v3 Admin Console specification for details on exposing monitor data through the Admin Console.

4.1.4 OEM - Admin Console / Skins Customization

Please see Re-branding / Theming section of 4.1.1 for details.

4.1.5 OEM - Non GUI Customization

Apart from GUI and skins, OEM customization is needed wherever the OEM specific information is displayed. For example, the application server version, OEM specific information in the server.log, etc.

Version command should return OEM specific values though OEM is expected to step lock with the application server versions.

At present the java class ./common/common-util/src/main/java/com/sun/appserv/server/util/Version.java returns version info. The class expects version properties files under com/sun/enterprise/ee/server/Version.properties or com/sun/enterprise/server/Version.properties.

We plan to extend this by coming up with a branding module which will be dropped under glassfish/lib/modules. The branding module consists of an implementation of Branding contract which is deployed into the habitat at server startup. When the Version class is consulted for version info, it first looks for Branding implementation in the habitat. if the implementation is not find it uses default info from the Version class. Branding module is expected to be a single module for gathering all brand/skin related artifacts into one place.

import org.jvnet.hk2.annotations.Contract;
@Contract
public interface Branding {
    public String getVersion();
    public String getFullVersion();
    public String getAbbreviatedVersion();
    ...
}


import org.jvnet.hk2.annotations.Service; 
@Service
@Scoped(Singleton.class) 
public class GlassFishBranding implements Branding { 
    public String getVersion();
    public String getFullVersion();
    public String getAbbreviatedVersion();
    ...
} 

OEM implements the Service of contract type Branding which will be available thru the habitat when the branding jar is made available under glassfish/lib/modules. When some one queries for version info, first the habitat will be looked up to see if any OEM info is available otherwise, it falls back to default behavior.

Corresponding to V3 version info, following properties are available.

PRODUCT_NAME = "product.name";
ABBREV_PRODUCT_NAME = "abbrev.product.name";
FULL_VERSION = "full.version";
MAJOR_VERSION = "major.version";
MINOR_VERSION = "minor.version";
BUILD_ID = "build.id";\

In addition, so as to enable the display of OEM specific info, we may want to capture the following.

LEGAL_COPYRIGHT                "Copyright 2008-2009"
LEGAL_COMPANY_NAME             "Sun Microsystems, Inc."
LEGAL_RIGHTS                   "All rights reserved."
SIMPLE_COMPANY_NAME            "Sun"
COMPANY_CONTACT_URL            "http://www.sun.com"
PRODUCT_TRADEMARKS             "GlassFish V3 is a trademark of Sun."

The server.log displays OEM specific information for each entry, for example GlassFish10.0. If an OEM is present then it should display the name corresponding to OEM otherwise use the default.

4.2. Bug/RFE Number(s):

List any Bug(s)/RFE(s) which will be addressed by this proposed change.

Provide links to the Issue tracker Bug(s)/RFE(s)where possible

4.3. In Scope:

Aspects that are in scope of this proposal if not obvious from above.

Complete this for each of the pluggable extensions.

4.3.1 Admin Console

The following use-cases are covered by the scope of the v3 Admin Console Pluggability Support:

• Addition of TreeNodes in the navigation tree
• Addition of new pages to the application (JSF or non-JSF pages)
• Addition of additional images, JavaScript, or other resources
• Addition of new help content
• Integration with page-specific functionality (e.g. add new deployment types, add log levels)
• Changes which effect the "branding" or "theme" of the application

4.3.2 CLI

Support for help, man pages and validation.

4.3.3 Monitoring

As specified in 4.1.3.

4.4. Out of Scope:

Pluggability for Configuration, AMX, Runtime and JRuby Container Monitoring.

4.4.1 Admin Console

The GlassFish v3 Admin Console will not support extensions to parts of the application which are not documented at: V3IntegrationPoint

4.4.2 Monitoring

Following items are out of scope for prelude: runtime mbeans, pluggability for amx, pluggability for config, pluggability for online-help, and jruby container monitoring.

4.5. Interfaces:

Interfaces are a major part of Architectural review. Commands, Files, Directory Layout, Ports, DTD/Schema, admin tools, config files, APIs, CLIs, and almost anything that is externally observable is an interface. In 1-Pager it is necessary to document any interface that can be used by external projects and products. Documented public interfaces must be assigned a stability level. Some commonly used Stability levels in prior projects are:

Stable    : Widely used public interface. changed very rarely.
Standard  : Defined by a standards body (e.g: JDBCv3). Rare but 
                 incompatible clarifications and changes could occur 
                 in a standard. Product will specify version of std 
                 supported. J2SE, J2EE and WS* are classified 
                 as Standard.
Evolving  : Subject to carefully controlled but possibly 
                 incompatible change at a major or minor release. 
                 When a change is made all efforts will be made 
                 to address incompatiblity and migration. All 
                 incompatibilities will need to be reviewed 
                 and approved by as-ccc@sun.com. 
Unstable  : Early access, subject to unrestricted degree of 
                 change. A few App Server interfaces are classified 
                 as Unstable. Docs must call out exported unstable 
                 interfaces. Be wary of importing Unstable interfaces.
External  : Defined external to GlassFish Application Server, 
                 but not by a Standards body. Suitable for describing
                 other freeware, open source interfaces.
http://www.opensolaris.org/os/community/arc/policies/interface-taxonomy/ describes the permitted interface taxonomy.

4.5.1 Exported Interfaces

Complete this for each of the pluggable extensions.

4.5.1.1 Admin Console

• @Service public class ConsolePluginService
  • public void addIntegrationPoints(List points, String id)
  • public void addIntegrationPoint(IntegrationPoint point, String id)
  • public List getIntegrationPoints(String type)
  • public ClassLoader getModuleClassLoader(String moduleName)

• @Contract public interface ConsoleProvider
  • public URL getConfiguration()

• @Configured public class IntegrationPoint implements Serializable
  • public String getId()
  • public String getType()
  • public String getParentId()
  • public String getContent()
  • public int getPriority()
  • public String getConsoleConfigId()

• console-config.xml
  

  <!ELEMENT console-config (integration-point*)>
  <!ATTLIST
          <!-- This is the "id" which identifies the plugin -->
          id          CDATA       #REQUIRED
  >
  <!ELEMENT integration-point EMPTY>
  <!ATTLIST
          id          CDATA       #REQUIRED
          type        CDATA       #REQUIRED
          priority    CDATA       #IMPLIED
          parentId    CDATA       #IMPLIED
          content     CDATA       #IMPLIED
  >

• Integration Point id's documented at: V3IntegrationPoint

4.5.1.2 CLI

Please refer to AdminCommandSPI for details.

4.5.1.3 Monitoring

• Interface:

@Service
public class JRubyMonitor implements Monitor {
    public Statistic getMonitorData(String monitorAttr);
    public String toString();
}
Monitoring attributes in dotted notation, for details, please refer to Monitoring one-pager.

• Stability: unstable
• Comments: Early access, subject to unrestricted degree of change

• Interface: JMX/AMX Monitoing MBeans
• Stability: compatible with V2

4.5.2 Imported interfaces

Complete this for each of the pluggable extensions.

4.5.2.1 Admin Console

Please refer to GlassFish v3 Admin Console specification for details.

4.5.2.2 CLI

Please refer to AdminCommandSPI for details.

4.5.2.3 Monitoring

• Interface:

@Contract 
public interface Monitor {
    public Statistic getMonitorData(String monitorAttr);
    public String toString();
}
@Service
public class JRubyMonitor implements Monitor {
    public Statistic getMonitorData(String monitorAttr);
    public String toString();
}

• Stability: unstable
• Exporting Project: Name, Specification or other Link: HK2

4.5.3 Other interfaces (Optional)

Complete this for each of the pluggable extensions.

4.6. Doc Impact:

List any Documentation (man pages, manuals, service guides...) that will be impacted by this proposal.

Complete this for each of the pluggable extensions.

4.6.1 Admin Console

Documentation will need to be modularized to be capable of delivering different groups of "help" information based on the content of a particular release. The console shall provide a way for 3rd party plugins to provide their own help content as well (NOTE: this may not be integrated with the documentation shipped with the product.)

4.6.2 CLI

Every new command should provide corresponding help and man-page in given format.

4.6.3 Monitoring

Please refer to 4.1.3 for input on documentation.

4.7. Admin/Config Impact:

How will this change impact the administration of the product?

Identify changes to GUIs, CLI, agents, plugins...

Complete this for each of the pluggable extensions.

4.7.1 Admin Console

The ability to add plugins to the server will enhance users' ability to support GlassFish features or upgrade (or develop) enhanced versions of plugins which offer better administration support.

4.7.2 CLI

By nature CLI is itself an admin command infrastructure. Related CLI commands will update the configuraton such as set/get, dotted names and certain CLI commands.

4.7.3 Monitoring

The pluggability is expected to be acheived with existing infrastructure.

4.8. HA Impact:

What new requirements does this proposal place on the High Availability or Clustering aspects of the component?

Need to be reviewed later.

4.9. I18N/L10N Impact:

Does this proposal impact internationalization or localization?

Complete this for each of the pluggable extensions.

4.9.1 Admin Console

I18N deliverables will need to be broken into individual files which correspond with the modules in which they belong.

4.9.2 CLI

Please refer to AdminCommandSPI for details.

4.9.3 Monitoring

Details to be identified during design phase.

4.10. Packaging & Delivery:

What packages, clusters or metaclusters does this proposal impact? What is its impact on install/upgrade?

For prelude, the pluggable module is either an HK2 module or OSGi module. Module with all pluggability (GUI, CLI, etc.) can be released as one bundle, or the pluggability can be released as a separate bundle from core.

4.10.1 Admin Console

The Update Center will be the delivery vehicle in which the GlassFish Admin Console may be installed.

The Update Center will provide support for the GlassFish Admin Console to access information about the available packages which may be upgraded or installed. It will provide details about versions and descriptions of packages. The Update Center will also be responsible for providing a mechanism for tracking and resolving dependencies (including versions) between bundles.

4.10.2 CLI

Delivered as part of module either as an OSGI module or thru update center. Upgrade needs to be understood better.

4.10.3 Monitoring

Delivered as part of module.

4.11. Security Impact:

How does this proposal interact with security-related APIs or interfaces? Does it rely on any Java policy or platform user/permissions implication? If the feature exposes any new ports, Or any similar communication points which may have security implications, note these here.

Complete this for each of the pluggable extensions.

4.11.1 Admin Console

3rd-party plugins may introduce features which may compromise security, or even be intentionally malicious. Administrators will need to take care in ensuring they trust each installed plugin.

OSGi bundles are shared. Care must be taken to isolate any OSGi bundles containing state information on which the Admin Console depends to ensure the Admin Console is the only application consuming these bundles.

4.11.2 CLI

Uses and confirms to the common security infrastructure provided by CLI and Java EE Containers/OSGI modules.

4.11.3 Monitoring

Utilizes the security provided by monitoring infrastructure.

4.12. Compatibility Impact

Incompatible changes to interfaces that others expect to be stable may cause other parts of application server or other dependent products to break.

Discuss changes to the imported or exported interfaces. Describe how an older version of the interface would be handled.

List any requirements on upgrade tool and migration tool.

Complete this for each of the pluggable extensions.

4.12.1 Admin Console

In order for plugins to be successful, particularly 3rd-party plugins, it will be important for version numbers to reflect any incompatible changes in the api. For example, if glassfish-api-10.0.0-rev6 provides a certain set of API's, if those api's continue to be backward compatible up to, but not including, glassfish-api-11.0, then a version range in which a plugin is compatible may be specified. However, if incompatible changes are randomly made to version numbers, it will be impossible for ranged version numbers to be used reliably. This will tie a build of GlassFish to a build of a particular plugin making it unportable to other versions of GlassFish, even if those versions are compatible.

The Integration Points supported in GlassFish v3 Prelude may be altered to mitigate exposure to Woodstock and JavaServer Faces. This will break compatibility is some Integration Points.

4.12.2 CLI

This is the first implementation.

4.12.3 Monitoring

This is the first version of pluggability.

4.13. Dependencies:

List all dependencies that this proposal has on other proposals, components or products. Include interface specifics above in the interfaces section; LIST dependency component version requirements here.

Complete this for each of the pluggable extensions.

4.13.1 Admin Console

• OSGi - class loading
• HK2 - XML Parsing, Annotations
• UpdateCenter 2.0 - Delivery of Admin Console and Plugins; Querying of Plugins
• JavaServer Faces / JSFTemplating - Serving Resources; Configuration of Managed Beans; Pages; etc. (NOTE: exposure to plugin authors will be limited, use of these will be optional in most cases)
• Woodstock - Components and Theme Support (NOTE: exposure to plugin authors will be limited, use of these will be optional in most cases)
• jMaki - Charting, RSS Feeds (NOTE: exposure to plugin authors will be limited, use of these will be optional in most cases)
• Help - HTML content provided by GlassFish documentation authors

4.13.2 CLI

Depends on Admin Command SPI.

4.13.3 Monitoring

Depends on HK2 and GlassFish V3 infrastructure including monitoring infrastructure.

5. Reference Documents:

List of related documents, if any (BugID's, RFP's, papers).

Explain how/where to obtain the documents, and what each contains, not just their titles.

• Admin Command SPI.
• Admin Console Integration Point Documentation: V3IntegrationPoint
• Woodstock Theming Specification: https://woodstock.dev.java.net/docs/specs/ThemeFS.html
• Admin Console Onepager: http://wiki.glassfish.java.net/Wiki.jsp?page=GFV3AdminGUIOnePager
• Monitoring Onepager

6. Schedule:

6.1. Projected Availability:

Dates in appropriate precision (quarters, years)

Basic pluggability infrastructure as specificed above (excpting the items specified under out-of-scope) are expected to be provided for prelude release.

This page (revision-77) was last changed on 31-Mar-09 07:15 AM, -0700 by KenPaulsen.
This page was created on 10-Jun-08 17:27 PM, -0700 by glassfishwiki.org.

More info...