Requirements

Add-on in SDK

In JavaEE SDK (5.1/5.0?) that contains Glassfish 9.1, two JBI related add-ons will be available. They will be jbi-components.jar and jbi-additional-components.jar. jbi-components.jar will be delivered to the Core SDK and jbi-additional-components.jar will be delivered to the Application SDK.

These add-ons will implement the installer and configurator plugin interfaces defined in http://blrshare.india/~bp122320/addon-javadoc/javadoc/

These add-ons will not be compatible with appserver 9.0 / SDK 5.0

In Java EE SDK, these add-ons will be bundled and will be installed by the SDK GUI installer. SJSAS 9.1 / Glassfish 9.1, will provide a swing based client that downloads the add-on from the update center on demand. After downloading, this tool (a.k.a network installer) will use asadmin install-addon to install the add-ons.

Scope of jbi-components.jar

List of components in this add-on:

• BPEL Engine
• XSLT Engine
• BAM Engine
• File Binding
• JMS Binding
• JDBC Binding
• SMTP Binding

Structure of jbi-components.jar

• This add-on will contain JBI_COMPONENTS.zip, the installer class and jbi-components-configurator.jar.
  
  
• jbi-components-configurator.jar will contain the configurator class.
  
  
• JBI_COMPONENTS.zip will contain the component binaries for the components.
  
  

jbi-components.jar installer actions

• The add-on installer will be invoked only in DAS (either by asadmin install-addon / SDK installer).
  
  
• When the installer class of jbi-components.jar is invoked it will extract JBI_COMPONENTS.zip into AS_INSTALL/addons/jbi-components.
  
  Some directories that are created at this step would be

      c:/sun/appserver/addons/jbi-components/bpelengine/bpelserviceengine.jar
      c:/sun/appserver/addons/jbi-components/xsltengine/xsltengine.jar
      c:/sun/appserver/addons/jbi-components/BAMengine/BAMengine.jar

• It will copy jbi-components-configurator.jar to AS_INSTALL/lib/addons.
  
  
• When uninstall method of this installer is invoked, it will delete AS_INSTALL/addons/jbi-components.
  
  

jbi-components-configurator.jar actions

• The configurator class will be invoked in DAS when the DAS starts up for the first time.
  

• The configurator class will be invoked in DAS when any instance starts up for the first time.
  

• When ConfigurationContext.ConfigurationType is DAS, the configurator class copies the JBI components from AS_INSTALL/addons to AS_INSTANCE_ROOT/jbi/components. Some entries that are created at this step would be

     c:/sun/appserver/domains/domain1/jbi/components/bpelengine/installer/bpelengine.jar
     c:/sun/appserver/domains/domain1/jbi/components/xsltengine/installer/xsltengine.jar
     c:/sun/appserver/domains/domain1/jbi/components/BAMengine/installer/BAMengine.jar

• The configurator will edit the jbi registry in AS_INSTANCE_ROOT/jbi/config/jbi-registry.xml to add component-ref entries for all components that are in the add-on jar. When ConfigurationContext.ConfigurationType is DAS these entries are added under 'server'. Some entries that are added at this step would be

      <components>
            <component name="com.sun.bpelserviceengine-1.0-2" file-name="bpelserviceengine.jar" />
       ......
       ......
      <servers>
            <server name-ref="server">
             
                <component-ref name-ref="com.sun.bpelserviceengine-1.0-2" 
                                state="SHUTDOWN" 
                                install-root="${com.sun.aas.instanceRoot}/jbi/components/bpelengine/install_root"
                                workspace="${com.sun.aas.instanceRoot}/jbi/components/bpelengine/install_root/workspace"
                                bootstrapClassLoaderSelfFirst="false"
                                componentClassLoaderSelfFirst="true">
                </component-ref>
        .....
        .....

• The configurator will edit the jbi registry in AS_INSTANCE_ROOT/jbi/config/jbi-registry.xml to add component-ref entries for all components that are in the add-on jar. When ConfigurationContext.ConfigurationType is INSTANCE these entries are added under the 'instance-name' server-ref. Some entries that are added at this step would be

      <servers>
          <server name-ref="instance1">
            
            <component-ref name-ref="com.sun.bpelserviceengine-1.0-2" 
                            state="SHUTDOWN" 
                            install-root="${com.sun.aas.instanceRoot}/jbi/components/bpelengine/install_root"
                            workspace="${com.sun.aas.instanceRoot}/jbi/components/bpelengine/install_root/workspace"
                            bootstrapClassLoaderSelfFirst="false"
                            componentClassLoaderSelfFirst="true">
            </component-ref>

