GlassFish - World's first Java EE 7 Application Server


Embedded GlassFish Server Documentation Plan for GlassFish Server Open Source Edition 3.1

People and Roles

Name Role Location Time Zone Email
Rebecca Parks Documentation Feature Owner Santa Clara, CA, USA US/Pacific junesm@dev.java.net
  Additional Writer     java.netID@dev.java.net
  Peer Reviewer     java.netID@dev.java.net
Siraj Ghaffar Software Engineer Alpharetta, GA, USA US/Eastern java.netID@dev.java.net
Marina Vatkina Software Engineer Santa Clara, CA, USA US/Pacific java.netID@dev.java.net
Mitesh Meswani Software Engineer Santa Clara, CA, USA US/Pacific java.netID@dev.java.net

Audience

Embedded Server is intended for developers who wish to deploy and test applications without the overhead of server administration.

Summary of the Feature From a User's Perspective

The objective of the embedded GlassFish project is that GlassFish Server should run inside a user's application and its JVM, instead of the other way around. No GlassFish installation or configuration should be required. A related objective is that the embedded functionality should work with the regular installation of GlassFish Server as well, with the same set of JVMs.

Objectives of GlassFish Server Open Source Edition 3.1 release are:

  • Formalize the embedded API.
  • Improve application support parity with regular GlassFish Server, giving priority to web tests.
  • Look into specific customer use cases and make sure those requirements are met.

Availability

Embedded GlassFish Server is available in all GlassFish Server distributions. However, Embedded GlassFish Server does not support clustering features.

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

Embedded Server Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
entire book Moderate Rebecca Parks Siraj Ghaffar Check for minor API changes and effects on examples. ScatteredArchive may be supported. CommandRunner may be supported. These existed but were not officially supported in 3.0. Some documentation text on these was commented out for 3.0.
Setting the Class Path Minor Rebecca Parks Siraj Ghaffar Document glassfish-embedded-nucleus.jar file.
Maven Goals for Embedded GlassFish Server Minor Rebecca Parks Siraj Ghaffar Document embedded-glassfish:admin goal and its parameters.
Ant Tasks for Embedded GlassFish Server NEW Rebecca Parks Siraj Ghaffar Document new Ant tasks: StartTask, StopTask, DeployTask, UndeployTask, AdminTask.
Web Services Example for Embedded GlassFish Server NEW Rebecca Parks Siraj Ghaffar Web services are now supported, so Siraj would like to see a web services example in the book. He may have to supply it.
The Default Data Source NEW Rebecca Parks Mitesh Meswani Describe how a default data source is provided if an application that uses Java Persistence doesn't specify one. See the Java Persistence Documentation Plan .
Using the EJB 3.1 Embeddable API with Embedded GlassFish Server Minor Rebecca Parks Marina Vatkina List the newly supported EJB 3.1 features: message-driven beans, web service endpoints, remote EJB components with non-default IIOP ports, and the timer service. See the Enterprise JavaBeans Documentation Plan .
EJBContainer#createEJBContainer(Properties) method properties for Embedded GlassFish Server NEW Rebecca Parks Marina Vatkina Document new properties as mentioned in Issue 12292 .

Changes to Online Help

None

Changes to Man Pages

None

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
Embedded Server Guide    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: