com.sun.xml.ws.model.wsdl.WSDLBoundPortTypeImpl Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://glassfish.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2006 Sun Microsystems Inc. All Rights Reserved
*/
package com.sun.xml.ws.model.wsdl;
import com.sun.istack.NotNull;
import com.sun.xml.ws.api.BindingID;
import com.sun.xml.ws.api.SOAPVersion;
import com.sun.xml.ws.api.model.ParameterBinding;
import com.sun.xml.ws.api.model.wsdl.WSDLBoundOperation;
import com.sun.xml.ws.api.model.wsdl.WSDLBoundPortType;
import com.sun.xml.ws.util.QNameMap;
import com.sun.xml.ws.util.exception.LocatableWebServiceException;
import com.sun.xml.ws.resources.ClientMessages;
import javax.jws.WebParam.Mode;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;
import javax.xml.namespace.QName;
import javax.xml.stream.XMLStreamReader;
import javax.xml.ws.soap.MTOMFeature;
/**
* Implementation of {@link WSDLBoundPortType}
*
* @author Vivek Pandey
*/
public final class WSDLBoundPortTypeImpl extends AbstractFeaturedObjectImpl implements WSDLBoundPortType {
private final QName name;
private final QName portTypeName;
private WSDLPortTypeImpl portType;
private BindingID bindingId;
private final @NotNull WSDLModelImpl owner;
private boolean finalized = false;
private final QNameMap bindingOperations = new QNameMap();
/**
* Operations keyed by the payload tag name.
*/
private QNameMap payloadMap;
/**
* {@link #payloadMap} doesn't allow null key, so we store the value for it here.
*/
private WSDLBoundOperationImpl emptyPayloadOperation;
public WSDLBoundPortTypeImpl(XMLStreamReader xsr,@NotNull WSDLModelImpl owner, QName name, QName portTypeName) {
super(xsr);
this.owner = owner;
this.name = name;
this.portTypeName = portTypeName;
owner.addBinding(this);
}
public QName getName() {
return name;
}
public @NotNull WSDLModelImpl getOwner() {
return owner;
}
public WSDLBoundOperationImpl get(QName operationName) {
return bindingOperations.get(operationName);
}
/**
* Populates the Map that holds operation name as key and {@link WSDLBoundOperation} as the value.
*
* @param opName Must be non-null
* @param ptOp Must be non-null
* @throws NullPointerException if either opName or ptOp is null
*/
public void put(QName opName, WSDLBoundOperationImpl ptOp) {
bindingOperations.put(opName,ptOp);
}
public QName getPortTypeName() {
return portTypeName;
}
public WSDLPortTypeImpl getPortType() {
return portType;
}
public Iterable getBindingOperations() {
return bindingOperations.values();
}
public BindingID getBindingId() {
//Should the default be SOAP1.1/HTTP binding? For now lets keep it for
//JBI bug 6509800
return (bindingId==null)?BindingID.SOAP11_HTTP:bindingId;
}
public void setBindingId(BindingID bindingId) {
this.bindingId = bindingId;
}
/**
* sets whether the {@link WSDLBoundPortType} is rpc or lit
*/
private Style style = Style.DOCUMENT;
public void setStyle(Style style){
this.style = style;
}
public SOAPBinding.Style getStyle() {
return style;
}
public boolean isRpcLit(){
return Style.RPC==style;
}
public boolean isDoclit(){
return Style.DOCUMENT==style;
}
/**
* Gets the {@link ParameterBinding} for a given operation, part name and the direction - IN/OUT
*
* @param operation wsdl:operation@name value. Must be non-null.
* @param part wsdl:part@name such as value of soap:header@part. Must be non-null.
* @param mode {@link Mode#IN} or {@link Mode@OUT}. Must be non-null.
* @return null if the binding could not be resolved for the part.
*/
public ParameterBinding getBinding(QName operation, String part, Mode mode) {
WSDLBoundOperationImpl op = get(operation);
if (op == null) {
//TODO throw exception
return null;
}
if ((Mode.IN == mode) || (Mode.INOUT == mode))
return op.getInputBinding(part);
else
return op.getOutputBinding(part);
}
/**
* Gets mime:content@part value which is the MIME type for a given operation, part and {@link Mode}.
*
* @param operation wsdl:operation@name value. Must be non-null.
* @param part wsdl:part@name such as value of soap:header@part. Must be non-null.
* @param mode {@link Mode#IN} or {@link Mode@OUT}. Must be non-null.
* @return null if the binding could not be resolved for the part.
*/
public String getMimeType(QName operation, String part, Mode mode) {
WSDLBoundOperationImpl op = get(operation);
if (Mode.IN == mode)
return op.getMimeTypeForInputPart(part);
else
return op.getMimeTypeForOutputPart(part);
}
public WSDLBoundOperationImpl getOperation(String namespaceUri, String localName) {
if(namespaceUri==null && localName == null)
return emptyPayloadOperation;
else{
return payloadMap.get((namespaceUri==null)?"":namespaceUri,localName);
}
}
public void enableMTOM() {
features.add(new MTOMFeature());
}
public boolean isMTOMEnabled() {
return features.isEnabled(MTOMFeature.class);
}
public SOAPVersion getSOAPVersion(){
return getBindingId().getSOAPVersion();
}
void freeze() {
portType = owner.getPortType(portTypeName);
if(portType == null){
throw new LocatableWebServiceException(
ClientMessages.UNDEFINED_PORT_TYPE(portTypeName), getLocation());
}
portType.freeze();
for (WSDLBoundOperationImpl op : bindingOperations.values()) {
op.freeze(owner);
}
freezePayloadMap();
if(style == Style.RPC){
owner.finalizeRpcLitBinding(this);
}
}
private void freezePayloadMap() {
if(style== Style.RPC) {
// If the style is rpc then the tag name should be
// same as operation name so return the operation that matches the tag name.
payloadMap = bindingOperations;
} else {
payloadMap = new QNameMap();
// For doclit The tag will be the operation that has the same input part descriptor value
for(WSDLBoundOperationImpl op : bindingOperations.values()){
QName name = op.getPayloadName();
if(name == null){
//empty payload
emptyPayloadOperation = op;
continue;
}
payloadMap.put(name, op);
}
}
}
}