...
This document discusses how to package and deploy a lightweight component to the ServiceMix lightweight container (servicemix-lwcontainer
). The ServiceMix lightweight container is a service engine JBI component whose purpose is to allow lightweight components (POJOs) to be deployed at runtime rather than only deploying them statically via the servicemix.xml
file. Please see What is a Lightweight Component for a good explanation of the different types of JBI components.
...
We are going to use the existing ServiceMix Loan Broker example, which can be found Loan Broker Demo for ServiceMix, as the basis for this discussion.
...
Code Block |
---|
cd [servicemix_dir]\examples\loan-broker ant build-components |
This will compile the Java code and put the Java class files into the {{\ Wiki Markup [servicemix_dir
\]\examples\loan-broker\build\loanbroker\components
}} directory.
Now we are ready to assemble the lightweight components together. The loan broker demo supplies us with a build.xml
file (which was used in the compile step above). The build.xml
contains targets for creating service units and service assemblies. If you run "ant setup" a service unit and service assembly will automatically be created. Ultimately, this is what you will want to do, however, the following procedure gives the manual steps for creating a service unit and service assembly, to facilitate in understanding the contents of a SUs and SAs.
- First create the service unit. The service unit is a ZIP file that will contain your application's Java class files and the
servicemix.xml
configuration file. The service unit can also contain ajbi.xml
which provides information about services statically provided and consumed. In ServiceMix it is optional to include this file. In the case of our example, we have not included it. Use a ZIP compression tool, such as Winzip or gzip to create a zip file containing the classes in \ [servicemix_dir\]\examples\loan-broker\build\loanbroker\components and the {{Wiki Markup servicemix.xml
}} file which can be found in {{\[servicemix_dir
\]\src\su
}}. The zip file name is arbitrary, but it is used in the Service Assembly's {{jbi.xml
}} file, so to match the example call it {{loanbroker-su.zip
}}. \\ Put the {{Wiki Markup loanbroker-su.zip
}} file in the {{\[servicemix_dir
\]\examples\loan-broker\build
}} directory for later use. Note: you may store the zip file anywhere. \\ \\ The above two steps can be done automatically using the ant script: "ant
The above two steps can be done automatically using the ant script: "ant build-su". If you look in the {{build.xml
}} file you will see the {{build-su
}} target does exactly what we just did manually. \\ \\
- Create the Service Assembly. A service assembly is a zip file containing one or more service units and a
jbi.xml
file. Thejbi.xml
file must be in theMETA-INF
directory. you may also include other files in theMETA-INF
directory. The ZIP file directory structure for our example looks like this:Code Block loanbroker-su.zip META-INF\ jbi.xml LICENSE.txt DISCLAIMER.txt
Thejbi.xml
looks like this:Code Block <?xml version="1.0" encoding="UTF-8"?> <jbi xmlns="http://java.sun.com/xml/ns/jbi" version="1.0"> <service-assembly> <identification> <name>loanbroker</name> <description>LoanBroker Service Assembly</description> </identification> <service-unit> <identification> <name>loanbroker</name> <description>LoanBroker Service Unit</description> </identification> <target> <artifacts-zip>loanbroker-su.zip</artifacts-zip> <component-name>servicemix-lwcontainer</component-name> </target> </service-unit> </service-assembly> </jbi>
\\ \\Wiki Markup
The interesting thing to note is that the {{jbi.xml
}} file tells the JBI container what service units are in the service assembly and where to deploy them. There is only one service unit in our example, which is "loanbroker" (see the {{artifacts-name
}} tag) and the component to which it will be deployed is {{servicemix-lwcontainer
}} (see the <component-name> tag). There could be multiple service units in a service assembly and they would each be included in the {{jbi.xml
}} file with the same type of information for each. \\
Create the service assembly ZIP file and include the {{loanbroker-su.zip
}} file and the {{META-INF\jbi.xml
}} directory and file in it. To remain consistent with our example, call the zip file {{loanbroker-sa.zip
}}. \\ Put the {{.
Put theloanbroker-sa.zip
}} file in the {{\[servicemix_dir
\]\examples\loan-broker\build
}} directory for later use. Note: in a real world application you may store the zip file anywhere. \\unmigrated-wiki-markup - The final step is to deploy the service assembly to the JBI container. To do this copy the {{
loanbroker-sa.zip
}} file to the {{\[servicemix_dir
\]\deploy
directory. If ServiceMix is already running it will detect the file is there and start it. If ServiceMix is not running, start it to see the example start running:Code Block ..\..\bin\servicemix servicemix.xml }} directory.
Related Documentation
The JBI spec describes in detail how to create a valid JBI deployment unit. Please see JSR 208.
Spring Related information
Inside the servicemix.xml file, the ability to import the common beans using the following:
Code Block |
---|
<import resource="classpath:otherBeans.xml" />
|
The resource is a SpringResource so the following also works:
Code Block |
---|
<import resource="file:path/to/file/jmx.xml" />
|
if you run ServiceMix (or JBoss) with a param:
Code Block |
---|
JAVA_OPTS="-DMYHOME=somepath/"
JAVA_OPTS=-DMYHOME=somepath/ # windows
|
then in the servicemix.xml and xbean.xml you can reference MYHOME.
eg:
Code Block |
---|
<import resource="file:${MYHOME}/path/to/file/jmx.xml" />
|
Then you can also import a properties file from this same path to pull in other config you may need. (that you want outside an SU/SA bundle).
Code Block |
---|
<bean id="propertyConfigurer"
class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="locations">
<list>
<value>${MYHOME}/conf/config.properties"</value>
</list>
</property>
</bean>
|