org.apache.axis2.description.AxisBinding Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.axis2.description;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import javax.xml.namespace.QName;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.axiom.soap.SOAP11Constants;
import org.apache.axis2.AxisFault;
import org.apache.axis2.Constants;
import org.apache.axis2.util.PolicyUtil;
import org.apache.axis2.util.WSDLSerializationUtil;
import org.apache.neethi.Policy;
import org.apache.neethi.PolicyComponent;
/**
* An AxisBinding represents a WSDL binding, and contains AxisBindingOperations.
*/
public class AxisBinding extends AxisDescription {
private QName name;
private String type;
private Map options;
private Map faults;
public AxisBindingMessage getFault(String name) {
return (AxisBindingMessage) faults.get(name);
}
public void addFault(AxisBindingMessage fault) {
this.faults.put(fault.getName(), fault);
}
public AxisBinding() {
options = new HashMap();
faults = new HashMap();
}
public void setProperty(String name, Object value) {
options.put(name, value);
}
/**
* @param name name of the property to search for
* @return the value of the property, or null if the property is not found
*/
public Object getProperty(String name) {
Object obj = options.get(name);
if (obj != null) {
return obj;
}
// need this here to guarantee that we dont return a SOAP version for HTTP Bindings
if (WSDL2Constants.ATTR_WSOAP_VERSION.equals(name) &&
WSDL2Constants.URI_WSDL2_HTTP.equals(type)) {
return null;
}
obj = WSDL20DefaultValueHolder.getDefaultValue(name);
return obj;
}
public QName getName() {
return name;
}
public void setName(QName name) {
this.name = name;
}
public String getType() {
return type;
}
public void setType(String type) {
this.type = type;
}
public Object getKey() {
return null;
}
public void engageModule(AxisModule axisModule) throws AxisFault {
throw new UnsupportedOperationException("Sorry we do not support this");
}
public boolean isEngaged(String moduleName) {
throw new UnsupportedOperationException("axisMessage.isEngaged() is not supported");
}
/**
* Generate the <binding> element
*
* @param wsdl the WSDL namespace
* @param tns the target namespace
* @param wsoap the SOAP namespace
* @param whttp the HTTP namespace
* @param interfaceName the name of the interface
* @param nameSpaceMap the namespaceMap (prefix -> namespaceURI) of the service
* @param addressingFlag addressing usage flag (see AddressingConstants)
* @param serviceName the name of the service
* @return the generated binding element
*/
public OMElement toWSDL20(OMNamespace wsdl, OMNamespace tns, OMNamespace wsoap,
OMNamespace whttp, String interfaceName, Map nameSpaceMap,
String addressingFlag,
String serviceName,
OMNamespace wsaw) {
String property;
OMFactory omFactory = OMAbstractFactory.getOMFactory();
OMElement bindingElement;
bindingElement = omFactory.createOMElement(WSDL2Constants.BINDING_LOCAL_NAME, wsdl);
bindingElement.addAttribute(omFactory.createOMAttribute(WSDL2Constants.ATTRIBUTE_NAME, null,
this.name.getLocalPart()));
bindingElement.addAttribute(omFactory.createOMAttribute(WSDL2Constants.INTERFACE_LOCAL_NAME,
null, tns.getPrefix() + ":" +
interfaceName));
if (WSDL2Constants.URI_WSDL2_SOAP.equals(type) || Constants.URI_SOAP11_HTTP.equals(type) ||
Constants.URI_SOAP12_HTTP.equals(type)) {
// SOAP Binding specific properties
bindingElement.addAttribute(omFactory.createOMAttribute(WSDL2Constants.ATTRIBUTE_TYPE,
null,
WSDL2Constants.URI_WSDL2_SOAP));
property = (String)options.get(WSDL2Constants.ATTR_WSOAP_VERSION);
if (property != null) {
if (SOAP11Constants.SOAP_ENVELOPE_NAMESPACE_URI.equals(property)) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_VERSION, wsoap,
WSDL2Constants.SOAP_VERSION_1_1));
} else {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_VERSION, wsoap,
WSDL2Constants.SOAP_VERSION_1_2));
}
}
property = (String)options.get(WSDL2Constants.ATTR_WSOAP_PROTOCOL);
if (property != null) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_PROTOCOL, wsoap, property));
}
property = (String)options.get(WSDL2Constants.ATTR_WSOAP_MEP);
if (property != null) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_MEP_DEFAULT, wsoap, property));
}
ArrayList soapModules = (ArrayList)options.get(WSDL2Constants.ATTR_WSOAP_MODULE);
if (soapModules != null && soapModules.size() > 0) {
WSDLSerializationUtil
.addSOAPModuleElements(omFactory, soapModules, wsoap, bindingElement);
}
WSDLSerializationUtil
.addWSAddressingToBinding(addressingFlag, omFactory, bindingElement, wsaw);
} else if (WSDL2Constants.URI_WSDL2_HTTP.equals(type)) {
// HTTP Binding specific properties
property = (String)options.get(WSDL2Constants.ATTR_WHTTP_METHOD);
if (property != null) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_METHOD_DEFAULT, whttp, property));
}
bindingElement.addAttribute(omFactory.createOMAttribute(WSDL2Constants.ATTRIBUTE_TYPE,
null,
WSDL2Constants.URI_WSDL2_HTTP));
}
// Common Properties
property = (String)options.get(WSDL2Constants.ATTR_WHTTP_CONTENT_ENCODING);
if (property != null) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_CONTENT_ENCODING_DEFAULT, whttp, property));
}
property = (String)options.get(WSDL2Constants.ATTR_WHTTP_QUERY_PARAMETER_SEPARATOR);
if (property != null) {
bindingElement.addAttribute(omFactory.createOMAttribute(
WSDL2Constants.ATTRIBUTE_QUERY_PARAMETER_SEPERATOR_DEFAULT, whttp, property));
}
// Populate Binding faults
if (faults != null) {
Iterator iterator = faults.values().iterator();
while (iterator.hasNext()) {
AxisBindingMessage axisBindingFault = (AxisBindingMessage)iterator.next();
OMElement omElement =
axisBindingFault.toWSDL20(wsdl, tns, wsoap, whttp, nameSpaceMap);
omElement.setLocalName(WSDL2Constants.FAULT_LOCAL_NAME);
bindingElement
.addChild(omElement);
}
}
// Populate Binding Operations
Iterator iterator = this.getChildren();
while (iterator.hasNext()) {
AxisBindingOperation axisBindingOperation = (AxisBindingOperation)iterator.next();
AxisOperation axisOperation = axisBindingOperation.getAxisOperation();
// If the axisOperation corresponding to this is a control operation we do not want to
// have it listed in the WSDL
if (axisOperation != null && axisOperation.isControlOperation()) {
continue;
}
bindingElement.addChild(axisBindingOperation.toWSDL20(wsdl, tns, wsoap, whttp, type,
nameSpaceMap, serviceName));
}
WSDLSerializationUtil.addWSDLDocumentationElement(this, bindingElement, omFactory, wsdl);
WSDLSerializationUtil.addPoliciesAsExtensibleElement(this,
bindingElement);
return bindingElement;
}
public Policy getEffectivePolicy() {
Collection policyList = new ArrayList();
policyList.addAll(getPolicySubject().getAttachedPolicyComponents());
// AxisEndpoint
AxisEndpoint axisEndpoint = getAxisEndpoint();
if (axisEndpoint != null) {
policyList.addAll(axisEndpoint.getPolicySubject().getAttachedPolicyComponents());
}
AxisService service = null;
if (axisEndpoint != null) {
service = axisEndpoint.getAxisService();
}
if (service != null) {
PolicySubject servicePolicySubject = service.getPolicySubject();
if (servicePolicySubject != null) {
policyList.addAll(servicePolicySubject.getAttachedPolicyComponents());
}
}
return PolicyUtil.getMergedPolicy(policyList, this);
}
public AxisEndpoint getAxisEndpoint() {
return (AxisEndpoint)parent;
}
public Iterator getChildren(){
return (Iterator) super.getChildren();
}
@Override
public void applyPolicy() throws AxisFault {
getAxisEndpoint().getAxisService().applyPolicy();
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy