From 045bcb9ff57dab5c20786414e962adcae86f462f Mon Sep 17 00:00:00 2001 From: edwardsmj Date: Sun, 11 Jul 2010 10:07:43 +0000 Subject: Changes to binding-ws-runtime-axis2 in support of Client-side and Server-side asynchronous services and @asyncInvocation as described in TUSCANY-3608, 3611 & 3612 git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@963032 13f79535-47bb-0310-9956-ffa450edef68 --- .../provider/Axis2ReferenceBindingInvoker.java | 49 ++++++++-- .../Axis2ServiceInOutSyncMessageReceiver.java | 7 +- .../ws/axis2/provider/TuscanyServiceProvider.java | 101 +++++++++++++++------ 3 files changed, 116 insertions(+), 41 deletions(-) (limited to 'sca-java-2.x/trunk') diff --git a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ReferenceBindingInvoker.java b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ReferenceBindingInvoker.java index 1532aa6a65..32f6ee9ca5 100644 --- a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ReferenceBindingInvoker.java +++ b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ReferenceBindingInvoker.java @@ -68,16 +68,16 @@ import org.oasisopen.sca.ServiceRuntimeException; */ public class Axis2ReferenceBindingInvoker implements Invoker { public static final QName QNAME_WSA_FROM = - new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_FROM, AddressingConstants.WSA_DEFAULT_PREFIX); - + new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_FROM, AddressingConstants.WSA_DEFAULT_PREFIX); public static final QName QNAME_WSA_TO = new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_TO, AddressingConstants.WSA_DEFAULT_PREFIX); - public static final QName QNAME_WSA_ACTION = new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_ACTION, AddressingConstants.WSA_DEFAULT_PREFIX); - public static final QName QNAME_WSA_RELATESTO = - new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_RELATES_TO, AddressingConstants.WSA_DEFAULT_PREFIX); + new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_RELATES_TO, AddressingConstants.WSA_DEFAULT_PREFIX); + public static final QName QNAME_WSA_MESSAGEID = + new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_MESSAGE_ID, AddressingConstants.WSA_DEFAULT_PREFIX); + private RuntimeEndpointReference endpointReference; private ServiceClient serviceClient; @@ -215,15 +215,14 @@ public class Axis2ReferenceBindingInvoker implements Invoker { SOAPEnvelope sev = requestMC.getEnvelope(); SOAPHeader sh = sev.getHeader(); - // add WS-Addressing header for the invocation of a bidirectional service - //FIXME: is there any way to use the Axis2 addressing support for this? + // Add WS-Addressing header for the invocation of a bidirectional service if (callbackEndpoint != null) { // Load the actual callback endpoint URI into an Axis EPR ready to form the content of the wsa:From header EndpointReference fromEPR = new EndpointReference(callbackEndpoint.getBinding().getURI()); addWSAFromHeader( sh, fromEPR ); - addWSAActionHeader( sh ); + addWSAMessageIDHeader( sh, (String)msg.getHeaders().get("MESSAGE_ID")); requestMC.setFrom(fromEPR); } // end if @@ -231,14 +230,14 @@ public class Axis2ReferenceBindingInvoker implements Invoker { String toAddress = getToAddress( msg ); requestMC.setTo( new EndpointReference(toAddress) ); + // For callback references, add wsa:To, wsa:Action and wsa:RelatesTo headers if( isInvocationForCallback( msg ) ) { addWSAToHeader( sh, toAddress, msg ); addWSAActionHeader( sh ); addWSARelatesTo( sh, msg ); } // end if - // Allow privileged access to read properties. Requires PropertiesPermission read in - // security policy. + // Allow privileged access to read properties. Requires PropertiesPermission read in security policy. try { AccessController.doPrivileged(new PrivilegedExceptionAction() { public Object run() throws AxisFault { @@ -271,6 +270,12 @@ public class Axis2ReferenceBindingInvoker implements Invoker { return address; } // end method getToAddress + /** + * Add wsa:From SOAP header to the message + * @param sh - the SOAP header for the message + * @param fromEPR - the (Axis2) EPR to include in the wsa:From + * @throws AxisFault - if an error occurs setting the wsa:From into the header + */ private void addWSAFromHeader( SOAPHeader sh, EndpointReference fromEPR ) throws AxisFault { OMElement epr = EndpointReferenceHelper.toOM(sh.getOMFactory(), fromEPR, @@ -280,13 +285,37 @@ public class Axis2ReferenceBindingInvoker implements Invoker { } // end method addWSAFromHeader + /** + * Add wsa:MessageID SOAP header to the message + * @param sh - the SOAP header for the message + * @param msgID - the message ID + * @throws AxisFault - if an error occurs setting the wsa:From into the header + */ + private void addWSAMessageIDHeader( SOAPHeader sh, String msgID ) throws AxisFault { + OMElement idHeader = sh.getOMFactory().createOMElement(QNAME_WSA_MESSAGEID); + idHeader.setText( msgID ); + + sh.addChild(idHeader); + + } // end method addWSAMessageIDHeader + private static String WS_REF_PARMS = "WS_REFERENCE_PARAMETERS"; + /** + * Add wsa:To SOAP header to the message - also handles ReferenceParameters, if present + * @param sh - the SOAP header for the message + * @param address - the address to use + * @param msg - the Tuscany message + */ private void addWSAToHeader( SOAPHeader sh, String address, Message msg ) { + if( address == null ) return; + // Create wsa:To header which is required by ws-addressing spec OMElement wsaToOM = sh.getOMFactory().createOMElement(QNAME_WSA_TO); wsaToOM.setText( address ); sh.addChild(wsaToOM); + if( msg == null ) return; + // Deal with Reference Parameters, if present - copy to the header without the wsa:ReferenceParameters wrapper OMElement refParms = (OMElement) msg.getHeaders().get(WS_REF_PARMS); if( refParms != null ) { diff --git a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ServiceInOutSyncMessageReceiver.java b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ServiceInOutSyncMessageReceiver.java index 72447b1e9a..d6694c9f7d 100644 --- a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ServiceInOutSyncMessageReceiver.java +++ b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/Axis2ServiceInOutSyncMessageReceiver.java @@ -71,7 +71,12 @@ public class Axis2ServiceInOutSyncMessageReceiver extends AbstractInOutSyncMessa logger.log(Level.SEVERE, e.getMessage(), t); throw new ServiceRuntimeException(e); } catch (Throwable e) { - logger.log(Level.SEVERE, e.getMessage(), e); + if( "AsyncResponse".equals(e.getMessage()) ) { + // Do nothing for an async response exception - it is a signal that the service has been + // invoked asynchronously + } else { + logger.log(Level.SEVERE, e.getMessage(), e); + } // end if throw AxisFault.makeFault(e); } } diff --git a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/TuscanyServiceProvider.java b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/TuscanyServiceProvider.java index 59645ef679..ba23e80d88 100644 --- a/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/TuscanyServiceProvider.java +++ b/sca-java-2.x/trunk/modules/binding-ws-runtime-axis2/src/main/java/org/apache/tuscany/sca/binding/ws/axis2/provider/TuscanyServiceProvider.java @@ -65,6 +65,8 @@ public class TuscanyServiceProvider { new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.EPR_REFERENCE_PARAMETERS); public static final QName QNAME_WSA_MESSAGEID = new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_MESSAGE_ID); + public static final QName QNAME_WSA_RELATESTO = + new QName(AddressingConstants.Final.WSA_NAMESPACE, AddressingConstants.WSA_RELATES_TO, AddressingConstants.WSA_DEFAULT_PREFIX); private RuntimeEndpoint endpoint; private WebServiceBinding wsBinding; @@ -106,7 +108,6 @@ public class TuscanyServiceProvider { public OMElement invoke(OMElement requestOM, MessageContext inMC) throws InvocationTargetException, AxisFault { String callbackAddress = null; - String callbackID = null; // create a message object and set the args as its body Message msg = messageFactory.createMessage(); @@ -140,35 +141,16 @@ public class TuscanyServiceProvider { throw new ServiceRuntimeException("Unrecognized WSDL style for endpoint " + endpoint); } - //FIXME: can we use the Axis2 addressing support for this? SOAPHeader header = inMC.getEnvelope().getHeader(); if (header != null) { - callbackAddress = handleCallbackAddress( header, msg ); - // Retrieve other callback-related headers + // Retrieve callback-related headers + callbackAddress = handleCallbackAddress( header, msg ); handleMessageIDHeader( header, msg ); + handleRelatesToHeader( header, msg ); } // end if - // Create a from EPR to hold the details of the callback endpoint - EndpointReference from = null; - if (callbackAddress != null ) { - // Check for special (& not allowed!) WS_Addressing values - checkCallbackAddress( callbackAddress, inMC ); - // - from = assemblyFactory.createEndpointReference(); - Endpoint fromEndpoint = assemblyFactory.createEndpoint(); - from.setTargetEndpoint(fromEndpoint); - from.setStatus(EndpointReference.Status.WIRED_TARGET_FOUND_AND_MATCHED); - msg.setFrom(from); - Endpoint callbackEndpoint = assemblyFactory.createEndpoint(); - // - WebServiceBinding cbBinding = webServiceBindingFactory.createWebServiceBinding(); - cbBinding.setURI(callbackAddress); - callbackEndpoint.setBinding(cbBinding); - // - callbackEndpoint.setURI(callbackAddress); - callbackEndpoint.setUnresolved(true); - from.setCallbackEndpoint(callbackEndpoint); - } + // Create a from EPR to hold the details of the callback endpoint, if any + createCallbackEPR( callbackAddress, inMC, msg ); Message response = endpoint.invoke(msg); @@ -215,20 +197,63 @@ public class TuscanyServiceProvider { return responseOM; } // end method - + + /** + * If there is a callback address, create an EPR for the callback with a referenced endpoint that contains + * the binding and the target callback address + * @param callbackAddress - the callback address - may be null + * @param inMC - the Axis incoming message context + * @param msg - the Tuscany message + * @throws AxisFault - if the callback address has any of the disallowed forms of callback address + */ + private void createCallbackEPR( String callbackAddress, MessageContext inMC, Message msg ) throws AxisFault { + if (callbackAddress != null ) { + // Check for special (& not allowed!) WS_Addressing values + checkCallbackAddress( callbackAddress, inMC ); + // + EndpointReference from = assemblyFactory.createEndpointReference(); + Endpoint fromEndpoint = assemblyFactory.createEndpoint(); + from.setTargetEndpoint(fromEndpoint); + from.setStatus(EndpointReference.Status.WIRED_TARGET_FOUND_AND_MATCHED); + msg.setFrom(from); + Endpoint callbackEndpoint = assemblyFactory.createEndpoint(); + // + WebServiceBinding cbBinding = webServiceBindingFactory.createWebServiceBinding(); + cbBinding.setURI(callbackAddress); + callbackEndpoint.setBinding(cbBinding); + // + callbackEndpoint.setURI(callbackAddress); + callbackEndpoint.setUnresolved(true); + from.setCallbackEndpoint(callbackEndpoint); + } // end if + } // end method createCallbackEPR + private static String WS_REF_PARMS = "WS_REFERENCE_PARAMETERS"; + /** + * Deal with any Callback address contained in the SOAP headers of the received message + * The callback address is contained in one of two headers (in the priority order stated by the SCA Web Service Binding spec): + * - wsa:From + * - wsa:ReplyTo + * Either of these headers should then contain a wsa:Address element containing the callback address + * A callback address may also be accompanied by wsa:ReferenceParameters + * - if present, ReferenceParameters must be read, stored unchanged and then sent in the header of any message sent to the + * callback address, as stated in the WSW-Addressing specification + * Any ReferenceParameters are stored into the headers of the Tuscany message under the key "WS_REFERENCE_PARAMETERS" + * @param header - the SOAP header for the message + * @param msg - the Tuscany message data structure + * @return - the callback address, as a String - null if no callback address is found + */ private String handleCallbackAddress( SOAPHeader header, Message msg ) { String callbackAddress = null; + // See if there is a wsa:From element - if not search for a wsa:ReplyTo element OMElement from = header.getFirstChildWithName(QNAME_WSA_FROM); if( from == null ) from = header.getFirstChildWithName(QNAME_WSA_REPLYTO); if (from != null) { OMElement callbackAddrElement = from.getFirstChildWithName(QNAME_WSA_ADDRESS); if (callbackAddrElement != null) { - if (endpoint.getService().getInterfaceContract().getCallbackInterface() != null) { - callbackAddress = callbackAddrElement.getText(); - } + callbackAddress = callbackAddrElement.getText(); OMElement refParms = from.getFirstChildWithName(QNAME_WSA_REFERENCE_PARAMETERS); if( refParms != null ) msg.getHeaders().put(WS_REF_PARMS, refParms); } @@ -252,4 +277,20 @@ public class TuscanyServiceProvider { msg.getHeaders().put(WS_MESSAGE_ID, idValue); } // end if } // end method handleMessageID -} + + private static String WS_RELATES_TO = "WS_RELATES_TO"; + /** + * Handle a SOAP wsa:RelatesTo header - place the contents into the Tuscany message for use by any callback + * @param header - the SOAP Headers + * @param msg - the Tuscany Message + */ + private void handleRelatesToHeader( SOAPHeader header, Message msg ) { + if( header == null ) return; + OMElement messageID = header.getFirstChildWithName(QNAME_WSA_RELATESTO); + if (messageID != null) { + String idValue = messageID.getText(); + // Store the value of the message ID element into the message under "WS_MESSAGE_ID"... + msg.getHeaders().put(WS_MESSAGE_ID, idValue); + } // end if + } // end method handleMessageID +} // end class AsyncResponseHandler -- cgit v1.2.3