GlassFish - World's first Java EE 7 Application Server


RESTful API Documentation Plan for GlassFish Server Open Source Edition 3.1

People and Roles

Name Role Location Time Zone Email
Paul Davies Documentation Feature Owner Santa Clara, CA, USA US/Pacific pauldavies@glassfish.java.net
Ludovic Champenois Software Engineer Santa Clara, CA, USA US/Pacific ludo@glassfish.java.net
Jason Lee Software Engineer OK, USA US/Central jdlee@glassfish.java.net

Audience

The RESTful API feature is aimed at system administrators. A secondary audience is application developers who are developing client applications of the RESTful API.

Summary of the Feature From a User's Perspective

This feature enables system administrators to access monitoring, logging, and configuration data for GlassFish Server through REST resources.

Availability

The RESTful API feature is supplied in the Web Profile distribution and 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

Changes are relative to the documentation for Release 3.0.1. Links to the affected documentation are provided where appropriate.

Administration Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Using REST Interfaces to Administer GlassFish Server Moderate Paul Davies Ludivic Champenois
Jason Lee 		Update Using REST URLs to Administer GlassFish Server to reflect support for clustering by stating that the path part of a URL includes instance names.

Update Figure 2-1 to show the current format of the page.

Change the title of Child Resources for Non-CRUD Operations to Resources for asadmin Subcommands. Delete Table 2-2 from this section and rewrite the remainder of this section to explain how to access asadmin subcommands as children of REST resources for the objects on which the subcommands act.

Explain how to specify the format of the output in the extension of a URL.

Explain how to access log files through a REST URL.

Explain how to secure REST resources by using session tokens.

Describe the output formats for monitoring statistics.

Describe the output formats for log file entries.

Describe the consume types: JSON, XML, and formencoded.

Add-On Component Development Guide Changes

Section Documentation Impact Writer Reviewers Description of Change
Chapter 5. Adding Monitoring Capabilities Minor Paul Davies Ludovic Champenois
Jason Lee 		Explain how to create a REST resource to represent an add-on component's monitoring and configuration data.

Provide the URLs to REST resources for a component's monitoring data.
Chapter 6. Adding Configuration Data for a Component Minor Paul Davies Ludovic Champenois
Jason Lee 		Cross-refer to the procedure for creating a REST resource to represent an add-on component's monitoring and configuration data.

Provide the URLs to REST resources for a component's configuration data.

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
Administration Guide changes
    
Add-On Component Development Guide changes    

Reviewers are listed in the Statement of Work.

Related Information

Email aliases: