| /* |
| * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.sun.xml.internal.ws.addressing; |
| |
| import com.sun.istack.internal.NotNull; |
| import com.sun.istack.internal.Nullable; |
| import com.sun.xml.internal.ws.addressing.model.ActionNotSupportedException; |
| import com.sun.xml.internal.ws.addressing.model.InvalidAddressingHeaderException; |
| import com.sun.xml.internal.ws.api.EndpointAddress; |
| import com.sun.xml.internal.ws.api.SOAPVersion; |
| import com.sun.xml.internal.ws.api.WSBinding; |
| import com.sun.xml.internal.ws.api.addressing.AddressingVersion; |
| import com.sun.xml.internal.ws.api.addressing.NonAnonymousResponseProcessor; |
| import com.sun.xml.internal.ws.api.addressing.WSEndpointReference; |
| import com.sun.xml.internal.ws.api.message.AddressingUtils; |
| import com.sun.xml.internal.ws.api.message.Message; |
| import com.sun.xml.internal.ws.api.message.MessageHeaders; |
| import com.sun.xml.internal.ws.api.message.Messages; |
| import com.sun.xml.internal.ws.api.message.Packet; |
| import com.sun.xml.internal.ws.api.model.wsdl.WSDLBoundOperation; |
| import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort; |
| import com.sun.xml.internal.ws.api.pipe.*; |
| import com.sun.xml.internal.ws.api.server.WSEndpoint; |
| import com.sun.xml.internal.ws.client.Stub; |
| import com.sun.xml.internal.ws.developer.JAXWSProperties; |
| import com.sun.xml.internal.ws.fault.SOAPFaultBuilder; |
| import com.sun.xml.internal.ws.message.FaultDetailHeader; |
| import com.sun.xml.internal.ws.resources.AddressingMessages; |
| |
| import javax.xml.soap.SOAPFault; |
| import javax.xml.ws.WebServiceException; |
| import java.net.URI; |
| import java.util.logging.Level; |
| import java.util.logging.Logger; |
| |
| /** |
| * Handles WS-Addressing for the server. |
| * |
| * @author Rama Pulavarthi |
| * @author Kohsuke Kawaguchi |
| * @author Arun Gupta |
| */ |
| public class WsaServerTube extends WsaTube { |
| private WSEndpoint endpoint; |
| // store the replyTo/faultTo of the message currently being processed. |
| // both will be set to non-null in processRequest |
| private WSEndpointReference replyTo; |
| private WSEndpointReference faultTo; |
| private boolean isAnonymousRequired = false; |
| // Used by subclasses to avoid this class closing the transport back |
| // channel based on the ReplyTo/FaultTo addrs being non-anonymous. False |
| // can be useful in cases where special back-channel handling is required. |
| protected boolean isEarlyBackchannelCloseAllowed = true; |
| |
| /** |
| * WSDLBoundOperation calculated on the Request payload. |
| * Used for determining ReplyTo or Fault Action for non-anonymous responses * |
| */ |
| private WSDLBoundOperation wbo; |
| public WsaServerTube(WSEndpoint endpoint, @NotNull WSDLPort wsdlPort, WSBinding binding, Tube next) { |
| super(wsdlPort, binding, next); |
| this.endpoint = endpoint; |
| } |
| |
| public WsaServerTube(WsaServerTube that, TubeCloner cloner) { |
| super(that, cloner); |
| endpoint = that.endpoint; |
| } |
| |
| @Override |
| public WsaServerTube copy(TubeCloner cloner) { |
| return new WsaServerTube(this, cloner); |
| } |
| |
| @Override |
| public @NotNull NextAction processRequest(Packet request) { |
| Message msg = request.getMessage(); |
| if (msg == null) { |
| return doInvoke(next,request); |
| } // hmm? |
| |
| // expose bunch of addressing related properties for advanced applications |
| request.addSatellite(new WsaPropertyBag(addressingVersion,soapVersion,request)); |
| |
| // Store request ReplyTo and FaultTo in requestPacket.invocationProperties |
| // so that they can be used after responsePacket is received. |
| // These properties are used if a fault is thrown from the subsequent Pipe/Tubes. |
| |
| MessageHeaders hl = request.getMessage().getHeaders(); |
| String msgId; |
| try { |
| replyTo = AddressingUtils.getReplyTo(hl, addressingVersion, soapVersion); |
| faultTo = AddressingUtils.getFaultTo(hl, addressingVersion, soapVersion); |
| msgId = AddressingUtils.getMessageID(hl, addressingVersion, soapVersion); |
| } catch (InvalidAddressingHeaderException e) { |
| |
| LOGGER.log(Level.WARNING, addressingVersion.getInvalidMapText()+", Problem header:" + e.getProblemHeader()+ ", Reason: "+ e.getSubsubcode(),e); |
| |
| // problematic header must be removed since it can fail during Fault message processing |
| hl.remove(e.getProblemHeader()); |
| |
| SOAPFault soapFault = helper.createInvalidAddressingHeaderFault(e, addressingVersion); |
| // WS-A fault processing for one-way methods |
| if ((wsdlPort!=null) && request.getMessage().isOneWay(wsdlPort)) { |
| Packet response = request.createServerResponse(null, wsdlPort, null, binding); |
| return doReturnWith(response); |
| } |
| |
| Message m = Messages.create(soapFault); |
| if (soapVersion == SOAPVersion.SOAP_11) { |
| FaultDetailHeader s11FaultDetailHeader = new FaultDetailHeader(addressingVersion, addressingVersion.problemHeaderQNameTag.getLocalPart(), e.getProblemHeader()); |
| m.getHeaders().add(s11FaultDetailHeader); |
| } |
| |
| Packet response = request.createServerResponse(m, wsdlPort, null, binding); |
| return doReturnWith(response); |
| } |
| |
| // defaulting |
| if (replyTo == null) { |
| replyTo = addressingVersion.anonymousEpr; |
| } |
| if (faultTo == null) { |
| faultTo = replyTo; |
| } |
| |
| // Save a copy into the packet such that we can save it with that |
| // packet if we're going to deliver the response at a later time |
| // (async from the request). |
| request.put(WsaPropertyBag.WSA_REPLYTO_FROM_REQUEST, replyTo); |
| request.put(WsaPropertyBag.WSA_FAULTTO_FROM_REQUEST, faultTo); |
| request.put(WsaPropertyBag.WSA_MSGID_FROM_REQUEST, msgId); |
| |
| wbo = getWSDLBoundOperation(request); |
| isAnonymousRequired = isAnonymousRequired(wbo); |
| |
| Packet p = validateInboundHeaders(request); |
| // if one-way message and WS-A header processing fault has occurred, |
| // then do no further processing |
| if (p.getMessage() == null) { |
| return doReturnWith(p); |
| } |
| |
| // if we find an error in addressing header, just turn around the direction here |
| if (p.getMessage().isFault()) { |
| // close the transportBackChannel if we know that |
| // we'll never use them |
| if (isEarlyBackchannelCloseAllowed && |
| !(isAnonymousRequired) && |
| !faultTo.isAnonymous() && request.transportBackChannel != null) { |
| request.transportBackChannel.close(); |
| } |
| return processResponse(p); |
| } |
| // close the transportBackChannel if we know that |
| // we'll never use them |
| if (isEarlyBackchannelCloseAllowed && |
| !(isAnonymousRequired) && |
| !replyTo.isAnonymous() && !faultTo.isAnonymous() && |
| request.transportBackChannel != null) { |
| request.transportBackChannel.close(); |
| } |
| return doInvoke(next,p); |
| } |
| |
| protected boolean isAnonymousRequired(@Nullable WSDLBoundOperation wbo) { |
| //this requirement can only be specified in W3C case, Override this in W3C case. |
| return false; |
| } |
| |
| protected void checkAnonymousSemantics(WSDLBoundOperation wbo, WSEndpointReference replyTo, WSEndpointReference faultTo) { |
| //this requirement can only be specified in W3C case, Override this in W3C case. |
| } |
| |
| @Override |
| public @NotNull NextAction processException(Throwable t) { |
| final Packet response = Fiber.current().getPacket(); |
| ThrowableContainerPropertySet tc = response.getSatellite(ThrowableContainerPropertySet.class); |
| if (tc == null) { |
| tc = new ThrowableContainerPropertySet(t); |
| response.addSatellite(tc); |
| } else if (t != tc.getThrowable()) { |
| // This is a pathological case where an exception happens after a previous exception. |
| // Make sure you report the latest one. |
| tc.setThrowable(t); |
| } |
| return processResponse(response.endpoint.createServiceResponseForException(tc, response, soapVersion, wsdlPort, |
| response.endpoint.getSEIModel(), |
| binding)); |
| } |
| |
| @Override |
| public @NotNull NextAction processResponse(Packet response) { |
| Message msg = response.getMessage(); |
| if (msg ==null) { |
| return doReturnWith(response); |
| } // one way message. Nothing to see here. Move on. |
| |
| String to = AddressingUtils.getTo(msg.getHeaders(), |
| addressingVersion, soapVersion); |
| if (to != null) { |
| replyTo = faultTo = new WSEndpointReference(to, addressingVersion); |
| } |
| |
| if (replyTo == null) { |
| // This is an async response or we're not processing the response in |
| // the same tube instance as we processed the request. Get the ReplyTo |
| // now, from the properties we stored into the request packet. We |
| // assume anyone that interrupted the request->response flow will have |
| // saved the ReplyTo and put it back into the packet for our use. |
| replyTo = (WSEndpointReference)response. |
| get(WsaPropertyBag.WSA_REPLYTO_FROM_REQUEST); |
| } |
| |
| if (faultTo == null) { |
| // This is an async response or we're not processing the response in |
| // the same tube instance as we processed the request. Get the FaultTo |
| // now, from the properties we stored into the request packet. We |
| // assume anyone that interrupted the request->response flow will have |
| // saved the FaultTo and put it back into the packet for our use. |
| faultTo = (WSEndpointReference)response. |
| get(WsaPropertyBag.WSA_FAULTTO_FROM_REQUEST); |
| } |
| |
| WSEndpointReference target = msg.isFault() ? faultTo : replyTo; |
| if (target == null && response.proxy instanceof Stub) { |
| target = ((Stub) response.proxy).getWSEndpointReference(); |
| } |
| if (target == null || target.isAnonymous() || isAnonymousRequired) { |
| return doReturnWith(response); |
| } |
| if (target.isNone()) { |
| // the caller doesn't want to hear about it, so proceed like one-way |
| response.setMessage(null); |
| return doReturnWith(response); |
| } |
| |
| if ((wsdlPort!=null) && response.getMessage().isOneWay(wsdlPort)) { |
| // one way message but with replyTo. I believe this is a hack for WS-TX - KK. |
| LOGGER.fine(AddressingMessages.NON_ANONYMOUS_RESPONSE_ONEWAY()); |
| return doReturnWith(response); |
| } |
| |
| // MTU: If we're not sending a response that corresponds to a WSDL op, |
| // then take whatever soapAction is set on the packet (as allowing |
| // helper.getOutputAction() will only result in a bogus 'unset' |
| // action value. |
| if (wbo != null || response.soapAction == null) { |
| String action = response.getMessage().isFault() ? |
| helper.getFaultAction(wbo, response) : |
| helper.getOutputAction(wbo); |
| //set the SOAPAction, as its got to be same as wsa:Action |
| if (response.soapAction == null || |
| (action != null && |
| !action.equals(AddressingVersion.UNSET_OUTPUT_ACTION))) { |
| response.soapAction = action; |
| } |
| } |
| response.expectReply = false; |
| |
| EndpointAddress adrs; |
| try { |
| adrs = new EndpointAddress(URI.create(target.getAddress())); |
| } catch (NullPointerException e) { |
| throw new WebServiceException(e); |
| } catch (IllegalArgumentException e) { |
| throw new WebServiceException(e); |
| } |
| |
| response.endpointAddress = adrs; |
| |
| if (response.isAdapterDeliversNonAnonymousResponse) { |
| return doReturnWith(response); |
| } |
| |
| return doReturnWith(NonAnonymousResponseProcessor.getDefault().process(response)); |
| } |
| |
| @Override |
| protected void validateAction(Packet packet) { |
| //There may not be a WSDL operation. There may not even be a WSDL. |
| //For instance this may be a RM CreateSequence message. |
| WSDLBoundOperation wsdlBoundOperation = getWSDLBoundOperation(packet); |
| |
| if (wsdlBoundOperation == null) { |
| return; |
| } |
| |
| String gotA = AddressingUtils.getAction( |
| packet.getMessage().getHeaders(), |
| addressingVersion, soapVersion); |
| |
| if (gotA == null) { |
| throw new WebServiceException(AddressingMessages.VALIDATION_SERVER_NULL_ACTION()); |
| } |
| |
| String expected = helper.getInputAction(packet); |
| String soapAction = helper.getSOAPAction(packet); |
| if (helper.isInputActionDefault(packet) && (soapAction != null && !soapAction.equals(""))) { |
| expected = soapAction; |
| } |
| |
| if (expected != null && !gotA.equals(expected)) { |
| throw new ActionNotSupportedException(gotA); |
| } |
| } |
| |
| @Override |
| protected void checkMessageAddressingProperties(Packet packet) { |
| super.checkMessageAddressingProperties(packet); |
| |
| // wsaw:Anonymous validation |
| WSDLBoundOperation wsdlBoundOperation = getWSDLBoundOperation(packet); |
| checkAnonymousSemantics(wsdlBoundOperation, replyTo, faultTo); |
| // check if addresses are valid |
| checkNonAnonymousAddresses(replyTo,faultTo); |
| } |
| |
| @SuppressWarnings("ResultOfObjectAllocationIgnored") |
| private void checkNonAnonymousAddresses(WSEndpointReference replyTo, WSEndpointReference faultTo) { |
| if (!replyTo.isAnonymous()) { |
| try { |
| new EndpointAddress(URI.create(replyTo.getAddress())); |
| } catch (Exception e) { |
| throw new InvalidAddressingHeaderException(addressingVersion.replyToTag, addressingVersion.invalidAddressTag); |
| } |
| } |
| //for now only validate ReplyTo |
| /* |
| if (!faultTo.isAnonymous()) { |
| try { |
| new EndpointAddress(URI.create(faultTo.getAddress())); |
| } catch (IllegalArgumentException e) { |
| throw new InvalidAddressingHeaderException(addressingVersion.faultToTag, addressingVersion.invalidAddressTag); |
| } |
| } |
| */ |
| |
| } |
| |
| /** |
| * @deprecated |
| * Use {@link JAXWSProperties#ADDRESSING_MESSAGEID}. |
| */ |
| public static final String REQUEST_MESSAGE_ID = "com.sun.xml.internal.ws.addressing.request.messageID"; |
| |
| private static final Logger LOGGER = Logger.getLogger(WsaServerTube.class.getName()); |
| } |
