Page History

...

Geronimo is the J2EE server project of the Apache Software Foundation. ServiceMix is being tightly integrated with Geronimo so that it takes advantage of it's deployment architecture and to leverage geronimo Geronimo to implement J2EE JBI bindings.

This document is under development and Note: The Geronimo deployment tool is currently under development, so this document is not complete, but is provided to give a preview of what is coming. This document will be completed when the underlying code is ready. If you are interested in this topic and how it progresses, please "watch" this page for future changes.

In the meantime, the ServiceMix on Geronimo deployment shown here is of the servicemix-web.war file. The Tomcat web application server is integrated with Geronimo as part of the Geronimo distribution. Therefore, when the servicemix-web.war file is deployed on Geronimo, it is being handed off to Tomcat by Geronimo. Additionally, the war file uses lightweight components, which are those components defined in a servicemix.xml file. Ultimately, the ServiceMix deployment on Geronimo will use heavyweight components. Heavyweight components accept service unit deployments, such as PXE. If you are interested in this topic and how it progresses, please "watch" this page for future changes.
The document is divided into two major sections. The first section discusses deploying ServiceMix on Geronimo. While the Geronimo deployment tool is under development this section shows how to deploy the ServiceMix web war file onto Geronimo. The second major section discusses how to deploy binding components and service engine components on ServiceMix, which is running on Geronimo.

...

• Windows XP
• Geronimo 1.0-M5 (Geronimo 1.0-SNAPSHOT for component deployment)
• Java 5
• ServiceMix 2.0.x

Deploying ServiceMix on Geronimo

...

1. To undeploy the ServiceMix WAR file, use the Geronimo deployer.jar tool found in the bin directory of the Geronimo base directory.
   From a command shell:

   Code Block
   cd [geronimo_install_dir] java -jar bin/deployer.jar --user system --password manager undeploy servicemix-web

   
   The output in the Geronimo console window should show the ServiceMix WAR file being undeployed. Output will be similar to the following:

   Code Block
   Module servicemix-web stopped. Module servicemix-web unloaded. Module servicemix-web uninstalled. Undeployed servicemix-web

Deploying JBI Components

Deploying JBI Components

...

on ServiceMix Running Stand-Alone

This section is included to show how to deploy a ServiceMix component on ServiceMix running stand-alone. This section will be moved to another document in the future, but it is helpful to see how this deployment is done to build up to the deployment on GeronimoThis is just an example of one way to deploy components. The preferred method is in the next section, however, the Geronimo deployment tool is still under development, so this section is included for the interim.

First some background. A JBI component is either a service engine (SE) or a binding component (BC). These terms are defined in #Introduction Introduction to ESB and/or the #Glossary Glossary. A BC/SE is installed on ServiceMix by copying it into the install directory which resides under the ServiceMix home directory. So what gets deployed? JBI components can act as containers themselves. Artifacts can be deployed to an existing BC or SE to add more functionality to that component. Adding artifacts to installed components is called deployment. To deploy artifacts to a component the artifacts can be placed in the deploy directory under the ServiceMix home directory. Another term that is important to know is service assembly. A service assembly is a collection of deployment artifacts and metadata. A service unit is a single deployment artifact which is deployed on a single component. For deployment to happen, the artifacts must be in a very specific format, which is specified in the JSR 208 specification. Please see chapter 6 of the JSR 208 specification for more details.
In addition to deploying components, ServiceMix allows servicemix.xml files to be deployed in a similar method to deploying a component.

...

1. Wiki Markup
   cd \[servicemix_install_dir\]\assembly\target\servicemix-2.0.2\bin\servicemix-2.0.2\examples\quartz-binding

2. create a directory elsewhere, such as \temp\JBIcomponent
3. copy servicemix.xml to \temp\JBIcomponent
4. cd \temp\JBIcomponent
5. edit servicemix.xml
   • need to change a few things to make this a service unit, please see the code here:

     Code Block

     <?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://xbean.org/schemas/spring/1.0" xmlns:spring="http://xbean.org/schemas/spring/1.0" xmlns:sm="http://servicemix.org/config/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xbean.org/schemas/spring/1.0 ../../conf/spring-beans.xsd http://servicemix.org/config/1.0 ../../conf/servicemix.xsd" xmlns:my="http://servicemix.org/demo/"> <!-- the JBI container --> <sm:serviceunit spring:id="jbi"> <sm:activationSpecs> <!-- lets kick off a timer every 5 seconds --> <sm:activationSpec componentName="timer" service="my:timer" destinationService="my:trace"> <sm:component> <bean xmlns="http://xbean.org/schemas/spring/1.0" class="org.servicemix.components.quartz.QuartzComponent"> <property name="triggers"> <map> <entry> <key> <bean class="org.quartz.SimpleTrigger"> <property name="repeatInterval" value="5000" /> <property name="repeatCount" value="-1" /> </bean> </key> <bean class="org.quartz.JobDetail"> <property name="name" value="My Example Job" /> <property name="group" value="ServiceMix" /> </bean> </entry> </map> </property> </bean> </sm:component> </sm:activationSpec> <!-- Route the event to a trace component that just outputs the event to the console --> <sm:activationSpec componentName="trace" service="my:trace"> <sm:component> <bean xmlns="http://xbean.org/schemas/spring/1.0" class="org.servicemix.components.util.TraceComponent" /> </sm:component> </sm:activationSpec> </sm:activationSpecs> </sm:serviceunit> </beans>

     
     
6. Two jar files must be created. These jar files will be copied into the ServiceMix deploy directory.
   The first jar file will contain the service component jbi.xml file. The file should contain:

   Code Block

   <jbi xmlns="http://java.sun.com/xml/ns/jbi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/jbi" version="1.0"> <component type="service-engine"> <identification> <name>servicemix-component</name> <description>A ServiceMix Component that can be used to deploy servicemix.xml artifacts.</description> </identification> <component-class-name>org.servicemix.components.servicemix.ServiceMixComponent</component-class-name> <component-class-path/> </component> </jbi>

   1. Put jbi.xml in an empty META-INF directory and put that into a jar file:

      Code Block
      jar cvf service-component.jar *

   2. Then create a zip file of the servicemix.xml file you modified above. The zip file should contain the servicemix.xml file and it should be called su1.zip to match the name it is called in the jbi.xml file.
   3. Create the second jar file--this is the service assembly jar file. It will contain another jbi.xml file that is used for the service assembly and it will also contain the zip file, su1.zip in this structure:

      Code Block
      META-INF/jbi.xml su1.zip

      The service assembly jbi.xml should be similar to the following:

      Code Block

      <jbi xmlns="http://java.sun.com/xml/ns/jbi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/jbi" version="1.0"> <service-assembly> <identification> <name>AU_1</name> <description>Sample AU</description> </identification> <service-unit> <identification> <name>SU_1</name> <description>Sample</description> </identification> <target> <artifacts-zip>su1.zip</artifacts-zip> <component-name>servicemix-component</component-name> </target> </service-unit> </service-assembly> </jbi>

      Copy the jbi.xml file to the META-INF directory, then create the jar file:

      Code Block
      jar cvf sa_quartz.jar *

7. I copied only this file to the deploy directory on 2.0.3-SNAPSHOT and get:

   Code Block
   [INFO] JBIContainer - Activating component for: [container=defaultJBI,name=servicemix-component,id=servicemix-component] with service: null component: org.servicemix.components.servicemix.ServiceMixComponent@1a1bc40 ServiceMixComponent: init [INFO] AutoDeploymentService - Directory: deploy: Finished installation of archive: service-component.jar

8. Then I copy the sa_quartz.jar file in:

   Code Block

9. Wiki Markup
   Finally, to *deploy*, copy sa_quartz.jar and service-component.jar to the {{deploy}} directory of ServiceMix. The deploy directory is located in {{\[servicemix_install_dir\]\deploy}}, where {{\[servicemix_install_dir\]}} is the location in which ServiceMix was installed.

10. If ServiceMix is already running, look at the console window output to see the deployment. If ServiceMix has not been started, start it and monitor the console window output.

Deploying Components on servicemix-web.war

Deploying JBI Components on Geronimo Using the Geronimo Deployment Tool

...