Using WS-RM with Axis2 1.5?

[Karl Beowulph]

Hello,

We've recently made a switch from building WS clients in JBossWS to using Axis2. Can anyone point me to a quick guide on building WS-RM clients in Axis2?

I'm aware of the Sandesha2 module for Axis2 which is supposed to handle WS-RM, but the last version is from 2007 and claims compatibility with Axis2 1.3. Is it still useable with later versions?

[Karl Beowulph]

This has been giving me more problems then I anticipated...

I have a WS-RM enabled web service up and running in JBoss, the code is as follows:

package com.ieso.ws;

import javax.jws.WebService;

import org.jboss.ws.annotation.EndpointConfig;
import org.jboss.ws.extensions.policy.annotation.Policy;
import org.jboss.ws.extensions.policy.annotation.PolicyAttachment;
import org.jboss.ws.extensions.policy.PolicyScopeLevel; 

@PolicyAttachment (@Policy (policyFileLocation = "META-INF/reliablePolicy.xml", scope = PolicyScopeLevel.WSDL_BINDING ))   
@EndpointConfig (configFile = "META-INF/wsrm-jaxws-endpoint-config.xml", configName = "Standard WSRM Endpoint" )
@WebService 
public class TestRm {
	public String echo(String s){ 
		System.out.println("Echo called ("+s+")");
        return "I'm a reliable echo of: "+s; 
    } 
}

I am able to connect to it without problem with a JBossWS client.

package com.ieso.test;

import org.junit.Test;

import com.ieso.ws.TestRm;
import com.ieso.ws.TestRmService;
import org.jboss.ws.core.StubExt; 

public class TestRmClient {

	@Test
	public void test1(){
		TestRm port = new TestRmService().getTestRmPort();
		((StubExt)port).setConfigName("Standard Anonymous WSRM Client", "META-INF/wsrm-jaxws-client-config.xml");
		System.out.println(port.echo("World"));
	}
}

With my Axis2 client though, things are pretty wonky. For a start, it looks like Sandesha2 [1.3] is not fully compatible with Axis2 [1.5], so I don't know how much of the problem is really a fault of my code vs. incompatibilities. I installed Sandesha2 as outlined, with the exception that I did not change my $AXIS2_HOME/conf/axis2.xml file (it already has RMPhase's in the phase orders).

I built my Axis client as such:

package com.ieso.ws.test;

import java.rmi.RemoteException;

import org.apache.axis2.client.ServiceClient;
import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.context.ConfigurationContextFactory;
import org.apache.sandesha2.client.SandeshaClientConstants;
import org.junit.Test;

import com.ieso.ws.TestRmServiceStub;

public class TestRmClient {
	final static String CLIENT_REPO = "D:\\opt\\axis2-1.5\\repository", 
		AXIS2_XML = "D:\\opt\\axis2-1.5\\conf\\axis2.xml";
	
	@Test
	public void testRmEcho() throws RemoteException, InterruptedException{
		ConfigurationContext configContext = ConfigurationContextFactory.createConfigurationContextFromFileSystem(CLIENT_REPO,AXIS2_XML);
		configContext.setProperty(SandeshaClientConstants.OFFERED_SEQUENCE_ID, "testSeq");
		
		TestRmServiceStub stub = new TestRmServiceStub(configContext);
		
		ServiceClient sc = stub._getServiceClient();
		
		sc.engageModule("addressing");
		sc.engageModule("sandesha2");
		
		sc.getOptions().setProperty(SandeshaClientConstants.LAST_MESSAGE, "true");
		System.out.println(stub.echo("Axis_World"));
	}
}

This attempt fails and I get the following in my axis.log

2009-12-10 09:17:02,924 INFO  [main] ClusterBuilder - Clustering has been disabled
2009-12-10 09:17:03,064 INFO  [main] ModuleDeployer - Deploying module: addressing-1.5 - file:/D:/opt/axis2-1.5/repository/modules/addressing-1.5.mar
2009-12-10 09:17:03,084 INFO  [main] ModuleDeployer - Deploying module: metadataExchange-1.5 - file:/D:/opt/axis2-1.5/repository/modules/mex-1.5.mar
2009-12-10 09:17:03,134 INFO  [main] ModuleDeployer - Deploying module: mtompolicy-1.5 - file:/D:/opt/axis2-1.5/repository/modules/mtompolicy-1.5.mar
2009-12-10 09:17:03,144 INFO  [main] ModuleDeployer - Deploying module: ping-1.5 - file:/D:/opt/axis2-1.5/repository/modules/ping-1.5.mar
2009-12-10 09:17:03,224 INFO  [main] ModuleDeployer - Deploying module: sandesha2-1.3 - file:/D:/opt/axis2-1.5/repository/modules/sandesha2-1.3.mar
2009-12-10 09:17:03,234 INFO  [main] ModuleDeployer - Deploying module: script-1.5 - file:/D:/opt/axis2-1.5/repository/modules/scripting-1.5.mar
2009-12-10 09:17:03,244 INFO  [main] ModuleDeployer - Deploying module: soapmonitor-1.5 - file:/D:/opt/axis2-1.5/repository/modules/soapmonitor-1.5.mar
2009-12-10 09:17:03,264 INFO  [main] ModuleDeployer - Deploying module: metadataExchange-1.5 - file:/D:/workspaces/webServices/testRmClient_1_Axis2/lib/axis2/mex-1.5.jar
2009-12-10 09:17:03,284 ERROR [main] SandeshaModule - Could not load module policies. Using default values.
2009-12-10 09:17:03,384 INFO  [main] ServiceDeployer - Deploying Web service: version.aar - file:/D:/opt/axis2-1.5/repository/services/version.aar
2009-12-10 09:17:04,776 ERROR [Axis2 Task] FaultManager - org.apache.axis2.AxisFault: RM handler was not able to find WS-RM message in the payload
2009-12-10 09:17:10,845 ERROR [Axis2 Task] FaultManager - org.apache.axis2.AxisFault: RM handler was not able to find WS-RM message in the payload
2009-12-10 09:17:22,933 ERROR [Axis2 Task] FaultManager - org.apache.axis2.AxisFault: RM handler was not able to find WS-RM message in the payload

Anyone have any insight as to what I'm doing incorrectly in Axis2?

[Karl Beowulph]

A bit more reading has turned up that JBossWS implements WS-RM 1.1. I've also updated my Sandesha2 to version 1.5 RC1.

I've changed my client accordingly:

package com.ws.test;

import java.rmi.RemoteException;

import org.apache.axis2.Constants;
import org.apache.axis2.addressing.AddressingConstants;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.ServiceClient;
import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.context.ConfigurationContextFactory;
import org.apache.sandesha2.Sandesha2Constants;
import org.apache.sandesha2.client.SandeshaClient;
import org.apache.sandesha2.client.SandeshaClientConstants;
import org.apache.sandesha2.util.SandeshaUtil;
import org.junit.Test;

import com.ieso.ws.TestRmServiceStub;

public class TestRmClient {
	final static String OPT = "D:\\opt";
	final static String CLIENT_REPO = OPT+"\\axis2-1.5\\repository", 
		AXIS2_XML = OPT+"\\axis2-1.5\\conf\\axis2.xml";
	
	@Test
	public void testRmEcho() throws RemoteException, InterruptedException{
		ConfigurationContext configContext = ConfigurationContextFactory.
			createConfigurationContextFromFileSystem(CLIENT_REPO,AXIS2_XML);
		        
		TestRmServiceStub stub = new TestRmServiceStub(configContext);
		
		ServiceClient sc = stub._getServiceClient();
		
		sc.engageModule("addressing");
		sc.engageModule("sandesha2");
		
		//-- Options
		Options clientOptions = sc.getOptions();
		clientOptions.setProperty(SandeshaClientConstants.OFFERED_SEQUENCE_ID, SandeshaUtil.getUUID());
		clientOptions.setProperty(SandeshaClientConstants.RM_SPEC_VERSION, Sandesha2Constants.SPEC_VERSIONS.v1_1);
		clientOptions.setProperty(SandeshaClientConstants.SEQUENCE_KEY, SandeshaUtil.getUUID());
		clientOptions.setTransportInProtocol(Constants.TRANSPORT_HTTP);
		clientOptions.setProperty(SandeshaClientConstants.AcksTo, AddressingConstants.Final.WSA_ANONYMOUS_URL);
		
		//-- The message
		System.out.println(stub.echo("Hello Axis"));
		
		//-- More options
		SandeshaClient.terminateSequence(sc);
		sc.cleanup();
	}
}

I still have errors though. My axis.log reads as such:

2009-12-11 14:40:58,132 INFO  [main] ClusterBuilder - Clustering has been disabled
2009-12-11 14:40:58,333 INFO  [main] ModuleDeployer - Deploying module: addressing-1.5 - file:/D:/opt/axis2-1.5/repository/modules/addressing-1.5.mar
2009-12-11 14:40:58,353 INFO  [main] ModuleDeployer - Deploying module: metadataExchange-1.5 - file:/D:/opt/axis2-1.5/repository/modules/mex-1.5.mar
2009-12-11 14:40:58,373 INFO  [main] ModuleDeployer - Deploying module: mtompolicy-1.5 - file:/D:/opt/axis2-1.5/repository/modules/mtompolicy-1.5.mar
2009-12-11 14:40:58,393 INFO  [main] ModuleDeployer - Deploying module: ping-1.5 - file:/D:/opt/axis2-1.5/repository/modules/ping-1.5.mar
2009-12-11 14:40:58,483 INFO  [main] ModuleDeployer - Deploying module: sandesha2-1.5 - file:/D:/opt/axis2-1.5/repository/modules/sandesha2-1.5.mar
2009-12-11 14:40:58,503 INFO  [main] ModuleDeployer - Deploying module: script-1.5 - file:/D:/opt/axis2-1.5/repository/modules/scripting-1.5.mar
2009-12-11 14:40:58,523 INFO  [main] ModuleDeployer - Deploying module: soapmonitor-1.5 - file:/D:/opt/axis2-1.5/repository/modules/soapmonitor-1.5.mar
2009-12-11 14:40:58,543 INFO  [main] ModuleDeployer - Deploying module: metadataExchange-1.5 - file:/D:/workspaces/webServices/testRmClient_1_Axis2/lib/axis2/mex-1.5.jar
2009-12-11 14:40:58,593 INFO  [main] SandeshaModule - Module policies were successfully loaded.
2009-12-11 14:40:58,733 INFO  [main] ServiceDeployer - Deploying Web service: version.aar - file:/D:/opt/axis2-1.5/repository/services/version.aar
2009-12-11 14:41:09,279 ERROR [Axis2 Task] AxisEngine - The endpoint reference (EPR) for the Operation not found is  and the WSA Action = 
org.apache.axis2.AxisFault: The endpoint reference (EPR) for the Operation not found is  and the WSA Action = 
	at org.apache.axis2.engine.DispatchPhase.checkPostConditions(DispatchPhase.java:89)
	at org.apache.axis2.engine.Phase.invoke(Phase.java:334)
	at org.apache.axis2.engine.AxisEngine.invoke(AxisEngine.java:251)
	at org.apache.axis2.engine.AxisEngine.receive(AxisEngine.java:160)
	at org.apache.sandesha2.workers.SenderWorker.checkForSyncResponses(SenderWorker.java:707)
	at org.apache.sandesha2.workers.SenderWorker.run(SenderWorker.java:410)
	at java.util.concurrent.ThreadPoolExecutor$Worker.runTask(Unknown Source)
	at java.util.concurrent.ThreadPoolExecutor$Worker.run(Unknown Source)
	at java.lang.Thread.run(Unknown Source)

Skimming through the console output, I found the following:

- XMLStreamReader is com.ctc.wstx.sr.ValidatingStreamReader
- org.apache.sandesha2.i18n.resource::handleGetObject(soapEnvNotSet)
- Sandesha2 Internal Error:  SOAP envelope is not set.
- Caught exception
org.apache.axis2.AxisFault: com.ctc.wstx.exc.WstxEOFException: Unexpected EOF in prolog
 at [row,col {unknown-source}]: [1,0]
	at org.apache.axis2.AxisFault.makeFault(AxisFault.java:430)
	at org.apache.axis2.transport.TransportUtils.createSOAPMessage(TransportUtils.java:118)
...
Caused by: org.apache.axiom.om.OMException: com.ctc.wstx.exc.WstxEOFException: Unexpected EOF in prolog
 at [row,col {unknown-source}]: [1,0]
	at org.apache.axiom.om.impl.builder.StAXOMBuilder.next(StAXOMBuilder.java:260)
	at org.apache.axiom.soap.impl.builder.StAXSOAPModelBuilder.getSOAPEnvelope(StAXSOAPModelBuilder.java:161)
...
Caused by: com.ctc.wstx.exc.WstxEOFException: Unexpected EOF in prolog
 at [row,col {unknown-source}]: [1,0]
	at com.ctc.wstx.sr.StreamScanner.throwUnexpectedEOF(StreamScanner.java:661)
...

[Ivan Krizsan]

Hi!
I guess you don't want to know that when using Metro, you just drop in some libraries and the client will use reliable messaging, without any additional coding.
Well, hopefully this information can help other people when about to chose web service stack.
Best wishes!

[Karl Beowulph]

Howdy,

Thanks Ivan, but the decision to use Axis2 comes from above me, so no changing that one.

After bit more investigation, it looks like the XML requests being sent to the JBoss AS are different.

JBossWS client request (works)

<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/' xmlns:wsrm11='http://docs.oasis-open.org/ws-rx/wsrm/200702'>
  <env:Header xmlns:wsa='http://www.w3.org/2005/08/addressing'>
    <wsa:To>http://127.0.0.1:8388/testRm/testRm</wsa:To>
    <wsa:ReplyTo><wsa:Address>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address></wsa:ReplyTo>
    <wsa:Action>http://docs.oasis-open.org/ws-rx/wsrm/200702/CreateSequence</wsa:Action>
    <wsa:MessageID>urn:uuid:81902a4b-3268-4859-a239-58f4c19911a0</wsa:MessageID>
  </env:Header>
  <env:Body>
    <wsrm11:CreateSequence xmlns:wsrm11='http://docs.oasis-open.org/ws-rx/wsrm/200702'>
      <wsrm11:AcksTo xmlns:wsrm11='http://docs.oasis-open.org/ws-rx/wsrm/200702'>
        <wsa:Address xmlns:wsa='http://www.w3.org/2005/08/addressing'>http://www.w3.org/2005/08/addressing/anonymous</wsa:Address>
      </wsrm11:AcksTo>
    </wsrm11:CreateSequence>
  </env:Body>
</env:Envelope>

Axis2 client request (does not work)

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">http://127.0.0.1:8388/testRm/testRm</wsa:To>
    <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:A79BF2AFCDFC8CC7721260814410102</wsa:MessageID>
    <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">http://docs.oasis-open.org/ws-rx/wsmc/200702/MakeConnection</wsa:Action>
  </soapenv:Header>
  <soapenv:Body>
    <wsmc:MakeConnection xmlns:wsmc="http://docs.oasis-open.org/ws-rx/wsmc/200702">
      <wsmc:Address>http://docs.oasis-open.org/ws-rx/wsmc/200702/anonymous?id=urn:uuid:A79BF2AFCDFC8CC7721260814371276</wsmc:Address>
    </wsmc:MakeConnection>
  </soapenv:Body>
</soapenv:Envelope>

So it looks like JBoss AS accepts CreateSequence, but not MakeConnection.

[Karl Beowulph]

Getting closer I think. I'm able to have Axis2 generate the following request:

<?xml version='1.0' encoding='UTF-8'?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header>
    <wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">http://127.0.0.1:8388/testRm/testRm</wsa:To>
    <wsa:ReplyTo xmlns:wsa="http://www.w3.org/2005/08/addressing">
      <wsa:Address>http://docs.oasis-open.org/ws-rx/wsmc/200702/anonymous?id=urn:uuid:91AAB28EFF7C4DC8561260822048122</wsa:Address>
    </wsa:ReplyTo>
    <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">urn:uuid:91AAB28EFF7C4DC8561260822048133</wsa:MessageID>
    <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">http://docs.oasis-open.org/ws-rx/wsrm/200702/CreateSequence</wsa:Action>
  </soapenv:Header>
  <soapenv:Body>
    <wsrm:CreateSequence xmlns:wsrm="http://docs.oasis-open.org/ws-rx/wsrm/200702">
      <wsrm:AcksTo>
        <wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">http://docs.oasis-open.org/ws-rx/wsmc/200702/anonymous?id=urn:uuid:91AAB28EFF7C4DC8561260822048122</wsa:Address>
      </wsrm:AcksTo>
      <wsrm:Offer>
        <wsrm:Identifier>urn:uuid:91AAB28EFF7C4DC8561260822048145</wsrm:Identifier>
        <wsrm:Endpoint>
          <wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">http://docs.oasis-open.org/ws-rx/wsmc/200702/anonymous?id=urn:uuid:91AAB28EFF7C4DC8561260822048122</wsa:Address>
        </wsrm:Endpoint>
      </wsrm:Offer>
    </wsrm:CreateSequence>
  </soapenv:Body>
</soapenv:Envelope>

And this almost works; if I change the replyTo address (through TCPMON) to "http://www.w3.org/2005/08/addressing/anonymous" instead of "http://docs.oasis-open.org/ws-rx/wsmc/200702/anonymous" I get a response instead of an error. Unfortunately, I can't figure out how to change the reply-to address within the code. I tried clientOptions.setReplyTo(new EndpointReference("http://www.w3.org/2005/08/addressing/anonymous"));, but that didn't change anything. Any ideas?

[Ivan Krizsan]

Hi!
I just want to say that even though I do not use Axis2, it is interesting to read about your progress and I appreciate you sharing this information.
Best wishes!

[Karl Beowulph]

Solved, more-or-less.

The problem was that the setReplyTo method actually was working, it was, however, being overriden by SandeshaUtil.java (starting at line 1108). This was corrected by disabling the anon URI.

Now the service/client actually works, but not perfectly. I get the right response, but for some reason, about 20% the time, a non-interruptive error is still thrown (I still get the result I want, but there are errors regardless).

package com.ws.test;

import java.rmi.RemoteException;

import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.ServiceClient;
import org.apache.axis2.context.ConfigurationContext;
import org.apache.axis2.context.ConfigurationContextFactory;
import org.apache.sandesha2.Sandesha2Constants;
import org.apache.sandesha2.SandeshaException;
import org.apache.sandesha2.client.SandeshaClient;
import org.apache.sandesha2.client.SandeshaClientConstants;
import org.apache.sandesha2.policy.SandeshaPolicyBean;
import org.apache.sandesha2.util.SandeshaUtil;
import org.junit.Test;

import com.ws.TestRmServiceStub;

public class TestRmClient {
	final static String OPT = "D:\\opt";
	final static String CLIENT_REPO = OPT+"\\axis2-1.5\\repository", 
		AXIS2_XML = OPT+"\\axis2-1.5\\conf\\axis2.xml";
	
	@Test
	public void testRmEcho() throws RemoteException, InterruptedException{
		ConfigurationContext configContext = ConfigurationContextFactory.createConfigurationContextFromFileSystem(CLIENT_REPO,AXIS2_XML);
		TestRmServiceStub stub = new TestRmServiceStub(configContext);

		// Enable WS-RM
		enableWsrm(stub._getServiceClient(), Sandesha2Constants.SPEC_VERSIONS.v1_1);

		// The message
		String echo = stub.echo("My Axis2 call");
		
		// Shutdown
		SandeshaClient.terminateSequence(stub._getServiceClient());
		
		System.out.println(echo);
	}

	private void enableWsrm(ServiceClient sc, String version) throws AxisFault {
		// Engage the modules
		sc.engageModule("addressing");
		sc.engageModule("sandesha2");
		
		// Set the RM version
		Options clientOptions = sc.getOptions();
		clientOptions.setProperty(SandeshaClientConstants.RM_SPEC_VERSION, version);
		
		// Change the default anonymous replyTo EPR to w3.org
		clientOptions.setReplyTo(new EndpointReference("http://www.w3.org/2005/08/addressing/anonymous"));
		
		// Prevent the replyTo from being overwritten
		SandeshaPolicyBean policy = SandeshaUtil.getPropertyBean(sc.getAxisConfiguration());
		policy.setEnableRMAnonURI(false);
	}
}

The error shown in the JBoss AS output:

11:40:06,084 ERROR [HandlerChainExecutor] Exception during handler processing
java.lang.IllegalStateException: RM handler was not able to find WS-RM message in the payload
        at org.jboss.ws.extensions.wsrm.jaxws.RMServerHandler.handleInbound(RMServerHandler.java:128)
...
        at java.lang.Thread.run(Thread.java:595)
11:40:06,094 ERROR [SOAPFaultHelperJAXWS] SOAP request exception
java.lang.IllegalStateException: RM handler was not able to find WS-RM message in the payload
        at org.jboss.ws.extensions.wsrm.jaxws.RMServerHandler.handleInbound(RMServerHandler.java:128)
...
        at java.lang.Thread.run(Thread.java:595)

With it working I'm content with leaving it as is. Ideally I'd like to figure out why JBoss is not able to process the original "http://docs.oasis-open.org" addressing URL and throwing the 20% WS-RM error, but I don't think I'm going to have the luxury of time to do so.

[Sathees sam]

HI Karl Beowulph

I appreciate you


sathees

[Karl Beowulph]

Thanks Sathees.

Now on to the next problem, figuring out how to allow Axis2/Sandesha2 to work with long ( > 10 seconds) operations. Once again, this is something that just works with JBossWS (which, regardless of ease-of-use, has its own gotchas).