• When ConfigurationContext.ConfigurationType is DAS, the configurator extracts the add-on components to create their install_root and creates their workspace dirs. Some directories that are created at this step would be

       c:/sun/appserver/domains/domain1/jbi/components/bpelengine/install_root/
       c:/sun/appserver/domains/domain1/jbi/components/bpelengine/install_root/workspace

• JBI Synchronization will take care of moving the component binaries and also the JBI registry changes to remote instances.

Add-on in Application SDK

jbi-additional-components.jar will be delivered to the Application SDK.

Scope of jbi-additional-components.jar

List of components in this add-on:

• SNMP Binding
• FTP Binding
• SAP Binding
• HL7 Binding
• MQ Binding
• MSMQ Binding
• BAM reports web application
• CAM web application

Structure of jbi-additional-components.jar

• This add-on will contain JBI_ADDITIONAL_COMPONENTS.zip, the installer class and jbi-additional-components-configurator.jar.
  
  
• jbi-additional-components-configurator.jar will contain the configurator class.
  
  
• JBI_ADDITIONAL_COMPONENTS.zip will contain the component binaries.
  
  

jbi-additional-components.jar installer actions

• The add-on installer will be invoked only in DAS (either by asadmin install-addon / SDK installer).
  
  
• When the installer class of jbi-additional-components.jar is invoked it will extract JBI_ADDITIONAL_COMPONENTS.zip into AS_INSTALL/addons/jbi-additional-components.
  
  Some entries that are created at this step would be

       c:/sun/appserver/addons/jbi-additional-components/bpelengine/bpelserviceengine.jar
       c:/sun/appserver/addons/jbi-additional-components/xsltengine/xsltengine.jar
       c:/sun/appserver/addons/jbi-additional-components/BAMengine/BAMengine.jar

• When the installer class of jbi-additional-components.jar is invoked it will copy jbi-additional-components-configurator.jar to AS_INSTALL/lib/addons.
  
  
• The installer class will expand the web applications BAM report, CAM into AS_INSTALL/lib/install/applications.
  
  
• When uninstall method of this installer is invoked, it will delete

      c:/sun/appserver/addons/jbi-additional-components 
      c:/sun/appserver/lib/install/applications/BAM
      c:/sun/appserver/lib/install/applications/CAM

• The configurator class will be invoked in DAS when the DAS starts up for the first time.
  

• The configurator class will be invoked in DAS when any instance starts up for the first time.
  

• When ConfigurationContext.ConfigurationType is DAS, the configurator class copies the components from AS_INSTALL/addons/jbi-additional-components to AS_INSTANCE_ROOT/jbi/components and extracts them.
  Some entries that are created at this step would be
  

      c:/sun/appserver/domains/domain1/jbi/components/SNMPbinding/installer/

• This add-on includes web applications. Configurator will add definition for the BAM, CAM web applications in domain.xml. This in effect creates directory-deployment of the web-app.

• A simpler add-on installer would be just bundling the components and will leave the installation task to the user. For example jbi-components.zip will bundle all the components and when invoked unzip them and keep them in AS_INSTALL/domains/domain1/addons/kenai. Users will use asant, asadmin to install these components.
  

• jbi-components.zip and jbi-additional-components.zip are doing all the additional steps described in this document to let the users get these components pre-installed.
  

• The components inside jbi-components.zip and jbi-additional-components.zip are added as normal components and not as system components.
  

• The other option that was considered was to extract the components into AS_INSTANCE_ROOT/addons/kenai, but this was not chosen because letting appserver sync. the component bits and JBI sync. the registry is not clean. Instead now both the bits and the registry will be synchronnized by JBI itself.
  

Open Issues

1)Should BAM report, CAM be deployed on all instances in a EE domain or only in the DAS?

This page (revision-3) was last changed on 13-Dec-06 10:00 AM, -0800 by Installer.
This page was created on 17-Nov-06 18:23 PM, -0800 by null.

More info...