com.ibm.wsdl.DefinitionImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of libre-wsdl4j Show documentation
Show all versions of libre-wsdl4j Show documentation
Open and Free WSDL library: Web Services Description Language. Libre-wsdl4j is a fork of WSDL4J 1.6.3. WSL4j is a Java stub generator for WSDL. Many software projects still depends on WSL4j, so the idea is that libre-wsdl4j should be an actively maintained version of this software on GitHub. "WSDL, that's an anchronym i haven't heard in almost ten years." Still big in the enterprise world" - comments on the Internet.
The newest version!
/*
* (c) Copyright IBM Corp 2001, 2006
*/
package com.ibm.wsdl;
import java.util.*;
import javax.wsdl.*;
import javax.wsdl.extensions.*;
import javax.xml.namespace.*;
/**
* This class represents a WSDL definition.
*
* @author Paul Fremantle
* @author Nirmal Mukhi
* @author Matthew J. Duftler
*/
public class DefinitionImpl extends AbstractWSDLElement implements Definition {
private String documentBaseURI = null;
private QName name = null;
private String targetNamespace = null;
private final Map namespaces = new HashMap<>();
private final Map> imports = new HashMap<>();
private Types types = null;
private final Map messages = new HashMap<>();
private final Map bindings = new HashMap<>();
private final Map portTypes = new HashMap<>();
private final Map services = new HashMap<>();
private final List nativeAttributeNames = Arrays.asList(Constants.DEFINITION_ATTR_NAMES);
private ExtensionRegistry extReg = null;
public static final long serialVersionUID = 1;
/**
* Set the document base URI of this definition. Can be used to represent the origin of the Definition, and can be exploited when resolving relative URIs (e.g. in <import>s).
*
* @param documentBaseURI
* the document base URI of this definition
*/
@Override
public void setDocumentBaseURI(String documentBaseURI) {
this.documentBaseURI = documentBaseURI;
}
/**
* Get the document base URI of this definition.
*
* @return the document base URI
*/
@Override
public String getDocumentBaseURI() {
return documentBaseURI;
}
/**
* Set the name of this definition.
*
* @param name
* the desired name
*/
@Override
public void setQName(QName name) {
this.name = name;
}
/**
* Get the name of this definition.
*
* @return the definition name
*/
@Override
public QName getQName() {
return name;
}
/**
* Set the target namespace in which WSDL elements are defined.
*
* @param targetNamespace
* the target namespace
*/
@Override
public void setTargetNamespace(String targetNamespace) {
this.targetNamespace = targetNamespace;
}
/**
* Get the target namespace in which the WSDL elements are defined.
*
* @return the target namespace
*/
@Override
public String getTargetNamespace() {
return targetNamespace;
}
/**
* This is a way to add a namespace association to a definition. It is similar to adding a namespace prefix declaration to the top of a <wsdl:definition> element. This has nothing to do with the <wsdl:import> element; there are separate methods for dealing with information described by
* <wsdl:import> elements.
*
* @param prefix
* the prefix to use for this namespace (when rendering this information as XML). Use null or an empty string to describe the default namespace (i.e. xmlns="...").
* @param namespaceURI
* the namespace URI to associate the prefix with. If you use null, the namespace association will be removed.
*/
@Override
public void addNamespace(String prefix, String namespaceURI) {
if (prefix == null) {
prefix = "";
}
if (namespaceURI != null) {
namespaces.put(prefix, namespaceURI);
} else {
namespaces.remove(prefix);
}
}
/**
* Get the namespace URI associated with this prefix. Or null if there is no namespace URI associated with this prefix. This is unrelated to the <wsdl:import> element.
*
* @see #addNamespace(String, String)
* @see #getPrefix(String)
*/
@Override
public String getNamespace(String prefix) {
if (prefix == null) {
prefix = "";
}
return namespaces.get(prefix);
}
/**
* Remove the namespace URI associated with this prefix.
*
* @param prefix
* the prefix of the namespace to be removed.
* @return the namespace URI which was removed
*/
@Override
public String removeNamespace(String prefix) {
if (prefix == null) {
prefix = "";
}
return namespaces.remove(prefix);
}
/**
* Get a prefix associated with this namespace URI. Or null if there are no prefixes associated with this namespace URI. This is unrelated to the <wsdl:import> element.
*
* @see #addNamespace(String, String)
* @see #getNamespace(String)
*/
@Override
public String getPrefix(String namespaceURI) {
if (namespaceURI == null) {
return null;
}
Iterator> entryIterator = namespaces.entrySet().iterator();
while (entryIterator.hasNext()) {
Map.Entry entry = entryIterator.next();
String prefix = entry.getKey();
String assocNamespaceURI = entry.getValue();
if (namespaceURI.equals(assocNamespaceURI)) {
return prefix;
}
}
return null;
}
/**
* Get all namespace associations in this definition. The keys are the prefixes, and the namespace URIs are the values. This is unrelated to the <wsdl:import> element.
*
* @see #addNamespace(String, String)
*/
@Override
public Map getNamespaces() {
return namespaces;
}
/**
* Set the types section.
*/
@Override
public void setTypes(Types types) {
this.types = types;
}
/**
* Get the types section.
*
* @return the types section
*/
@Override
public Types getTypes() {
return types;
}
/**
* Add an import to this WSDL description.
*
* @param importDef
* the import to be added
*/
@Override
public void addImport(Import importDef) {
String namespaceURI = importDef.getNamespaceURI();
List importList = imports.computeIfAbsent(namespaceURI, key -> new ArrayList<>());
importList.add(importDef);
}
/**
* Remove an import from this WSDL description.
*
* @param importDef
* the import to be removed
*/
@Override
public Import removeImport(Import importDef) {
String namespaceURI = importDef.getNamespaceURI();
List importList = imports.get(namespaceURI);
Import removed = null;
if (importList != null && importList.remove(importDef)) {
removed = importDef;
}
return removed;
}
/**
* Get the list of imports for the specified namespaceURI.
*
* @param namespaceURI
* the namespaceURI associated with the desired imports.
* @return a list of the corresponding imports, or null if there weren't any matching imports
*/
@Override
public List getImports(String namespaceURI) {
return imports.get(namespaceURI);
}
/**
* Get a map of lists containing all the imports defined here. The map's keys are the namespaceURIs, and the map's values are lists. There is one list for each namespaceURI for which imports have been defined.
*/
@Override
public Map> getImports() {
return imports;
}
/**
* Add a message to this WSDL description.
*
* @param message
* the message to be added
*/
@Override
public void addMessage(Message message) {
messages.put(message.getQName(), message);
}
/**
* Get the specified message. Also checks imported documents.
*
* @param name
* the name of the desired message.
* @return the corresponding message, or null if there wasn't any matching message
*/
@Override
public Message getMessage(QName name) {
Message message = messages.get(name);
if (message == null && name != null) {
message = (Message) getFromImports(Constants.ELEM_MESSAGE, name);
}
return message;
}
/**
* Remove the specified message from this definition.
*
* @param name
* the name of the message to remove
* @return the message previously associated with this qname, if there was one; may return null
*/
@Override
public Message removeMessage(QName name) {
return messages.remove(name);
}
/**
* Get all the messages defined here.
*/
@Override
public Map getMessages() {
return messages;
}
/**
* Add a binding to this WSDL description.
*
* @param binding
* the binding to be added
*/
@Override
public void addBinding(Binding binding) {
bindings.put(binding.getQName(), binding);
}
/**
* Get the specified binding. Also checks imported documents.
*
* @param name
* the name of the desired binding.
* @return the corresponding binding, or null if there wasn't any matching binding
*/
@Override
public Binding getBinding(QName name) {
Binding binding = bindings.get(name);
if (binding == null && name != null) {
binding = (Binding) getFromImports(Constants.ELEM_BINDING, name);
}
return binding;
}
/**
* Remove the specified binding from this definition.
*
* @param name
* the name of the binding to remove
* @return the binding previously associated with this qname, if there was one; may return null
*/
@Override
public Binding removeBinding(QName name) {
return bindings.remove(name);
}
/**
* Get all the bindings defined in this Definition.
*/
@Override
public Map getBindings() {
return bindings;
}
/**
* Add a portType to this WSDL description.
*
* @param portType
* the portType to be added
*/
@Override
public void addPortType(PortType portType) {
portTypes.put(portType.getQName(), portType);
}
/**
* Get the specified portType. Also checks imported documents.
*
* @param name
* the name of the desired portType.
* @return the corresponding portType, or null if there wasn't any matching portType
*/
@Override
public PortType getPortType(QName name) {
PortType portType = portTypes.get(name);
if (portType == null && name != null) {
portType = (PortType) getFromImports(Constants.ELEM_PORT_TYPE, name);
}
return portType;
}
/**
* Remove the specified portType from this definition.
*
* @param name
* the name of the portType to remove
* @return the portType previously associated with this qname, if there was one; may return null
*/
@Override
public PortType removePortType(QName name) {
return portTypes.remove(name);
}
/**
* Get all the portTypes defined in this Definition.
*/
@Override
public Map getPortTypes() {
return portTypes;
}
/**
* Add a service to this WSDL description.
*
* @param service
* the service to be added
*/
@Override
public void addService(Service service) {
services.put(service.getQName(), service);
}
/**
* Get the specified service. Also checks imported documents.
*
* @param name
* the name of the desired service.
* @return the corresponding service, or null if there wasn't any matching service
*/
@Override
public Service getService(QName name) {
Service service = services.get(name);
if (service == null && name != null) {
service = (Service) getFromImports(Constants.ELEM_SERVICE, name);
}
return service;
}
/**
* Remove the specified service from this definition.
*
* @param name
* the name of the service to remove
* @return the service previously associated with this qname, if there was one; may return null
*/
@Override
public Service removeService(QName name) {
return services.remove(name);
}
/**
* Get all the services defined in this Definition.
*/
@Override
public Map getServices() {
return services;
}
/**
* Create a new binding.
*
* @return the newly created binding
*/
@Override
public Binding createBinding() {
return new BindingImpl();
}
/**
* Create a new binding fault.
*
* @return the newly created binding fault
*/
@Override
public BindingFault createBindingFault() {
return new BindingFaultImpl();
}
/**
* Create a new binding input.
*
* @return the newly created binding input
*/
@Override
public BindingInput createBindingInput() {
return new BindingInputImpl();
}
/**
* Create a new binding operation.
*
* @return the newly created binding operation
*/
@Override
public BindingOperation createBindingOperation() {
return new BindingOperationImpl();
}
/**
* Create a new binding output.
*
* @return the newly created binding output
*/
@Override
public BindingOutput createBindingOutput() {
return new BindingOutputImpl();
}
/**
* Create a new fault.
*
* @return the newly created fault
*/
@Override
public Fault createFault() {
return new FaultImpl();
}
/**
* Create a new import.
*
* @return the newly created import
*/
@Override
public Import createImport() {
return new ImportImpl();
}
/**
* Create a new input.
*
* @return the newly created input
*/
@Override
public Input createInput() {
return new InputImpl();
}
/**
* Create a new message.
*
* @return the newly created message
*/
@Override
public Message createMessage() {
return new MessageImpl();
}
/**
* Create a new operation.
*
* @return the newly created operation
*/
@Override
public Operation createOperation() {
return new OperationImpl();
}
/**
* Create a new output.
*
* @return the newly created output
*/
@Override
public Output createOutput() {
return new OutputImpl();
}
/**
* Create a new part.
*
* @return the newly created part
*/
@Override
public Part createPart() {
return new PartImpl();
}
/**
* Create a new port.
*
* @return the newly created port
*/
@Override
public Port createPort() {
return new PortImpl();
}
/**
* Create a new port type.
*
* @return the newly created port type
*/
@Override
public PortType createPortType() {
return new PortTypeImpl();
}
/**
* Create a new service.
*
* @return the newly created service
*/
@Override
public Service createService() {
return new ServiceImpl();
}
/**
* Create a new types section.
*
* @return the newly created types section
*/
@Override
public Types createTypes() {
return new TypesImpl();
}
/**
* Set the ExtensionRegistry for this Definition.
*/
@Override
public void setExtensionRegistry(ExtensionRegistry extReg) {
this.extReg = extReg;
}
/**
* Get a reference to the ExtensionRegistry for this Definition.
*/
@Override
public ExtensionRegistry getExtensionRegistry() {
return extReg;
}
private WSDLElement getFromImports(String typeOfDefinition, QName name) {
WSDLElement ret = null;
List importList = getImports(name.getNamespaceURI());
if (importList == null) {
return null;
}
Iterator importIterator = importList.iterator();
while (importIterator.hasNext()) {
Import importDef = importIterator.next();
Definition importedDef = importDef.getDefinition();
if (importedDef != null) {
// These object comparisons will work fine because this private method is only called from within this class,
// using only the pre-defined constants from the Constants class as the typeOfDefinition argument.
switch (typeOfDefinition) {
case Constants.ELEM_SERVICE:
ret = importedDef.getService(name);
break;
case Constants.ELEM_MESSAGE:
ret = importedDef.getMessage(name);
break;
case Constants.ELEM_BINDING:
ret = importedDef.getBinding(name);
break;
case Constants.ELEM_PORT_TYPE:
ret = importedDef.getPortType(name);
break;
default:
break;
}
if (ret != null) {
return ret;
}
}
}
return ret;
}
private void appendElementToStringBuilder(Map element, StringBuilder sb) {
if (element != null) {
Iterator importIterator = element.values().iterator();
while (importIterator.hasNext()) {
sb.append("\n" + importIterator.next());
}
}
}
@Override
public String toString() {
StringBuilder strBuf = new StringBuilder();
strBuf.append("Definition: name=" + name + " targetNamespace=" + targetNamespace);
// Imports
if (imports != null) {
Iterator> importIterator = imports.values().iterator();
while (importIterator.hasNext()) {
strBuf.append("\n" + importIterator.next());
}
}
// Types
if (types != null) {
strBuf.append("\n" + types);
}
// Messages
appendElementToStringBuilder(this.messages, strBuf);
// Port types
appendElementToStringBuilder(this.portTypes, strBuf);
// Bindings
appendElementToStringBuilder(this.bindings, strBuf);
// Services
appendElementToStringBuilder(this.services, strBuf);
String superString = super.toString();
if (!superString.equals("")) {
strBuf.append("\n");
strBuf.append(superString);
}
return strBuf.toString();
}
/**
* Get the list of local attribute names defined for this element in the WSDL specification.
*
* @return a List of Strings, one for each local attribute name
*/
@Override
public List getNativeAttributeNames() {
return nativeAttributeNames;
}
/**
* Get all the bindings defined in this Definition and those in any imported Definitions in the WSDL tree.
*/
@Override
public Map getAllBindings() {
Map allBindings = new HashMap<>(getBindings());
Map> importMap = getImports();
Iterator> mapItr = importMap.values().iterator();
while (mapItr.hasNext()) {
List importDefs = mapItr.next();
Iterator importItr = importDefs.iterator();
while (importItr.hasNext()) {
Import importDef = importItr.next();
Definition importedDef = importDef.getDefinition();
// importedDef may be null (e.g. if the javax.wsdl.importDocuments feature is disabled).
if (importedDef != null) {
allBindings.putAll(importedDef.getAllBindings());
}
}
}
return allBindings;
}
/**
* Get all the portTypes defined in this Definition and those in any imported Definitions in the WSDL tree.
*/
@Override
public Map getAllPortTypes() {
Map allPortTypes = new HashMap<>(getPortTypes());
Map> importMap = getImports();
Iterator> mapItr = importMap.values().iterator();
while (mapItr.hasNext()) {
List importDefs = mapItr.next();
Iterator importItr = importDefs.iterator();
while (importItr.hasNext()) {
Import importDef = importItr.next();
Definition importedDef = importDef.getDefinition();
// importedDef may be null (e.g. if the javax.wsdl.importDocuments feature is disabled).
if (importedDef != null) {
allPortTypes.putAll(importedDef.getAllPortTypes());
}
}
}
return allPortTypes;
}
/**
* Get all the services defined in this Definition and those in any imported Definitions in the WSDL tree.
*/
@Override
public Map getAllServices() {
Map allServices = new HashMap<>(getServices());
Map> importMap = getImports();
Iterator> mapItr = importMap.values().iterator();
while (mapItr.hasNext()) {
List importDefs = mapItr.next();
Iterator importItr = importDefs.iterator();
while (importItr.hasNext()) {
Import importDef = importItr.next();
Definition importedDef = importDef.getDefinition();
// importedDef may be null (e.g. if the javax.wsdl.importDocuments feature is disabled).
if (importedDef != null) {
allServices.putAll(importedDef.getAllServices());
}
}
}
return allServices;
}
}