glassfish-obr-builder

Implementing http://java.net/jira/browse/GLASSFISH-19395 and as a basic of glassfish provisioning stories

This is the contribution of Glassfish fighterfish/experimental/glassfish-obr-builder.

Its licensed under CDDL+GPL Licenses by Oracle Glassfish community.

Design Documentation

1 Using Apache Felix Bundle Repository to generate obr xml file for glassfish modules

http://java.net/jira/browse/GLASSFISH-19395

2 Defining a subsystem concept and using the glassfish-obr-builder to deploy a group of bundles and their dependencies

http://java.net/jira/browse/GLASSFISH-19146
http://java.net/jira/browse/GLASSFISH-19400 (future plan)

3 Initial Provision Strategy

1) Glassfish System OBR

Repository---> glassfish3/glassfish/modules

2) User-defined OBR

Repository---> defined in subsystem xml file

current provisioning way: local disk system, in the future, maven repo will be supported

Building

You'll need a machine with JDK 6 1.22 above + and Apache Maven 3 installed.

1 glassfish-obr-builder module building

Checkout:

https://github.com/tangyong/glassfish-obr-builder.git

Run Build:

mvn clean install

2 glassfish-provisioning-samples building

Checkout:

https://github.com/tangyong/glassfish-provisioning-samples.git

Run Build:

mvn  clean install

GLASSFISH-19395 Testing

1) Adding Import-Service and Export-Service into osgi.bundle

-eg. web-glue (main/appserver/web/web-glue) 's osgi.bundle

 ...
 Require-Bundle: org.glassfish.main.ejb.ejb-container, org.glassfish.main.web.ha
 #TangYong Added Import-Service in oder to test Glassfish-Obr-Builder Module
 Import-Service: org.glassfish.internal.data.ApplicationRegistry, com.sun.enterprise.container.common.spi.JCDIService

-eg. weld-integration(main/appserver/web/weld-integration)'s osgi.bundle

 ...
 #TangYong Added Export-Service in oder to test Glassfish-Obr-Builder Module
 Export-Service: com.sun.enterprise.container.common.spi.JCDIService

Then, re-building web-glue and weld-integration modules, and replacing glassfish3/glassfish/modules/web-glue.jar and weld-integration.jar with built web-glue.jar and weld-integration.jar.

2) Putting glassfish-obr-builder.jar into modules/autostart

3) Starting glassfish domain

4) Confirming obr-modules.xml

Under glassfish3/glassfish/domains/domain1/osgi-cache/felix, you should see generated obr-modules.xml. Opening the obr xml file, you will see Import-Service and Export-Service related requires and capabilities from web-glue resouce and weld-integration resource.

Provisioning Subsystem Testing(Non Rest Access)

The following assumes you use a windows system. (Linux/Unix is similar)

1 creating a directory in your disk where you put provisioning sample bundles as following:

eg. in my env

1) mkdir d:\provisioning-sample\

2) putting provisioning sample bundles into the above created directory

-a_api.jar

-a_impl.jar

-b_api.jar

-b_impl.jar

-c_api.jar

-c_impl.jar

2 putting the subsystems.xml into any place of your disk.

3 editting the subsystems.xml and replacing the value of \<repository> with right value based on 2.

4 putting glassfish-obr-builder.jar into glassfish modules/autostart

5 starting glassfish domain

6 asadmin deploy --type=osgi provisioning_web_client.war

7 accessing "http://localhost:8080/subsystem/" and click "Deploying Subsystem" link

8 uploading your subsystems.xml and click "deploy" button, then, you will see deployed subsystem detailed info from page.

9 backing to Subsystems Administration Page, and click "Listing Subsystems" link, then, selecting a subsystems from list box, clicking "display detailed info", and you will see detailed deployed subsystems info.

10 asadmin osgi lb

Seeing whether these bundles have been deployed successfully, and some bundles have been in active state, because defaultly we start some modules based on subsystem xml file.

In addition, in server.log, you can find the following contents:

You can also see user-defined obr file called "obr-provisioning-sample.xml" and subsystem xml file in glassfish3\glassfish\domains\domain1\osgi-cache\felix\bundle272(the bundle id maybe is different on your env)\data\subsystems\provisioning-samples

In addition, you can try to switch definition order of c_impl.jar and a_impl.jar in subsystems.xml, and no problem, deployment will be still normal.

Provisioning Subsystem Testing(Rest Access)

Currently, a "listsubsystems" REST API has been available and other REST API is doing

So, in order to demostrate the "listsubsystems" REST API, please firstly deploying a subsystem based on "Provisioning Subsystem Testing(Non Rest Access) 's step1`step8",

then, in browser, clicking "http://localhost:8080/osgi/jersey-http-service/obrhandler/listsubsystems/provisioning-samples" , you will see the following result:

<subsystems name="provisioning-samples" description="subsystems provisioning test">

  <repository name="provisioning-sample" uri="D:/provisioning-sample/"/>

  <subsystem name="provisioning-sample" description="subsystems provisioning test samples">

     <module name="sample.glassfish.provisioning.c_api" version="1.0.0.SNAPSHOT" start="false" description="c api module"/>

     <module name="sample.glassfish.provisioning.c_impl" start="true" startlevel="3"/>

     <module name="sample.glassfish.provisioning.a_api" start="false"/>

     <module name="sample.glassfish.provisioning.a_impl" start="true" startlevel="1"/>

     <module name="sample.glassfish.provisioning.b_api" start="false"/>

     <module name="sample.glassfish.provisioning.b_impl" start="true" startlevel="2"/>

  </subsystem>