GlassFish 4.0 Deployment One Pager

Skip to end of metadata
Go to start of metadata

GlassFish 4.0 (Java EE 7 release) - Deployment One Pager

1. Introduction

1.1. Project/Component Working Name:

GlassFish 4.0 (Java EE 7 release) Deployment

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

Hong Zhang : hzhang_jn@java.net
Gerald Ingalls: GeraldIngalls@java.net

1.3. Date of This Document:

1/30/2012

2. Project Summary

2.1. Project Description:

Some of the features described in this one pager are already covered in other one pagers. The main purpose of the document is to group all relevant contents for GlassFish 4.0 (Java EE 7 release) in one document and share with open source community.

  • Java EE 7 Requirements
  • Deployment Order

2.2. Risks and Assumptions:

Late requirements from Java EE 7 spec could result in delay for the delivery of the functionality.

3. Problem Summary

3.1. Problem Area:

Java EE 7 Requirements

Address Java EE 7 spec requirements, most of the deployment requirements come from the Java EE 7 platform spec.

Deployment Order

Specify a deployment order at application deployment time, and the applications will be loaded based on that order during server start up.

3.2. Justification:

Make GlassFish 4.0 Java EE 7 compliant and provide ease of use developer features.

4. Technical Description:

4.1. Details:

Java EE 7 Requirements

In most cases, the Java EE 7 specifications define the exact requirements and expected behavior and we will not duplicate here. One requirement that will be covered in this section is the external alternate deployment descriptor requirement.

The Java EE 7 platform specification specifies that user could specify an alternate deployment descriptor external to the application package:

"EE.8.5 Deployment
Any Java EE product must be able to accept a Java EE application delivered as a .ear file or a stand-alone Java EE module delivered as a .jar, .war, or .rar file (as appropriate to its type), together with an optional alternate deployment descriptor external to the application or standalone Java EE module."

But the spec does not specify how the external deployment descriptor could be specified as it's specific to each server product. In GlassFish, an optional altdd option is added to the CLI deploy command to specify alternate deployment descriptor externally:

asadmin deploy --altdd <path to alternate deployment descriptor> foo.ear

The specified alternate deployment descriptor will override the one packaged inside the application archive if exists.

In addition to support what is specified in the Java EE 7 platform spec, a product extension is also implemented to support the external alternate vendor specific deployment descriptor. An optional runtimealtdd option is added to the CLI deploy command to specify alternate vendor specific deployment descriptor externally:

asadmin deploy --runtimealtdd <path to alternate vendor specific deployment descriptor> foo.ear

The specified alternate vendor specific deployment descriptor will override the one packaged inside the application archive if exists.

This support is for GlassFish deployment descriptors (glassfish-.xml) only and not for the deprecated Sun deployment descriptors (sun-.xml), and the file name of the alternate GlassFish deployment descriptors needs to be prefixed with "glassfish-".

Deployment Order

User could specify a deployment order number during initial deployment of the application, and that number will be used to determine the loading order of the application during server start up. This could be useful when user has applications which have inter-dependencies among them, and user wants to make sure the applications are loaded in certain order during server start up.

An optional deploymentorder option is added to the CLI deploy command for the user to specify the deployment order number. Application with a lower deployment order number will be loaded before the application with a higher deployment order number. The default value for the deployment order is 100.

In the following example, application foo is deployed with a deployment order 102, and application bar is deployed with a deployment order 110, application foo will be loaded before application bar during server (re)start up.

asadmin deploy --deploymentorder 102 --name foo foo.war

asadmin deploy --deploymentorder 110 -- name bar bar.war

The deployment order number can be configured post deployment (though users usually would plan the deployment order of the applications before the initial deployments) through the asadmin set command:

asadmin set applications.application.foo.deployment-order=112

This will cause the application foo to be loaded after the application bar in the next server (re)start up.

User could check for the current assigned number of the deployment order through the get command:

asadmin get applications.application.foo.deployment-order

4.2. Bug/RFE Number(s):

4.3. In Scope:

Deployment Order

Support deployment order of user applications

4.4. Out of Scope:

Deployment Order

Support deployment order of resources

4.5. Interfaces:

4.5.1 Public Interfaces

  • Interface: CLI deploy command
  • Comment: add altdd and runtimealtdd options for supporting external deployment descriptor, add deploymentorder option for supporting deployment order

4.5.2 Private Interfaces

4.5.3 Deprecated/Removed Interfaces:

N/A

4.6. Doc Impact:

Update man pages for the new/modified CLI commands

Application Deployment Guide/Developer Guide for new features

4.7. Admin/Config Impact:

CLI

Additional options altdd, runtimealtdd, deploymentorder to the deploy command.

GUI

GUI should provide equivalent functionality as CLI (allow user to input additional options).

4.8. HA Impact:

N/A

4.9. I18N/L10N Impact:

N/A

4.10. Packaging, Delivery & Upgrade:

4.10.1. Packaging

Changes will be made to existing deployment modules.

4.10.2. Delivery

N/A

4.10.3. Upgrade and Migration:

N/A

4.11. Security Impact:

N/A

4.12. Compatibility Impact

No compatibility impact. The new options of the CLI commands are all optional.

4.13. Dependencies:

4.13.1 Internal Dependencies

N/A

4.13.2 External Dependencies

Java EE 7 specifications

4.14. Testing Impact:

Unit tests/functional tests will be added to cover the new features

5. Reference Documents:

References

6. Schedule:

6.1. Projected Availability:

Java EE 7 Requirements

  • Initially integrated: EEMS3
  • Feature complete: EEMS4
  • At production quality level: EEMS6

Deployment Order

  • Initially integrated: EEMS2
  • Feature complete: EEMS3
  • At production quality level: EEMS6
Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Sign up or Log in to add a comment or watch this page.


The individuals who post here are part of the extended Oracle community and they might not be employed or in any way formally affiliated with Oracle. The opinions expressed here are their own, are not necessarily reviewed in advance by anyone but the individual authors, and neither Oracle nor any other party necessarily agrees with them.