OSGi Documentation Plan for GlassFish Server Open Source Edition 3.1

People and Roles

Name Role Location Time Zone Email
Jeff Schieli Documentation Feature Owner Burlington, MA, USA US/Eastern java.netID@dev.java.net
  Additional Writer     java.netID@dev.java.net
  Peer Reviewer     java.netID@dev.java.net
Sanjeeb Sahoo Software Engineer Bangalore, India IST java.netID@dev.java.net
Richard S. Hall Software Engineer Santa Clara, CA, USA US/Pacific java.netID@dev.java.net

Audience

OSGi modules are primarily created and used by developers.

Summary of the Feature From a User's Perspective

OSGi features for GlassFish Server Open Source Edition 3.1:

  • Upgrade to Felix 3.0 - minimal user-visible effects
  • Support for hybrid OSGi/Java-EE applications - mainly affects Java EE developers
  • GlassFish Server embedded in OSGi runtime - mainly affects OSGi developers
  • Generic OSGi features - mainly affects OSGi developers

Availability

OSGi modules can be added to the Web Profile and Full Platform distributions of GlassFish Server. Hybrid OSGi/Java-EE applications deployed to the Web Profile distribution cannot include features supported only in the Full Platform distribution.

Statement of Work

This section describes in detail for each document the work that is required by the introduction of the feature, such as changes, addition of new material, relocation of existing material, and removal of existing material.

Documentation Impact:

  • None
  • Minor
  • Moderate
  • Major
  • New

Note - If a document is task based (as opposed to reference), the changes should be determined from the user task analysis for the feature.


Changes to Books

Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
OSGi Module Management Subsystem Moderate Jeff Schieli Sanjeeb Sahoo
Richard Hall
Describe the generic OSGi features: using an OBR repository, the Apache Gogo shell, and the OSGi Web Console. This section may also need minor editing as a result of the upgrade to Felix 3.0.

Domain File Format Reference Changes

Section Documentation Impact Writer Reviewers Description of Change
engine element description Minor Jeff Schieli Sanjeeb Sahoo
Richard Hall
The sniffer attribute description already lists osgi as a possible value, but more info about the server's behavior as a result of this value might be desirable.

Application Development Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Developing Hybrid OSGi and Java EE Applications NEW Jeff Schieli Sanjeeb Sahoo
Richard Hall
Describe how to integrate OSGi and Java EE features when developing applications and modules.

Application Deployment Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Chapter 2 Deploying Applications Minor Jeff Schieli Sanjeeb Sahoo
Richard Hall
Describe deployment briefly in a "Hybrid OSGi and Java EE Application Deployment Guidelines" section and cross-reference the Application Development Guide for development info. A very brief section already exists, but more info is needed.

Add-on Component Development Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Chapter 1 Introduction to the Development Environment for GlassFish Server Add-On Components Minor Jeff Schieli Sanjeeb Sahoo
Richard Hall
Cross-reference the Application Development Guide for hybrid OSGi and Java EE application info.
Embedding GlassFish Server in the OSGi Runtime NEW Jeff Schieli Sanjeeb Sahoo
Richard Hall
Describe how to run GlassFish Server within the OSGi framework.

Changes to Online Help

Administration Console Common Module Online Help Changes

Help Page Name and Section Documentation Impact Writer Reviewers Description of Change
Additional Options for Applications of Type Other (reference) Minor   Sanjeeb Sahoo
Richard Hall
The OSGI Type option is already described briefly, but more info about the effect of this setting might be desirable.
To Deploy a Hybrid OSGi and Java EE Application (task) NEW   Sanjeeb Sahoo
Richard Hall
Describe the steps for deploying a hybrid OSGi/Java-EE application or module in the Administration Console.

See the Administration Console Documentation Plan.

Changes to Man Pages

Man Page Name and Section Documentation Impact Writer Reviewers Description of Change
deploy, deploydir, redeploy Minor   Sanjeeb Sahoo
Richard Hall
The osgi value of the --type option is already described briefly, but more info about the effect of this setting might be desirable.

Review Schedule

The review schedule for the documentation items that are affected by this feature is provided in the following table.

Item Review Start Date Review End Date
Domain File Format Reference    
Application Development Guide    
Application Deployment Guide    
Add-on Component Development Guide    
Deployment Online Help    
Deployment-related asadmin subcommands    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: