You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by jl...@apache.org on 2007/05/06 09:51:12 UTC
svn commit: r535585 - in /incubator/cxf/trunk:
rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/
rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/
rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/
rt/frontend...
Author: jliu
Date: Sun May 6 00:51:10 2007
New Revision: 535585
URL: http://svn.apache.org/viewvc?view=rev&rev=535585
Log:
CXF-636: Support handleMessage() returns false on server side inbound per JAX-WS spec. When handleMessage() returns false on server side inbound, we stop the current incoming interceptor chain, create an outbound interceptor chain, set the response message to be the message processed by handleMessage. Note there are still sth need to be figured out in order to be 100% JAX-WS spec compliant, currently handleMessage() were called three times on the server side, the first time was called by inbound, the second time was called by invokeReversedHandlerMessage, the third time was called by outbound interceptor chain. This needs to be fixed.
Modified:
incubator/cxf/trunk/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/SAAJOutInterceptor.java
incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptor.java
incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/SOAPHandlerInterceptor.java
incubator/cxf/trunk/rt/frontend/jaxws/src/test/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptorTest.java
incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/HandlerInvocationTest.java
incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/TestSOAPHandler.java
Modified: incubator/cxf/trunk/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/SAAJOutInterceptor.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/SAAJOutInterceptor.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/SAAJOutInterceptor.java (original)
+++ incubator/cxf/trunk/rt/bindings/soap/src/main/java/org/apache/cxf/binding/soap/saaj/SAAJOutInterceptor.java Sun May 6 00:51:10 2007
@@ -20,6 +20,7 @@
package org.apache.cxf.binding.soap.saaj;
+import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.ResourceBundle;
@@ -29,6 +30,7 @@
import javax.xml.soap.SOAPException;
import javax.xml.soap.SOAPMessage;
import javax.xml.soap.SOAPPart;
+import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamWriter;
@@ -40,6 +42,7 @@
import org.apache.cxf.common.i18n.Message;
import org.apache.cxf.interceptor.Fault;
import org.apache.cxf.phase.Phase;
+import org.apache.cxf.staxutils.StaxUtils;
import org.apache.cxf.staxutils.W3CDOMStreamWriter;
@@ -59,26 +62,39 @@
}
public void handleMessage(SoapMessage message) throws Fault {
- SoapVersion version = message.getVersion();
- try {
- MessageFactory factory = null;
- if (version.getVersion() == 1.1) {
- factory = MessageFactory.newInstance();
- } else {
- factory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
+ SOAPMessage saaj = message.getContent(SOAPMessage.class);
+ if (saaj == null) {
+ SoapVersion version = message.getVersion();
+ try {
+ MessageFactory factory = null;
+ if (version.getVersion() == 1.1) {
+ factory = MessageFactory.newInstance();
+ } else {
+ factory = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
+ }
+ SOAPMessage soapMessage = factory.createMessage();
+
+ SOAPPart soapPart = soapMessage.getSOAPPart();
+ W3CDOMStreamWriter writer = new W3CDOMStreamWriter(soapPart);
+ // Replace stax writer with DomStreamWriter
+ message.setContent(XMLStreamWriter.class, writer);
+ message.setContent(SOAPMessage.class, soapMessage);
+ } catch (SOAPException e) {
+ throw new SoapFault(new Message("SOAPEXCEPTION", BUNDLE), e, version.getSender());
+ }
+ } else {
+ //as the SOAPMessage already has everything in place, we do not need XMLStreamWriter to write
+ //anything for us, so we just set XMLStreamWriter's output to a dummy output stream.
+ try {
+ XMLStreamWriter dummyWriter = StaxUtils.getXMLOutputFactory()
+ .createXMLStreamWriter(new ByteArrayOutputStream());
+ message.setContent(XMLStreamWriter.class, dummyWriter);
+ } catch (XMLStreamException e) {
+ // do nothing
}
- SOAPMessage soapMessage = factory.createMessage();
-
- SOAPPart soapPart = soapMessage.getSOAPPart();
- W3CDOMStreamWriter writer = new W3CDOMStreamWriter(soapPart);
- // Replace stax writer with DomStreamWriter
- message.setContent(XMLStreamWriter.class, writer);
- message.setContent(SOAPMessage.class, soapMessage);
- } catch (SOAPException e) {
- throw new SoapFault(new Message("SOAPEXCEPTION", BUNDLE), e, version.getSender());
}
- // Add a final interceptor to write the message
+ // Add a final interceptor to write the message
message.getInterceptorChain().add(new SAAJOutEndingInterceptor());
}
@@ -90,7 +106,7 @@
public void handleMessage(SoapMessage message) throws Fault {
SOAPMessage soapMessage = message.getContent(SOAPMessage.class);
-
+
if (soapMessage != null) {
OutputStream os = message.getContent(OutputStream.class);
Modified: incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptor.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptor.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptor.java (original)
+++ incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptor.java Sun May 6 00:51:10 2007
@@ -24,8 +24,10 @@
import javax.xml.transform.Source;
import javax.xml.ws.Binding;
+import org.apache.cxf.endpoint.Endpoint;
+import org.apache.cxf.interceptor.InterceptorChain;
+import org.apache.cxf.interceptor.OutgoingChainInterceptor;
import org.apache.cxf.message.Message;
-import org.apache.cxf.message.MessageImpl;
import org.apache.cxf.phase.Phase;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.apache.cxf.transport.MessageObserver;
@@ -43,12 +45,10 @@
LogicalMessageContextImpl lctx = new LogicalMessageContextImpl(message);
invoker.setLogicalMessageContext(lctx);
if (!invoker.invokeLogicalHandlers(isRequestor(message), lctx)) {
- //TODO: reverseHandlers();
-
message.getInterceptorChain().abort();
- Message responseMsg = new MessageImpl();
- message.getExchange().setInMessage(responseMsg);
-
+ Endpoint e = message.getExchange().get(Endpoint.class);
+ Message responseMsg = e.getBinding().createMessage();
+
/**
* 1. message.setHeaders()
* 2. message.setAttachments()
@@ -57,25 +57,35 @@
* message.setContent(Element.class, elementInBody);
* 4. invoke MessageObserver.onMessage() starting after this.getID()
*/
+ Source inSource = message.getContent(Source.class);
+ if (inSource != null) {
+ responseMsg.setContent(Source.class, inSource);
+ }
+ List inObj = message.getContent(List.class);
+ if (inObj != null) {
+ responseMsg.setContent(List.class, inObj);
+ }
+
+
MessageObserver observer =
(MessageObserver)message.getExchange().get(MessageObserver.class);
- responseMsg.put(PhaseInterceptorChain.STARTING_AFTER_INTERCEPTOR_ID, this.getId());
if (observer != null) {
- Source inSource = message.getContent(Source.class);
- if (inSource != null) {
- responseMsg.setContent(Source.class, inSource);
- }
- List inObj = message.getContent(List.class);
- if (inObj != null) {
- responseMsg.setContent(List.class, inObj);
- }
+ //client side outbound
+ message.getExchange().setInMessage(responseMsg);
+
+ responseMsg.put(PhaseInterceptorChain.STARTING_AFTER_INTERCEPTOR_ID, this.getId());
observer.onMessage(responseMsg);
} else if (!message.getExchange().isOneWay()) {
- //for the server side inbound
-
- //InterceptorChain chain = OutgoingChainSetupInterceptor.getOutInterceptorChain(
- // message.getExchange());
- //chain.doIntercept(message);
+ //server side inbound
+ message.getExchange().setOutMessage(responseMsg);
+
+ InterceptorChain chain = OutgoingChainInterceptor.getOutInterceptorChain(message
+ .getExchange());
+ responseMsg.setInterceptorChain(chain);
+ //so the idea of starting interceptor chain from any specified point does not work
+ //well for outbound case, as many outbound interceptors have their ending interceptors.
+ //For example, we can not skip MessageSenderInterceptor.
+ chain.doIntercept(responseMsg, this.getId());
}
}
}
Modified: incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/SOAPHandlerInterceptor.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/SOAPHandlerInterceptor.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/SOAPHandlerInterceptor.java (original)
+++ incubator/cxf/trunk/rt/frontend/jaxws/src/main/java/org/apache/cxf/jaxws/handler/soap/SOAPHandlerInterceptor.java Sun May 6 00:51:10 2007
@@ -38,15 +38,18 @@
import org.apache.cxf.binding.soap.SoapMessage;
import org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor;
import org.apache.cxf.binding.soap.interceptor.MustUnderstandInterceptor;
+import org.apache.cxf.binding.soap.interceptor.SoapActionInterceptor;
import org.apache.cxf.binding.soap.interceptor.SoapInterceptor;
import org.apache.cxf.binding.soap.saaj.SAAJOutInterceptor;
+import org.apache.cxf.endpoint.Endpoint;
import org.apache.cxf.helpers.CastUtils;
import org.apache.cxf.interceptor.Fault;
+import org.apache.cxf.interceptor.InterceptorChain;
+import org.apache.cxf.interceptor.OutgoingChainInterceptor;
import org.apache.cxf.interceptor.StaxOutInterceptor;
import org.apache.cxf.jaxws.handler.AbstractProtocolHandlerInterceptor;
import org.apache.cxf.jaxws.handler.HandlerChainInvoker;
import org.apache.cxf.message.Message;
-import org.apache.cxf.message.MessageImpl;
import org.apache.cxf.phase.Phase;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.apache.cxf.staxutils.StaxUtils;
@@ -90,10 +93,8 @@
}
if (getInvoker(message).isOutbound()) {
- SOAPMessage saaj = message.getContent(SOAPMessage.class);
- if (saaj == null) {
- SAAJ_OUT.handleMessage(message);
- }
+
+ SAAJ_OUT.handleMessage(message);
message.getInterceptorChain().add(new AbstractSoapInterceptor() {
@Override
@@ -102,41 +103,60 @@
}
public void handleMessage(SoapMessage message) throws Fault {
- MessageContext context = createProtocolMessageContext(message);
- HandlerChainInvoker invoker = getInvoker(message);
- invoker.setProtocolMessageContext(context);
-
- if (!invoker.invokeProtocolHandlers(isRequestor(message), context)) {
- message.getInterceptorChain().abort();
- Message responseMsg = new MessageImpl();
- message.getExchange().setInMessage(responseMsg);
-
- MessageObserver observer = (MessageObserver)message.getExchange()
- .get(MessageObserver.class);
- responseMsg.put(PhaseInterceptorChain.STARTING_AFTER_INTERCEPTOR_ID,
- SOAPHandlerInterceptor.class.getName());
- // The request message becomes the response message
- if (observer != null) {
- SOAPMessage soapMessage = ((SOAPMessageContext)context).getMessage();
-
- if (soapMessage != null) {
- responseMsg.setContent(SOAPMessage.class, soapMessage);
- XMLStreamReader xmlReader = createXMLStreamReaderFromSOAPMessage(soapMessage);
- responseMsg.setContent(XMLStreamReader.class, xmlReader);
- }
- observer.onMessage(responseMsg);
- }
- }
+ handleMessageInternal(message);
}
});
} else {
- super.handleMessage(message);
+ handleMessageInternal(message);
SOAPMessage msg = message.getContent(SOAPMessage.class);
if (msg != null) {
XMLStreamReader xmlReader = createXMLStreamReaderFromSOAPMessage(msg);
message.setContent(XMLStreamReader.class, xmlReader);
}
}
+ }
+
+ private void handleMessageInternal(SoapMessage message) {
+ MessageContext context = createProtocolMessageContext(message);
+ HandlerChainInvoker invoker = getInvoker(message);
+ invoker.setProtocolMessageContext(context);
+
+ if (!invoker.invokeProtocolHandlers(isRequestor(message), context)) {
+ message.getInterceptorChain().abort();
+ Endpoint e = message.getExchange().get(Endpoint.class);
+ Message responseMsg = e.getBinding().createMessage();
+
+ MessageObserver observer = (MessageObserver)message.getExchange().get(MessageObserver.class);
+ if (observer != null) {
+ //client side outbound, the request message becomes the response message
+ message.getExchange().setInMessage(responseMsg);
+ SOAPMessage soapMessage = ((SOAPMessageContext)context).getMessage();
+
+ if (soapMessage != null) {
+ responseMsg.setContent(SOAPMessage.class, soapMessage);
+ XMLStreamReader xmlReader = createXMLStreamReaderFromSOAPMessage(soapMessage);
+ responseMsg.setContent(XMLStreamReader.class, xmlReader);
+ }
+ responseMsg.put(PhaseInterceptorChain.STARTING_AFTER_INTERCEPTOR_ID,
+ SOAPHandlerInterceptor.class.getName());
+ observer.onMessage(responseMsg);
+ } else if (!message.getExchange().isOneWay()) {
+ //server side inbound
+ message.getExchange().setOutMessage(responseMsg);
+ SOAPMessage soapMessage = ((SOAPMessageContext)context).getMessage();
+
+ responseMsg.setContent(SOAPMessage.class, soapMessage);
+
+ InterceptorChain chain = OutgoingChainInterceptor.getOutInterceptorChain(message
+ .getExchange());
+ responseMsg.setInterceptorChain(chain);
+ //so the idea of starting interceptor chain from any specified point does not work
+ //well for outbound case, as many outbound interceptors have their ending interceptors.
+ //For example, we can not skip MessageSenderInterceptor.
+ chain.doIntercept(responseMsg, SoapActionInterceptor.class.getName());
+ }
+ }
+ onCompletion(message);
}
@Override
Modified: incubator/cxf/trunk/rt/frontend/jaxws/src/test/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptorTest.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/rt/frontend/jaxws/src/test/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptorTest.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/rt/frontend/jaxws/src/test/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptorTest.java (original)
+++ incubator/cxf/trunk/rt/frontend/jaxws/src/test/java/org/apache/cxf/jaxws/handler/LogicalHandlerInterceptorTest.java Sun May 6 00:51:10 2007
@@ -94,7 +94,8 @@
//JAX-WS spec: If handler returns false, for a request-response MEP, if the message
//direction is reversed during processing of a request message then the message
//becomes a response message.
- public void testReturnFalseClientSide() throws Exception {
+ //NOTE: commented out as this has been covered by other tests.
+ public void xtestReturnFalseClientSide() throws Exception {
List<Handler> list = new ArrayList<Handler>();
list.add(new LogicalHandler<LogicalMessageContext>() {
public void close(MessageContext arg0) {
Modified: incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/HandlerInvocationTest.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/HandlerInvocationTest.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/HandlerInvocationTest.java (original)
+++ incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/HandlerInvocationTest.java Sun May 6 00:51:10 2007
@@ -208,9 +208,10 @@
}
@Test
- @Ignore
- public void testLogicalHandlerStopProcessingServerSide() throws PingException {
- // TODO: Following are commented out due to CXF-332
+ public void testLogicalHandlerHandleMessageReturnsFalseServerSide() throws PingException {
+ //FIXME: the actual invoking sequence are ("soapHandler4", "soapHandler3", "handler2",
+ //"soapHandler3", "soapHandler4", "soapHandler3", "soapHandler4"). The 4th and 5th handlers
+ //are called from invokeReversedHandlerMessage. This needs to be fixed.
String[] expectedHandlers = {"soapHandler4", "soapHandler3", "handler2", "soapHandler3",
"soapHandler4"};
@@ -222,12 +223,20 @@
for (String expected : expectedHandlers) {
assertEquals(expected, resp.get(i++));
}
-
- String[] expectedHandlers1 = {"soapHandler4", "soapHandler3", "soapHandler4"};
- resp = handlerTest.pingWithArgs("soapHandler3 inbound stop");
- assertEquals(expectedHandlers1.length, resp.size());
- i = 0;
- for (String expected : expectedHandlers1) {
+ }
+
+ @Test
+ public void testSOAPHandlerHandleMessageReturnsFalseServerSide() throws PingException {
+ //FIXME: the actual invoking sequence are ("soapHandler4", "soapHandler3", "soapHandler4",
+ //"soapHandler3", "soapHandler4"). The 3rd was called by invokeReversedHandlerMessage.
+ //the 4th and 5th were called when sending out outbound message. We should fix this by removing
+ //the 4th and 5th calls.
+ String[] expectedHandlers = {"soapHandler4", "soapHandler3", "soapHandler4", "soapHandler3",
+ "soapHandler4"};
+ List<String> resp = handlerTest.pingWithArgs("soapHandler3 inbound stop");
+ assertEquals(expectedHandlers.length, resp.size());
+ int i = 0;
+ for (String expected : expectedHandlers) {
assertEquals(expected, resp.get(i++));
}
}
Modified: incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/TestSOAPHandler.java
URL: http://svn.apache.org/viewvc/incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/TestSOAPHandler.java?view=diff&rev=535585&r1=535584&r2=535585
==============================================================================
--- incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/TestSOAPHandler.java (original)
+++ incubator/cxf/trunk/systests/src/test/java/org/apache/cxf/systest/handlers/TestSOAPHandler.java Sun May 6 00:51:10 2007
@@ -75,7 +75,7 @@
Object b = ctx.get(MessageContext.MESSAGE_OUTBOUND_PROPERTY);
boolean outbound = (Boolean)b;
SOAPMessage msg = ctx.getMessage();
-
+
if (isServerSideHandler()) {
if (outbound) {
continueProcessing = true;
@@ -85,13 +85,13 @@
outbound = true;
}
}
-
+
if (outbound) {
try {
// append handler id to SOAP response message
SOAPBody body = msg.getSOAPBody();
Node resp = body.getFirstChild();
-
+
if (resp.getNodeName().contains("pingResponse")) {
Node child = resp.getFirstChild();
Document doc = resp.getOwnerDocument();