<h1>GlassFish v3 Add-On Component Development Guide Document Plan</h1>

People and Roles

Audience

This document is for software developers who are developing add-on components for GlassFish v3. This document assumes that the developers are working with a GlassFish distribution, not the GlassFish source code. Familiarity with the Java language is also assumed.

Purpose and Description

The purpose of this document is to explain how to use GlassFish v3 interfaces for pluggability to develop add-on components for GlassFish. This document explains how to perform only those tasks that ensure that the add-on component is suitable for GlassFish.

Statement of Work

This section describes in detail for each milestone the work that is needed on the document, such as changes, addition of new material, relocation of existing material, and removal of existing material. Work might result from new features, changes to existing features, bug fixes, RFEs, and editorial enhancements.

Documentation Impact:

• None
• Minor
• Moderate
• Major
• New

v3 Prelude Statement of Work

For v3 Prelude, the scope of work is to write all of the sections that are identified in the overall content outline.

FCS Statement of Work

Overall Content Outline

Chapter 1 Introduction to the Developement Environment for Enterprise Server Add-On Components

Source material for this chapter is available in GlassFish v3 Pluggability One-Pager, Glassfish v3 Engineer's Guide, OSGi One-Pager, hk2 Modules Subsystem, hk2 Component Model

This chapter contains the following topics:

• Enterprise Server Modular Architecture
• OSGi
• hk2 Modules Subsystem
• hk2 Component Model
• Overview of the Development Process for Add-On Components

Chapter 2 Writing HK2 Services

Chapter 3 Extending the Administration Console

Source material for this chapter is available in Sample Project that shows all the Integration Points , How to checkout/build/debug GlassFish v3 Prelude Admin Console , What URL to use for GlassFish v3 Prelude Admin Console , and [GUI pluggability (.odp) |GlassFishV3AdminConsole^v3-gui-pluggability2.odp].

This chapter contains the following topics:

• Administration Console Architecture
  Mention that the Administration Console is a web application that is composed of OSGi bundles
• About Administration Console Templates
• About Integration Points
• Specifying the ID of an Add-On Component
• Adding Functionality to Existing Pages
  • Adding a Tab to a Page
  • Adding a Page to the Administration Console
  • Add a Node to the Navigation Tree
  • Add a Task to the Common Tasks page
  • Adding Elements to a Page
• Adding Internationalization Support
• Replace the Content of an Existing Application With new Content
• Removing or Changing Existing Content
• Changing the Theme or Brand of the Administration Console
• Adding an Integration Point

Note - Adding online help is omitted, as this release provides no mechanism for integrating online help for an add-on component with the online help that is supplied with the Administration Console.

Chapter 4 Extending the asadmin Utility

Source material for this chapter is available in Administrative command infrastructure in V3.

This chapter contains the following topics:

• About the Client-Server Protocol for the asadmin Utility
• Identifying a Class as an Implementation of an asadmin Command
• Setting the Context of an asadmin Command
• Identifying the Parameters of an asadmin Command
• Adding Internationalization Support to an asadmin Command
• Changing the theme or brand of the of asadmin CLI

Chapter 5 Adding Monitoring Capabilities

Source material for this chapter is available in GlassFish v3 Pluggability One-Pager and GlassFish v3 Monitoring One-Pager.

Chapter 6 Adding Container Capabilities

Source material for this chapter is available in Container SPI.

This chapter contains the following topics:

• Implementing a Container
• Implementing Connector Interfaces
• Adding an Archive Type
• Adding an annotation processor
• Adding a Class Loader Implementation
• (Optional)Implementing Pluggable Configuration
• (Optional)Adding AMX Configuration
• (Optional)Defining New Commands for Configuration

Chapter 7 Packaging and Delivering an Add-On Component

Appendix A Integration Point Reference

Source material for this appendix is available in Integration points.

This appendix provides a description of each integration point.

Appendix B Template Reference

Source material for this appendix is available in Admin GUI templates for use by plugins.

This appendix provides a description of each template.

Note - This Appendix will be provided only if these templates are available to users of a GlassFish distribution. If the templates are available only in the source code, this Appndix will be omitted.

Index

Reviewers

The review schedule for this document is provided in the following table.

The reviewers of this document are listed in he following table.

Delivery Methods

This document will be published on the docs.sun.com^SM^ site and delivered in the GlassFish v3 documentation IPS package.

Related Information

• User task analysis
• GlassFish v3 Pluggability One-Pager
• Integration points
• Sample Project that shows all the Integration Points
• Admin GUI templates for use by plugins
• How to checkout/build/debug GlassFish v3 Prelude Admin Console
• What URL to use for GlassFish v3 Prelude Admin Console
• [GUI pluggability (.odp)|GlassFishV3AdminConsole^v3-gui-pluggability2.odp]
• Administrative command infrastructure in V3
• Container SPI
• GlassFish v3 Monitoring One-Pager
• Glassfish v3 Engineer's Guide
• OSGi One-Pager
• hk2 Modules Subsystem
• hk2 Component Model

Email aliases:

• [admin@glassfish.java.net]
• [users@glassfish.java.net]
• [dev@glassfish.java.net]
• [docs@glassfish.java.net]