aoqi@0: /*
aoqi@0:  * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.xml.internal.ws.addressing;
aoqi@0: 
aoqi@0: import com.sun.xml.internal.ws.addressing.model.InvalidAddressingHeaderException;
aoqi@0: import com.sun.xml.internal.ws.addressing.model.MissingAddressingHeaderException;
aoqi@0: import com.sun.xml.internal.ws.api.SOAPVersion;
aoqi@0: import com.sun.xml.internal.ws.api.WSBinding;
aoqi@0: import com.sun.xml.internal.ws.api.addressing.AddressingVersion;
aoqi@0: import com.sun.xml.internal.ws.api.message.AddressingUtils;
aoqi@0: import com.sun.xml.internal.ws.api.message.Packet;
aoqi@0: import com.sun.xml.internal.ws.api.model.wsdl.WSDLBoundOperation;
aoqi@0: import com.sun.xml.internal.ws.api.model.wsdl.WSDLFault;
aoqi@0: import com.sun.xml.internal.ws.api.model.wsdl.WSDLOperation;
aoqi@0: import com.sun.xml.internal.ws.api.model.wsdl.WSDLOutput;
aoqi@0: import com.sun.xml.internal.ws.api.model.wsdl.WSDLPort;
aoqi@0: import com.sun.xml.internal.ws.api.model.SEIModel;
aoqi@0: import com.sun.xml.internal.ws.api.model.JavaMethod;
aoqi@0: import com.sun.xml.internal.ws.api.model.WSDLOperationMapping;
aoqi@0: import com.sun.xml.internal.ws.model.JavaMethodImpl;
aoqi@0: import com.sun.xml.internal.ws.model.CheckedExceptionImpl;
aoqi@0: import com.sun.istack.internal.Nullable;
aoqi@0: import org.w3c.dom.Element;
aoqi@0: 
aoqi@0: import javax.xml.namespace.QName;
aoqi@0: import javax.xml.soap.Detail;
aoqi@0: import javax.xml.soap.SOAPConstants;
aoqi@0: import javax.xml.soap.SOAPException;
aoqi@0: import javax.xml.soap.SOAPFactory;
aoqi@0: import javax.xml.soap.SOAPFault;
aoqi@0: import javax.xml.soap.SOAPMessage;
aoqi@0: import javax.xml.ws.WebServiceException;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * @author Rama Pulavarthi
aoqi@0:  * @author Arun Gupta
aoqi@0:  */
aoqi@0: public abstract class WsaTubeHelper {
aoqi@0: 
aoqi@0:     public WsaTubeHelper(WSBinding binding, SEIModel seiModel, WSDLPort wsdlPort) {
aoqi@0:         this.binding = binding;
aoqi@0:         this.wsdlPort = wsdlPort;
aoqi@0:         this.seiModel = seiModel;
aoqi@0:         this.soapVer = binding.getSOAPVersion();
aoqi@0:         this.addVer = binding.getAddressingVersion();
aoqi@0: 
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getFaultAction(Packet requestPacket, Packet responsePacket) {
aoqi@0:         String action = null;
aoqi@0:         if(seiModel != null) {
aoqi@0:             action = getFaultActionFromSEIModel(requestPacket,responsePacket);
aoqi@0:         }
aoqi@0:         if (action != null) {
aoqi@0:             return action;
aoqi@0:         } else {
aoqi@0:             action = addVer.getDefaultFaultAction();
aoqi@0:         }
aoqi@0:         if (wsdlPort != null) {
aoqi@0:             WSDLOperationMapping wsdlOp = requestPacket.getWSDLOperationMapping();
aoqi@0:             if (wsdlOp != null) {
aoqi@0:                 WSDLBoundOperation wbo = wsdlOp.getWSDLBoundOperation();
aoqi@0:                 return getFaultAction(wbo, responsePacket);
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     String getFaultActionFromSEIModel(Packet requestPacket, Packet responsePacket) {
aoqi@0:         String action = null;
aoqi@0:         if (seiModel == null || wsdlPort == null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         try {
aoqi@0:             SOAPMessage sm = responsePacket.getMessage().copy().readAsSOAPMessage();
aoqi@0:             if (sm == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (sm.getSOAPBody() == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (sm.getSOAPBody().getFault() == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             Detail detail = sm.getSOAPBody().getFault().getDetail();
aoqi@0:             if (detail == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             String ns = detail.getFirstChild().getNamespaceURI();
aoqi@0:             String name = detail.getFirstChild().getLocalName();
aoqi@0: 
aoqi@0:             WSDLOperationMapping wsdlOp = requestPacket.getWSDLOperationMapping();
aoqi@0:             JavaMethodImpl jm = (wsdlOp != null) ? (JavaMethodImpl)wsdlOp.getJavaMethod() : null;
aoqi@0:             if (jm != null) {
aoqi@0:               for (CheckedExceptionImpl ce : jm.getCheckedExceptions()) {
aoqi@0:                   if (ce.getDetailType().tagName.getLocalPart().equals(name) &&
aoqi@0:                           ce.getDetailType().tagName.getNamespaceURI().equals(ns)) {
aoqi@0:                       return ce.getFaultAction();
aoqi@0:                   }
aoqi@0:               }
aoqi@0:             }
aoqi@0:             return action;
aoqi@0:         } catch (SOAPException e) {
aoqi@0:             throw new WebServiceException(e);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     String getFaultAction(@Nullable WSDLBoundOperation wbo, Packet responsePacket) {
aoqi@0:         String action = AddressingUtils.getAction(responsePacket.getMessage().getHeaders(), addVer, soapVer);
aoqi@0:         if (action != null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         action = addVer.getDefaultFaultAction();
aoqi@0:         if (wbo == null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         try {
aoqi@0:             SOAPMessage sm = responsePacket.getMessage().copy().readAsSOAPMessage();
aoqi@0:             if (sm == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (sm.getSOAPBody() == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             if (sm.getSOAPBody().getFault() == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             Detail detail = sm.getSOAPBody().getFault().getDetail();
aoqi@0:             if (detail == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             String ns = detail.getFirstChild().getNamespaceURI();
aoqi@0:             String name = detail.getFirstChild().getLocalName();
aoqi@0: 
aoqi@0:             WSDLOperation o = wbo.getOperation();
aoqi@0: 
aoqi@0:             WSDLFault fault = o.getFault(new QName(ns, name));
aoqi@0:             if (fault == null) {
aoqi@0:                 return action;
aoqi@0:             }
aoqi@0: 
aoqi@0:             action = fault.getAction();
aoqi@0: 
aoqi@0:             return action;
aoqi@0:         } catch (SOAPException e) {
aoqi@0:             throw new WebServiceException(e);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getInputAction(Packet packet) {
aoqi@0:         String action = null;
aoqi@0: 
aoqi@0:         if (wsdlPort != null) {
aoqi@0:             WSDLOperationMapping wsdlOp = packet.getWSDLOperationMapping();
aoqi@0:             if (wsdlOp != null) {
aoqi@0:                 WSDLBoundOperation wbo = wsdlOp.getWSDLBoundOperation();
aoqi@0:                 WSDLOperation op = wbo.getOperation();
aoqi@0:                 action = op.getInput().getAction();
aoqi@0:             }
aoqi@0:         }
aoqi@0: 
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * This method gives the Input addressing Action for a message.
aoqi@0:      * It gives the Action set in the wsdl operation for the corresponding payload.
aoqi@0:      * If it is not explicitly set, it gives the soapAction
aoqi@0:      * @param packet
aoqi@0:      * @return input Action
aoqi@0:      */
aoqi@0:     public String getEffectiveInputAction(Packet packet) {
aoqi@0:         //non-default SOAPAction beomes wsa:action
aoqi@0:         if(packet.soapAction != null && !packet.soapAction.equals("")) {
aoqi@0:             return packet.soapAction;
aoqi@0:         }
aoqi@0:         String action;
aoqi@0: 
aoqi@0:         if (wsdlPort != null) {
aoqi@0:             WSDLOperationMapping wsdlOp = packet.getWSDLOperationMapping();
aoqi@0:             if (wsdlOp != null) {
aoqi@0:                 WSDLBoundOperation wbo = wsdlOp.getWSDLBoundOperation();
aoqi@0:                 WSDLOperation op = wbo.getOperation();
aoqi@0:                 action = op.getInput().getAction();
aoqi@0:             } else {
aoqi@0:                 action = packet.soapAction;
aoqi@0:             }
aoqi@0:         } else {
aoqi@0:             action = packet.soapAction;
aoqi@0:         }
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public boolean isInputActionDefault(Packet packet) {
aoqi@0:         if (wsdlPort == null) {
aoqi@0:             return false;
aoqi@0:         }
aoqi@0:         WSDLOperationMapping wsdlOp = packet.getWSDLOperationMapping();
aoqi@0:         if(wsdlOp == null) {
aoqi@0:             return false;
aoqi@0:         }
aoqi@0:         WSDLBoundOperation wbo = wsdlOp.getWSDLBoundOperation();
aoqi@0:         WSDLOperation op = wbo.getOperation();
aoqi@0:         return op.getInput().isDefaultAction();
aoqi@0: 
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getSOAPAction(Packet packet) {
aoqi@0:         String action = "";
aoqi@0: 
aoqi@0:         if (packet == null || packet.getMessage() == null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         if (wsdlPort == null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         WSDLOperationMapping wsdlOp = packet.getWSDLOperationMapping();
aoqi@0:         if (wsdlOp == null) {
aoqi@0:             return action;
aoqi@0:         }
aoqi@0: 
aoqi@0:         WSDLBoundOperation op = wsdlOp.getWSDLBoundOperation();
aoqi@0:         action = op.getSOAPAction();
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public String getOutputAction(Packet packet) {
aoqi@0:         //String action = AddressingVersion.UNSET_OUTPUT_ACTION;
aoqi@0:         String action = null;
aoqi@0:         WSDLOperationMapping wsdlOp = packet.getWSDLOperationMapping();
aoqi@0:         if (wsdlOp != null) {
aoqi@0:             JavaMethod javaMethod = wsdlOp.getJavaMethod();
aoqi@0:             if (javaMethod != null) {
aoqi@0:                 JavaMethodImpl jm = (JavaMethodImpl) javaMethod;
aoqi@0:                 if (jm != null && jm.getOutputAction() != null && !jm.getOutputAction().equals("")) {
aoqi@0:                     return jm.getOutputAction();
aoqi@0:                 }
aoqi@0:             }
aoqi@0:             WSDLBoundOperation wbo = wsdlOp.getWSDLBoundOperation();
aoqi@0:             if (wbo != null) return getOutputAction(wbo);
aoqi@0:         }
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     String getOutputAction(@Nullable WSDLBoundOperation wbo) {
aoqi@0:         String action = AddressingVersion.UNSET_OUTPUT_ACTION;
aoqi@0:         if (wbo != null) {
aoqi@0:             WSDLOutput op = wbo.getOperation().getOutput();
aoqi@0:             if (op != null) {
aoqi@0:                 action = op.getAction();
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return action;
aoqi@0:     }
aoqi@0: 
aoqi@0:     public SOAPFault createInvalidAddressingHeaderFault(InvalidAddressingHeaderException e, AddressingVersion av) {
aoqi@0:         QName name = e.getProblemHeader();
aoqi@0:         QName subsubcode = e.getSubsubcode();
aoqi@0:         QName subcode = av.invalidMapTag;
aoqi@0:         String faultstring = String.format(av.getInvalidMapText(), name, subsubcode);
aoqi@0: 
aoqi@0:         try {
aoqi@0:             SOAPFactory factory;
aoqi@0:             SOAPFault fault;
aoqi@0:             if (soapVer == SOAPVersion.SOAP_12) {
aoqi@0:                 factory = SOAPVersion.SOAP_12.getSOAPFactory();
aoqi@0:                 fault = factory.createFault();
aoqi@0:                 fault.setFaultCode(SOAPConstants.SOAP_SENDER_FAULT);
aoqi@0:                 fault.appendFaultSubcode(subcode);
aoqi@0:                 fault.appendFaultSubcode(subsubcode);
aoqi@0:                 getInvalidMapDetail(name, fault.addDetail());
aoqi@0:             } else {
aoqi@0:                 factory = SOAPVersion.SOAP_11.getSOAPFactory();
aoqi@0:                 fault = factory.createFault();
aoqi@0:                 fault.setFaultCode(subsubcode);
aoqi@0:             }
aoqi@0: 
aoqi@0:             fault.setFaultString(faultstring);
aoqi@0: 
aoqi@0:             return fault;
aoqi@0:         } catch (SOAPException se) {
aoqi@0:             throw new WebServiceException(se);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public SOAPFault newMapRequiredFault(MissingAddressingHeaderException e) {
aoqi@0:         QName subcode = addVer.mapRequiredTag;
aoqi@0:         QName subsubcode = addVer.mapRequiredTag;
aoqi@0:         String faultstring = addVer.getMapRequiredText();
aoqi@0: 
aoqi@0:         try {
aoqi@0:             SOAPFactory factory;
aoqi@0:             SOAPFault fault;
aoqi@0:             if (soapVer == SOAPVersion.SOAP_12) {
aoqi@0:                 factory = SOAPVersion.SOAP_12.getSOAPFactory();
aoqi@0:                 fault = factory.createFault();
aoqi@0:                 fault.setFaultCode(SOAPConstants.SOAP_SENDER_FAULT);
aoqi@0:                 fault.appendFaultSubcode(subcode);
aoqi@0:                 fault.appendFaultSubcode(subsubcode);
aoqi@0:                 getMapRequiredDetail(e.getMissingHeaderQName(), fault.addDetail());
aoqi@0:             } else {
aoqi@0:                 factory = SOAPVersion.SOAP_11.getSOAPFactory();
aoqi@0:                 fault = factory.createFault();
aoqi@0:                 fault.setFaultCode(subsubcode);
aoqi@0:             }
aoqi@0: 
aoqi@0:             fault.setFaultString(faultstring);
aoqi@0: 
aoqi@0:             return fault;
aoqi@0:         } catch (SOAPException se) {
aoqi@0:             throw new WebServiceException(se);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     public abstract void getProblemActionDetail(String action, Element element);
aoqi@0:     public abstract void getInvalidMapDetail(QName name, Element element);
aoqi@0:     public abstract void getMapRequiredDetail(QName name, Element element);
aoqi@0: 
aoqi@0:     protected SEIModel seiModel;
aoqi@0:     protected WSDLPort wsdlPort;
aoqi@0:     protected WSBinding binding;
aoqi@0:     protected final SOAPVersion soapVer;
aoqi@0:     protected final AddressingVersion addVer;
aoqi@0: }