THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
JMS endpoints need to know the address information for establishing connections to the proper destination. SOAP over JMS implements the URI Scheme for Java Message Service 1.0.
| Code Block | ||||
|---|---|---|---|---|
| ||||
jms:<variant>:<destination name>?param1=value1¶m2=value2 |
...
| Code Block |
|---|
jms:jndi:SomeJndiNameForDestination?jndiInitialContextFactory=org.apache.activemq.jndi.ActiveMQInitialContextFactory&jndiURL=tcp://localhost:61616&priority=3 jms:queue:ExampleQueueName?timeToLive=1000 |
...
JMS parameters
Query Parameter | From Version | DefaultValue | Description |
|---|---|---|---|
| conduitIdSelectorPrefix | 3.0.0 | If set then this string will be the prefix for all correlation ids the conduit creates and also be used in the selector for listening to replies | |
deliveryMode | PERSISTENT | NON_PERSISTENT messages will kept only in memory | |
| durableSubscriptionName | 3.0.0 | ||
jndiConnectionFactoryName | ConnectionFactory | Specifies the JNDI name bound to the JMS connection factory to use when connecting to the JMS destination. | |
jndiInitialContextFactory |
| Specifies the fully qualified Java class name of the "InitialContextFactory" implementation class to use. | |
| jndiTransactionManagerName | 3.0.0 | Name of the JTA TransactionManager. Will be searched in spring, blueprint and jndi. | |
jndiURL |
| Specifies the JNDI provider URL | |
| jndi-* | Additional parameters for a JNDI provider | ||
| messageType | 3.0.0 | byte | JMS message type used by CXF (byte, text or binary) |
| password | 3.0.0 | Password for creating the connection. Using this in the URI is discouraged | |
| priority | 3.0.0 | 4 | Priority for the messages. See your JMS provider documentation for details. Values range from 0 to 9 where 0 is lowest priority |
replyToName |
| Specifies the JNDI name bound to the JMS destinations where replies are sent | |
| receiveTimeout | 3.0.0 | 60000 | Timeout in milliseconds the client waits for a reply in case of request / repy exchanges |
| reconnectOnException | deprecated in 3.0.0 | true | Should the transport reconnect in case of exceptions. From version 3.0.0 on the transport will always reconnect in case of exceptions |
| sessionTransacted | 3.0.0 | false | Set to true for resource local transactions. Do not set if you use JTA |
| targetService | |||
timeToLive | 0 | Time (in ms) after which the message will be discarded by the jms provider | |
| topicReplyToName | Reply to messages on a topic with this name. Depending on the variant this is either a jndi or jms name. | ||
| useConduitIdSelector | 3.0.0 | true | Each conduit is assigned with a UUID. If set to true this conduit id will be the prefix for all correlation ids. This allows several endpoints to share a JMS queue or topic |
username | 3.0.0 |
| Username for creating the connection |
...
For this example:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<wsdl:definitions name="JMSGreeterService"
<wsdl:binding name="JMSGreeterPortBinding" type="tns:JMSGreeterPortType">
<soap:binding style="document" transport="http://www.w3.org/2010/soapjms/" />
<soapjms:jndiContextParameter name="name" value="value" />
<soapjms:jndiConnectionFactoryName>ConnectionFactory</soapjms:jndiConnectionFactoryName>
<soapjms:jndiInitialContextFactory>org.apache.activemq.jndi.ActiveMQInitialContextFactory</soapjms:jndiInitialContextFactory>
<soapjms:jndiURL>tcp://localhost:61616</soapjms:jndiURL>
<soapjms:deliveryMode>PERSISTENT</soapjms:deliveryMode>
<soapjms:priority>5</soapjms:priority>
<soapjms:timeToLive>1000</soapjms:timeToLive>
<wsdl:operation name="greetMe">
<soap:operation soapAction="test" style="document" />
<wsdl:input name="greetMeRequest">
<soap:body use="literal" />
</wsdl:input>
<wsdl:output name="greetMeResponse">
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="JMSGreeterService">
<soapjms:jndiConnectionFactoryName>ConnectionFactory</soapjms:jndiConnectionFactoryName>
<soapjms:jndiInitialContextFactory>org.apache.activemq.jndi.ActiveMQInitialContextFactory</soapjms:jndiInitialContextFactory>
<wsdl:port binding="tns:JMSGreeterPortBinding" name="GreeterPort">
<soap:address location="jms:jndi:dynamicQueues/test.cxf.jmstransport.queue" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
|
- The transport URI (http://www.w3.org/2010/soapjms/) is defined in the <soap:binding>.
- The jms: URI is defined in the <soap:address>
- The extension properties are in the <soap:binding>
...
Define service endpoint or proxy in spring or blueprint
The JAXWS endpoint or proxy can be defined like in the SOAP/HTTP case. Just use a jms: uri like described above.
In CXF 3 it is possible to omit the jndi settings. Just specify an endpoint like this:
| Code Block | ||||
|---|---|---|---|---|
| ||||
|
Publishing a service with the JAVA API
Developers who don't wish to modify the WSDL file can also publish the endpoint information using Java code. For CXF's SOAP over JMS implementation you can write the following:
| Code Block | ||||
|---|---|---|---|---|
| ||||
// You just need to set the address with JMS URI
String address = "jms:jndi:dynamicQueues/test.cxf.jmstransport.queue3"
+ "?jndiInitialContextFactory"
+ "=org.apache.activemq.jndi.ActiveMQInitialContextFactory"
+ "&jndiConnectionFactoryName=ConnectionFactory&jndiURL=tcp://localhost:61500";
Hello implementor = new HelloImpl();
JaxWsServerFactoryBean svrFactory = new JaxWsServerFactoryBean();
svrFactory.setServiceClass(Hello.class);
svrFactory.setAddress(address);
// And specify the transport ID with SOAP over JMS specification
svrFactory.setTransportId(JMSSpecConstants.SOAP_JMS_SPECIFICATION_TRANSPORTID);
svrFactory.setServiceBean(implementor);
svrFactory.create();
// Alternatively using JAXWS Endpoint.create and avoiding JNDI
ConnectionFactory cf = new ActiveMQConnectionFactory("tcp://localhost:61500");
EndpointImpl ep = (EndpointImpl)Endpoint.create(impl);
ep.setBus(bus);
ep.getFeatures().add(new ConnectionFactoryFeature(cf));
ep.publish("jms:queue:test.cxf.jmstransport.queue?timeToLive=1000"); |
NOTE: For tests it can be useful to create an embedded broker like this:NOTE: Before you start the server, you need to make sure the JMS broker is stared, you can find some useful code of starting the JMS broker here.
| Wiki Markup |
|---|
{snippet:id=broker|lang=java|url=cxf/trunk/testutils/src/main/java/org/apache/cxf/testutil/common/EmbeddedJMSBrokerLauncher.java} |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
public void invoke() throws Exception {
// You just need to set the address with JMS URI
String address = "jms:jndi:dynamicQueues/test.cxf.jmstransport.queue3"
+ "?jndiInitialContextFactory"
+ "=org.apache.activemq.jndi.ActiveMQInitialContextFactory"
+ "&jndiConnectionFactoryName=ConnectionFactory&jndiURL="
+ "&jndiURL=tcp://localhost:61500";
JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean();
// And specify the transport ID with SOAP over JMS specification
factory.setTransportId(JMSSpecConstants.SOAP_JMS_SPECIFICIATION_TRANSPORTID);
factory.setServiceClass(Hello.class);
factory.setAddress(address);
Hello client = (Hello)factory.create();
String reply = client.sayHi(" HI");
System.out.println(reply);
}
|
Even if you want to use the 'queue' or 'topic' variants and avoid dealing with JNDI directly, you still have to specify the two factory parameters in the address:
| Code Block |
|---|
svrFactory.setAddress("jms:queue:test.cxf.jmstransport.queue?timeToLive=1000" // Alternatively using the JAXWS API with jms details defined in WSDL while avoiding JNDI SOAPService2 service = new SOAPService2(wsdl, serviceName); // Using the generated service + "&jndiConnectionFactoryName=ConnectionFactory" cf = new ActiveMQConnectionFactory("tcp://localhost:61500"); ConnectionFactoryFeature cff = new ConnectionFactoryFeature(cf); Greeter greeter = markForClose(service.getPort(portName, Greeter.class, cff)); // Connection Factory can be set a feature in CXF >= + "&jndiInitialContextFactory" + "=org.apache.activemq.jndi.ActiveMQInitialContextFactory"); 3.0.0 |
If you specify queue or topic as variant and use cxf >= 3.0.0 then the jndi settings are not necessary.
| Code Block |
|---|
svrFactory.setAddress("jms:queue:test.cxf.jmstransport.queue?timeToLive=1000");
// For CXF >= 3.0.0
svrFactory.setFeatures(Collections.singletonList(new ConnectionFactoryFeature(cf))); |
In this case case the connection factory is supplied using a feature. For CXF 2.x the connection factory can only be supplied using jndi.