Feature
This binding component allows to interact with an external JMS Destination (queue or topic). Service Units are used to map a JMS destination to a JBI ServiceEndpoint. A JBI MessageExchange sent to a ServiceEndpoint (mapped to a JMS destination) is transformed into a JMS TextMessage and sent to the corresponing JMS destination. A JMS message sent to a JMS Destination is transformed into a JBI MessageExchange and sent to the corresponding JBI ServiceEndpoint.
|
Sending or publishing a JBI message to a JMS Queue or Topic
PROVIDE SERVICE: Expose a Java class as a Service
Usage
The petals-bc-jms component can expose as a JBI ServiceEndpoint an external JMS Queue or JMS Topic. This is done by deploying a Service Unit on it.
When a message is received from the JBI environment, it is transformed into a JMS TextMessage and sent or published on the Queue or Topic.
|
Service Unit descriptor
The Service Unit descriptor file ( jbi.xml ) looks like this :
<?xml version="1.0" encoding="UTF-8"?> <jbi:jbi xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:petals="http://petals.objectweb.org/extensions" xmlns:jbi="http://java.sun.com/xml/ns/jbi" version="1.0"> <jbi:services binding-component="false"> <jbi:provides interface-name="petals:JMSSampleProviderInterface" service-name="petals:JMSSampleProviderService" endpoint-name="JMSSampleProviderEndpoint"> <petals:params> <petals:param name="address">scn://localhost:26400</petals:param> <petals:param name="destination-name">queueProvider</petals:param> <petals:param name="initial-context-factory">fr.dyade.aaa.jndi2.client.NamingContextFactory</petals:param> <petals:param name="connection-factory">qcf</petals:param> <petals:param name="user">anonymous</petals:param> <petals:param name="password">anonymous</petals:param> <petals:param name="transacted">false</petals:param> </petals:params> </jbi:provides> </jbi:services> </jbi:jbi>
JMS communication attributes:
Parameter | Description | Default | Required |
---|---|---|---|
provides | Name of the JBI service that will be activated to expose the JMS destination into the JBI environment. Interface (qname), service (qname) and endpoint (string) name are required. | - | Yes |
address | Address composed of the URL provider (JNDI access) | - | Yes |
destination-name | The JMS destination name where messages will be sent (Queue or Topic JNDI name) | - | Yes |
initial-context-factory | The initial-context-factory class name, used to create an InitalContext. | - | Yes |
connection-factory | name of the JMS ConnectionFactory registered. | - | Yes |
user | User name to access the JMS Destination. | "" | Yes |
password | Password to access the JMS Destination. | "" | Yes |
transacted | JMS communication transacted mode. true or false. | "false" | Yes |
max-active | Controls the maximum number of JMS connections that can be borrowed from the pool at one time. When non-positive, there is no limit to the number of connections that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted. | ||
"10" | No | ||
max-idle | Controls the maximum number of JMS connections that can sit idle in the pool at any time. When negative, there is no limit to the number of connections that may be idle at one time. | "5" | No |
max-wait | If a positive maxWait value is supplied, the JMS component will wait for at most that many milliseconds to retrieve an available JMS connection. If maxWait is non-positive, the component will wait indefinitely. | "10000" | No |
time-between-eviction-runs-millis | Indicates how long the eviction thread should sleep before "runs" of examining idle connections. When non-positive, no eviction thread will be launched. |
"10000" | No |
min-evictable-idle-time-millis | Specifies the minimum amount of time that a connection may sit idle in the pool before it is eligable for eviction due to idle time. When non-positive, no connections will be dropped from the pool due to idle time alone. |
"2000" | No |
test-while-idle | Indicates whether or not idle connections should be validated. Connections that fail to validate will be dropped from the pool. | "true" | No |
Extra attributes:
Parameter | Description | Default | Required |
---|---|---|---|
wsdl | Path to a wsdl file describing services and operations offered by an endpoint activated by the SU. This extension is only usable with provides fields. The path can be a url "http" or "file" or relative to the r oot directory of the SU archive. Ex: "file:///user/ofabre/test.wsdl" or "/WSDL/test.wsdl". If no wsdl path is specified, a simplified description will automaticaly be written by the CF. |
- | No |
Parameter | Description | Default | Required |
---|---|---|---|
name | Name of the interceptor to use. That's the name defined in the component | - | Yes |
Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file, has described above,
- An optional wsdl file describing the related service.
service-unit.zip + META-INF - jbi.xml (as defined above) - service.wsdl (optional)
Sending a JBI message from a received or published JMS Message
CONSUME SERVICE: Expose an internal service outside the JBI environment
The petals-bc-jms component can listen to an external JMS Queue or JMS Topic and send the message to a JBI
ServiceEndpoint. We say that the component consumes the JBI service.
When a message is received from the JMS server (the component listens to the JMS Queue or has subscribed to a JMS Topic), it is transformed into a JBI Message and sent to the JBI ServiceEndpoint configure in the Service Unit.
Only for Binding Components
| - | No | Component |
jbi-listener-class-name | Qualified name of the class extending AbstractJBIListener | - | Yes |
external-listener-class-name | Qualified name of the class extending AbstractExternalListener | - | No |
Parameter | Description | Default | Required |
---|---|---|---|
class | Name of the interceptor class. This class must extend the abstract class org.objectweb.petals.component.common.interceptor.Interceptor. This class have to be present in the classloader, in component or CF or in a shared library. | - | Yes |
name | Name of the interceptor. This name will be used for additional class name configuration in the SU. |
class name | No |
active | Interceptor is active for all SU | true | No |
Samples
Two usecases are defined in this section:
- The send of JMS Messages to the JBI Helloworld Service Engine.
- The send of JBI Messages to the JMS External provider.
This section presents how to install the different components and service assemblies to realize these use cases.
In each case, the external JMS Server where the client and provider queue are defined must be started in first.
Install the External JMS Server
To install the external JMS server, you must download and extracts the zip archive at this url:
[Specify joram client link here|maven.objectweb.org/maven2/org/objectweb/petals/usecase/jms/petals-jms-client/1.0-SNAPSHOT/petals-jms-client-1.0-SNAPSHOT-with-dependencies.zip].
This package also contains the external jms Client and Provider used in the next sections.
Insert all jars in your classpath and start the JMS server with the command below:
java org.objectweb.petals.usecase.jms.common.JMSServer
If it is OK, you must see the lines below:
Start JORAM server S0... ...JORAM server S0 started (connected) Initialize JMS service... (connect to JORAM server) (Creation of the queue: queueConsumer) (Queue created) (Queue bound) (Creation of the queue: queueProvider) (Queue created) (Queue bound) (disconnect from JORAM server) JMS destinations initialized...
Now, the external JMS Server is ready and the client and provider queues (respectively, queueConsumer and queueProvider) have been created. You can execute the usecases below.
Send a JMS Message to the JBI Helloworld Service Engine
To send a JMS Message to the JBi HelloWorld Service Engine, you must install several components in the order listed below:
- The HelloWorld Service Engine component ([Download here|maven.objectweb.org/maven2/org/objectweb/petals/petals-se-helloworld/1.4-SNAPSHOT/petals-se-helloworld-1.4-SNAPSHOT.zip]).
- The JMS binding component ([Download here|maven.objectweb.org/maven2/org/objectweb/petals/petals-bc-jms/1.3-SNAPSHOT/petals-bc-jms-1.3-SNAPSHOT.zip]).
- The sa-jms-consume service assembly ([Download here|maven.objectweb.org/maven2/org/objectweb/petals/usecase/jms/sa-jms-consume/1.0-SNAPSHOT/sa-jms-consume-1.0-SNAPSHOT.zip]). This service assembly contains one service unit:
su-jms-consume service unit. This service unit consumes the endpoint defined by the next service unit.
Once these components are installed, you must install the JMS client.
To install the JMS client, you must download and extracts the zip archive at this url:
[Specify joram client link here|maven.objectweb.org/maven2/org/objectweb/petals/usecase/jms/petals-jms-client/1.0-SNAPSHOT/petals-jms-client-1.0-SNAPSHOT-with-dependencies.zip]
By default, the JMS client is started in console mode.
Inserts all jars in your classpath and start the JMS client with the command below:
java org.objectweb.petals.usecase.jms.client.Client
If it is OK, you must see the lines below:
Start the Echo JMS client... ------------------------------- The parameters used for this client are listed below: -user=anonymous -password=anonymous -connection-factory=qcf -queue-name=queueConsumer -file=null No file has been given in input: You can write the xml message to send in the console or write 'quit' to exit ...(for instance: <text>hello world</text>) =>
You can write an xml message and verify that it has been received by the helloworld component.
If you want that the JMS client send a xml file to the helloworld, you can configure it with the 'file' option as seen below:
java org.objectweb.petals.usecase.jms.common.Client -file=test.xml
the test.xml file is shown below:
<jms> <text>Hello World</text> </jms>
All these components can be seen on Figure 3.1, “The sa-jms-consume use case”
Send a JBI Message to the external JMS provider
To send a JBI Message to the external JMS provider, you must install several components in the order listed below:
- The Sample Client Service Engine component (Download here).
- The JMS binding component ([Download here|maven.objectweb.org/maven2/org/objectweb/petals/petals-bc-jms/1.3-SNAPSHOT/petals-bc-jms-1.3-SNAPSHOT.zip]).
- The sa-jms-provide service assembly ([Download here|maven.objectweb.org/maven2/org/objectweb/petals/usecase/jms/sa-jms-provide/1.0-SNAPSHOT/sa-jms-provide-1.0-SNAPSHOT.zip]). This service assembly contains one service unit:
the su-jms-provide service unit. This service unit provides an endpoint to contact the external JMS provider.
Once these components are installed, you must install the JMS provider.
To install the JMS provider, you must download and extracts the zip archive at this url:
[Specify joram client link here|maven.objectweb.org/maven2/org/objectweb/petals/usecase/jms/petals-jms-client/1.0-SNAPSHOT/petals-jms-client-1.0-SNAPSHOT-with-dependencies.zip]
Inserts all jars in your classpath and start the JMS provider with the command below:
java org.objectweb.petals.usecase.jms.provider.Provider
If it is OK, you must see the lines below:
Start the JMS Echo services... ------------------------------- The parameters used for this server are listed below: -user=anonymous -password=anonymous -connection-factory=qcf -queue-name=queueProvider Start the message receiver... Message receiver started... ... JMS Echo services started... Creating message receiver... MsgListener ready to listen for Receiver
Now, the external JMS provider is ready to receive messages. You can use the sample client to send xml message to the endpoint defined by the su-jms-provide service unit.
All these components can be seen on figure below, “The sa-jms-provide usecase”.