/*
 * 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.model.wsdl;

import com.sun.istack.internal.Nullable;
import com.sun.istack.internal.NotNull;
import com.sun.xml.internal.ws.api.model.ParameterBinding;
import com.sun.xml.internal.ws.api.model.wsdl.*;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLBoundFault;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLBoundOperation;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLBoundPortType;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLMessage;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLModel;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLOperation;
import com.sun.xml.internal.ws.api.model.wsdl.editable.EditableWSDLPart;
import com.sun.xml.internal.ws.model.RuntimeModeler;

import javax.jws.WebParam.Mode;
import javax.jws.soap.SOAPBinding.Style;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamReader;

import java.util.*;

Implementation of WSDLBoundOperation
Author:Vivek Pandey
/** * Implementation of {@link WSDLBoundOperation} * * @author Vivek Pandey */
public final class WSDLBoundOperationImpl extends AbstractExtensibleImpl implements EditableWSDLBoundOperation { private final QName name; // map of wsdl:part to the binding private final Map<String, ParameterBinding> inputParts; private final Map<String, ParameterBinding> outputParts; private final Map<String, ParameterBinding> faultParts; private final Map<String, String> inputMimeTypes; private final Map<String, String> outputMimeTypes; private final Map<String, String> faultMimeTypes; private boolean explicitInputSOAPBodyParts = false; private boolean explicitOutputSOAPBodyParts = false; private boolean explicitFaultSOAPBodyParts = false; private Boolean emptyInputBody; private Boolean emptyOutputBody; private Boolean emptyFaultBody; private final Map<String, EditableWSDLPart> inParts; private final Map<String, EditableWSDLPart> outParts; private final List<EditableWSDLBoundFault> wsdlBoundFaults; private EditableWSDLOperation operation; private String soapAction; private ANONYMOUS anonymous; private final EditableWSDLBoundPortType owner;
Params:
  • name – wsdl:operation name qualified value
/** * * @param name wsdl:operation name qualified value */
public WSDLBoundOperationImpl(XMLStreamReader xsr, EditableWSDLBoundPortType owner, QName name) { super(xsr); this.name = name; inputParts = new HashMap<String, ParameterBinding>(); outputParts = new HashMap<String, ParameterBinding>(); faultParts = new HashMap<String, ParameterBinding>(); inputMimeTypes = new HashMap<String, String>(); outputMimeTypes = new HashMap<String, String>(); faultMimeTypes = new HashMap<String, String>(); inParts = new HashMap<String, EditableWSDLPart>(); outParts = new HashMap<String, EditableWSDLPart>(); wsdlBoundFaults = new ArrayList<EditableWSDLBoundFault>(); this.owner = owner; } @Override public QName getName(){ return name; } @Override public String getSOAPAction() { return soapAction; } public void setSoapAction(String soapAction) { this.soapAction = soapAction!=null?soapAction:""; } @Override public EditableWSDLPart getPart(String partName, Mode mode) { if(mode==Mode.IN){ return inParts.get(partName); }else if(mode==Mode.OUT){ return outParts.get(partName); } return null; } public void addPart(EditableWSDLPart part, Mode mode){ if(mode==Mode.IN) inParts.put(part.getName(), part); else if(mode==Mode.OUT) outParts.put(part.getName(), part); }
Map of wsdl:input part name and the binding as ParameterBinding
Returns:empty Map if there is no parts
/** * Map of wsdl:input part name and the binding as {@link ParameterBinding} * * @return empty Map if there is no parts */
public Map<String, ParameterBinding> getInputParts() { return inputParts; }
Map of wsdl:output part name and the binding as ParameterBinding
Returns:empty Map if there is no parts
/** * Map of wsdl:output part name and the binding as {@link ParameterBinding} * * @return empty Map if there is no parts */
public Map<String, ParameterBinding> getOutputParts() { return outputParts; }
Map of wsdl:fault part name and the binding as ParameterBinding
Returns:empty Map if there is no parts
/** * Map of wsdl:fault part name and the binding as {@link ParameterBinding} * * @return empty Map if there is no parts */
public Map<String, ParameterBinding> getFaultParts() { return faultParts; } // TODO: what's the difference between this and inputParts/outputParts? @Override public Map<String, ? extends EditableWSDLPart> getInParts() { return Collections.<String, EditableWSDLPart>unmodifiableMap(inParts); } @Override public Map<String, ? extends EditableWSDLPart> getOutParts() { return Collections.<String, EditableWSDLPart>unmodifiableMap(outParts); } @NotNull @Override public List<? extends EditableWSDLBoundFault> getFaults() { return wsdlBoundFaults; } public void addFault(@NotNull EditableWSDLBoundFault fault){ wsdlBoundFaults.add(fault); }
Gets ParameterBinding for a given wsdl part in wsdl:input
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets {@link ParameterBinding} for a given wsdl part in wsdl:input * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public ParameterBinding getInputBinding(String part){ if(emptyInputBody == null){ if(inputParts.get(" ") != null) emptyInputBody = true; else emptyInputBody = false; } ParameterBinding block = inputParts.get(part); if(block == null){ if(explicitInputSOAPBodyParts || emptyInputBody) return ParameterBinding.UNBOUND; return ParameterBinding.BODY; } return block; }
Gets ParameterBinding for a given wsdl part in wsdl:output
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets {@link ParameterBinding} for a given wsdl part in wsdl:output * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public ParameterBinding getOutputBinding(String part){ if(emptyOutputBody == null){ if(outputParts.get(" ") != null) emptyOutputBody = true; else emptyOutputBody = false; } ParameterBinding block = outputParts.get(part); if(block == null){ if(explicitOutputSOAPBodyParts || emptyOutputBody) return ParameterBinding.UNBOUND; return ParameterBinding.BODY; } return block; }
Gets ParameterBinding for a given wsdl part in wsdl:fault
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets {@link ParameterBinding} for a given wsdl part in wsdl:fault * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public ParameterBinding getFaultBinding(String part){ if(emptyFaultBody == null){ if(faultParts.get(" ") != null) emptyFaultBody = true; else emptyFaultBody = false; } ParameterBinding block = faultParts.get(part); if(block == null){ if(explicitFaultSOAPBodyParts || emptyFaultBody) return ParameterBinding.UNBOUND; return ParameterBinding.BODY; } return block; }
Gets the MIME type for a given wsdl part in wsdl:input
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets the MIME type for a given wsdl part in wsdl:input * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public String getMimeTypeForInputPart(String part){ return inputMimeTypes.get(part); }
Gets the MIME type for a given wsdl part in wsdl:output
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets the MIME type for a given wsdl part in wsdl:output * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public String getMimeTypeForOutputPart(String part){ return outputMimeTypes.get(part); }
Gets the MIME type for a given wsdl part in wsdl:fault
Params:
  • part – Name of wsdl:part, must be non-null
Returns:null if the part is not found.
/** * Gets the MIME type for a given wsdl part in wsdl:fault * * @param part Name of wsdl:part, must be non-null * @return null if the part is not found. */
public String getMimeTypeForFaultPart(String part){ return faultMimeTypes.get(part); } @Override public EditableWSDLOperation getOperation() { return operation; } @Override public EditableWSDLBoundPortType getBoundPortType() { return owner; } public void setInputExplicitBodyParts(boolean b) { explicitInputSOAPBodyParts = b; } public void setOutputExplicitBodyParts(boolean b) { explicitOutputSOAPBodyParts = b; } public void setFaultExplicitBodyParts(boolean b) { explicitFaultSOAPBodyParts = b; } private Style style = Style.DOCUMENT; public void setStyle(Style style){ this.style = style; } @Override public @Nullable QName getRequestPayloadName() { if (emptyRequestPayload) return null; if (requestPayloadName != null) return requestPayloadName; if(style.equals(Style.RPC)){ String ns = getRequestNamespace() != null ? getRequestNamespace() : name.getNamespaceURI(); requestPayloadName = new QName(ns, name.getLocalPart()); return requestPayloadName; }else{ QName inMsgName = operation.getInput().getMessage().getName(); EditableWSDLMessage message = messages.get(inMsgName); for(EditableWSDLPart part:message.parts()){ ParameterBinding binding = getInputBinding(part.getName()); if(binding.isBody()){ requestPayloadName = part.getDescriptor().name(); return requestPayloadName; } } //Its empty payload emptyRequestPayload = true; } //empty body return null; } @Override public @Nullable QName getResponsePayloadName() { if (emptyResponsePayload) return null; if (responsePayloadName != null) return responsePayloadName; if(style.equals(Style.RPC)){ String ns = getResponseNamespace() != null ? getResponseNamespace() : name.getNamespaceURI(); responsePayloadName = new QName(ns, name.getLocalPart()+"Response"); return responsePayloadName; }else{ QName outMsgName = operation.getOutput().getMessage().getName(); EditableWSDLMessage message = messages.get(outMsgName); for(EditableWSDLPart part:message.parts()){ ParameterBinding binding = getOutputBinding(part.getName()); if(binding.isBody()){ responsePayloadName = part.getDescriptor().name(); return responsePayloadName; } } //Its empty payload emptyResponsePayload = true; } //empty body return null; } private String reqNamespace; private String respNamespace;
For rpclit gives namespace value on soapbinding:body@namespace
See Also:
  • RuntimeModeler.processRpcMethod(JavaMethodImpl, String, String, Method)
Returns: non-null for rpclit and null for doclit
/** * For rpclit gives namespace value on soapbinding:body@namespace * * @return non-null for rpclit and null for doclit * @see RuntimeModeler#processRpcMethod(JavaMethodImpl, String, String, Method) */
@Override public String getRequestNamespace(){ return (reqNamespace != null)?reqNamespace:name.getNamespaceURI(); } public void setRequestNamespace(String ns){ reqNamespace = ns; }
For rpclit gives namespace value on soapbinding:body@namespace
See Also:
  • RuntimeModeler.processRpcMethod(JavaMethodImpl, String, String, Method)
Returns: non-null for rpclit and null for doclit
/** * For rpclit gives namespace value on soapbinding:body@namespace * * @return non-null for rpclit and null for doclit * @see RuntimeModeler#processRpcMethod(JavaMethodImpl, String, String, Method) */
@Override public String getResponseNamespace(){ return (respNamespace!=null)?respNamespace:name.getNamespaceURI(); } public void setResponseNamespace(String ns){ respNamespace = ns; } EditableWSDLBoundPortType getOwner(){ return owner; } private QName requestPayloadName; private QName responsePayloadName; private boolean emptyRequestPayload; private boolean emptyResponsePayload; private Map<QName, ? extends EditableWSDLMessage> messages; public void freeze(EditableWSDLModel parent) { messages = parent.getMessages(); operation = owner.getPortType().get(name.getLocalPart()); for(EditableWSDLBoundFault bf : wsdlBoundFaults){ bf.freeze(this); } } public void setAnonymous(ANONYMOUS anonymous) { this.anonymous = anonymous; }
@inheritDoc
/** * @inheritDoc */
@Override public ANONYMOUS getAnonymous() { return anonymous; } }