Package org.frankframework.soap

Class WsdlGenerator

java.lang.Object

org.frankframework.soap.WsdlGenerator

public class WsdlGenerator
extends Object

Utility class to generate the WSDL. Straight-forwardly implemented using stax only. An object of this class represents the WSDL associated with one IBIS pipeline.

Author:

Michiel Meeuwissen, Jaco de Groot

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	excludeXsds
protected org.apache.logging.log4j.Logger	log
protected static final String	SOAP_HTTP_NAMESPACE
protected static final String	SOAP_JMS_NAMESPACE
static final String	SOAP_JMS_NAMESPACE_PREFIX
protected static final String	TARGET_NAMESPACE_PREFIX
static final String	WSDL_EXTENSION
protected static final String	WSDL_NAMESPACE
protected static final String	WSDL_NAMESPACE_PREFIX
protected static final String	WSDL_SOAP_NAMESPACE
protected static final String	WSDL_SOAP_NAMESPACE_PREFIX
protected static final String	WSDL_SOAP12_NAMESPACE
protected static final String	WSDL_SOAP12_NAMESPACE_PREFIX
protected static final String	XSD_NAMESPACE
protected static final String	XSD_NAMESPACE_PREFIX

Constructor Summary

Constructors

Constructor	Description
WsdlGenerator(PipeLine pipeLine)
WsdlGenerator(PipeLine pipeLine, String generationInfo)

Method Summary

Modifier and Type	Method	Description
protected void	binding(XMLStreamWriter w)
protected void	documentation(XMLStreamWriter w)	Outputs a 'documentation' section of the WSDL
protected QName	getBodyElement(IXmlValidator xmlValidator, Set<IXSD> xsds, String type)
protected QName	getBodyElement(IXmlValidator xmlValidator, Set<IXSD> xsds, String type, boolean outputMode)
String	getDocumentation()
String	getFilename()
protected QName	getHeaderElement(IXmlValidator xmlValidator, Set<IXSD> xsds)
protected String	getLocation(String defaultLocation)
String	getName()
protected String	getRoot(IXmlValidator xmlValidator)
protected String	getRoot(IXmlValidator xmlValidator, boolean outputMode)
protected QName	getRootElement(Set<IXSD> xsds, String root)
protected QName	getRootElement(Set<IXSD> xsds, String root, String namespace)
protected String	getSoapAction(IListener<?> listener)
String	getTargetNamespace()
String	getTargetNamespacePrefix()
Set<IXSD>	getXsds(IXmlValidator xmlValidator)
protected void	httpBinding(XMLStreamWriter w, String namePrefix)
protected void	httpService(XMLStreamWriter w, String defaultLocation, String namePrefix)
void	init()
protected boolean	isHeaderOptional(IXmlValidator xmlValidator)
boolean	isIndent()
boolean	isUseIncludes()
protected void	jmsBinding(XMLStreamWriter w, String namePrefix)
protected void	jmsService(XMLStreamWriter w, JmsListener listener, String namePrefix)
protected void	message(XMLStreamWriter w, String root, Collection<QName> parts)
protected void	messages(XMLStreamWriter w)	Outputs the 'messages' section.
protected void	portType(XMLStreamWriter w)
protected void	service(XMLStreamWriter w, String defaultLocation)
void	setDocumentation(String documentation)
void	setIndent(boolean indent)
void	setTargetNamespacePrefix(String targetNamespacePrefix)
void	setUseIncludes(boolean useIncludes)
protected void	types(XMLStreamWriter w)	Output the 'types' section of the WSDL
protected void	warn(String warning)
protected void	warn(String warning, Exception e)
protected void	warnings(XMLStreamWriter w)
protected void	writeSoapBody(XMLStreamWriter w, QName bodyElement)
protected void	writeSoapHeader(XMLStreamWriter w, String root, QName headerElement, boolean isHeaderOptional)
void	writeSoapOperation(XMLStreamWriter w, IListener<?> listener)
void	wsdl(OutputStream out, String defaultLocation)	Writes the WSDL to an output stream
void	zip(OutputStream stream, String defaultLocation)	Generates a zip file (and writes it to the given outputstream), containing the WSDL and all referenced XSD's.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

protected org.apache.logging.log4j.Logger log

WSDL_NAMESPACE

protected static final String WSDL_NAMESPACE

See Also:

• Constant Field Values

WSDL_NAMESPACE_PREFIX

protected static final String WSDL_NAMESPACE_PREFIX

See Also:

• Constant Field Values

XSD_NAMESPACE

protected static final String XSD_NAMESPACE

See Also:

• Constant Field Values

XSD_NAMESPACE_PREFIX

protected static final String XSD_NAMESPACE_PREFIX

See Also:

• Constant Field Values

WSDL_SOAP_NAMESPACE

protected static final String WSDL_SOAP_NAMESPACE

See Also:

• Constant Field Values

WSDL_SOAP_NAMESPACE_PREFIX

protected static final String WSDL_SOAP_NAMESPACE_PREFIX

See Also:

• Constant Field Values

WSDL_SOAP12_NAMESPACE

protected static final String WSDL_SOAP12_NAMESPACE

See Also:

• Constant Field Values

WSDL_SOAP12_NAMESPACE_PREFIX

protected static final String WSDL_SOAP12_NAMESPACE_PREFIX

See Also:

• Constant Field Values

SOAP_HTTP_NAMESPACE

protected static final String SOAP_HTTP_NAMESPACE

See Also:

• Constant Field Values

SOAP_JMS_NAMESPACE

protected static final String SOAP_JMS_NAMESPACE

See Also:

• Constant Field Values

SOAP_JMS_NAMESPACE_PREFIX

public static final String SOAP_JMS_NAMESPACE_PREFIX

See Also:

• Constant Field Values

TARGET_NAMESPACE_PREFIX

protected static final String TARGET_NAMESPACE_PREFIX

See Also:

• Constant Field Values

WSDL_EXTENSION

public static final String WSDL_EXTENSION

See Also:

• Constant Field Values

excludeXsds

protected static final List<String> excludeXsds

Constructor Details

WsdlGenerator

public WsdlGenerator(PipeLine pipeLine)

WsdlGenerator

public WsdlGenerator(PipeLine pipeLine,
 String generationInfo)

Method Details

getName

public String getName()

getFilename

public String getFilename()

getTargetNamespace

public String getTargetNamespace()

getDocumentation

public String getDocumentation()

setDocumentation

public void setDocumentation(String documentation)

isIndent

public boolean isIndent()

setIndent

public void setIndent(boolean indent)

isUseIncludes

public boolean isUseIncludes()

setUseIncludes

public void setUseIncludes(boolean useIncludes)

getTargetNamespacePrefix

public String getTargetNamespacePrefix()

setTargetNamespacePrefix

public void setTargetNamespacePrefix(String targetNamespacePrefix)

init

public void init()
          throws ConfigurationException

Throws:

ConfigurationException

isHeaderOptional

protected boolean isHeaderOptional(IXmlValidator xmlValidator)

getXsds

public Set<IXSD> getXsds(IXmlValidator xmlValidator)
                  throws ConfigurationException

Throws:

ConfigurationException

zip

public void zip(OutputStream stream,
 String defaultLocation)
         throws IOException,
ConfigurationException,
XMLStreamException

Generates a zip file (and writes it to the given outputstream), containing the WSDL and all referenced XSD's.

Throws:

IOException

ConfigurationException

XMLStreamException

See Also:

• wsdl(java.io.OutputStream, String)

wsdl

public void wsdl(OutputStream out,
 String defaultLocation)
          throws XMLStreamException,
IOException,
ConfigurationException

Writes the WSDL to an output stream

Throws:

XMLStreamException

IOException

ConfigurationException

documentation

protected void documentation(XMLStreamWriter w)
                      throws XMLStreamException

Outputs a 'documentation' section of the WSDL

Throws:

XMLStreamException

types

protected void types(XMLStreamWriter w)
              throws XMLStreamException,
IOException,
ConfigurationException

Output the 'types' section of the WSDL

Parameters:

w - Writer to which XML is written.

Throws:

XMLStreamException - Thrown is there is an exception writing to stream.

IOException - Thrown if there's an IOException during writing.

ConfigurationException - Thrown if there's an error during configuration.

messages

protected void messages(XMLStreamWriter w)
                 throws XMLStreamException

Outputs the 'messages' section.

Parameters:

w - Writer to which XML is written.

Throws:

XMLStreamException - Thrown is there is an exception writing to stream.

message

protected void message(XMLStreamWriter w,
 String root,
 Collection<QName> parts)
                throws XMLStreamException

Throws:

XMLStreamException

portType

protected void portType(XMLStreamWriter w)
                 throws XMLStreamException

Throws:

XMLStreamException

getSoapAction

protected String getSoapAction(IListener<?> listener)

getLocation

protected String getLocation(String defaultLocation)

binding

protected void binding(XMLStreamWriter w)
                throws XMLStreamException

Throws:

XMLStreamException

httpBinding

protected void httpBinding(XMLStreamWriter w,
 String namePrefix)
                    throws XMLStreamException

Throws:

XMLStreamException

writeSoapOperation

public void writeSoapOperation(XMLStreamWriter w,
 IListener<?> listener)
                        throws XMLStreamException

Throws:

XMLStreamException

writeSoapHeader

protected void writeSoapHeader(XMLStreamWriter w,
 String root,
 QName headerElement,
 boolean isHeaderOptional)
                        throws XMLStreamException

Throws:

XMLStreamException

writeSoapBody

protected void writeSoapBody(XMLStreamWriter w,
 QName bodyElement)
                      throws XMLStreamException

Throws:

XMLStreamException

jmsBinding

protected void jmsBinding(XMLStreamWriter w,
 String namePrefix)
                   throws XMLStreamException

Throws:

XMLStreamException

service

protected void service(XMLStreamWriter w,
 String defaultLocation)
                throws XMLStreamException

Throws:

XMLStreamException

httpService

protected void httpService(XMLStreamWriter w,
 String defaultLocation,
 String namePrefix)
                    throws XMLStreamException

Throws:

XMLStreamException

jmsService

protected void jmsService(XMLStreamWriter w,
 JmsListener listener,
 String namePrefix)
                   throws XMLStreamException

Throws:

XMLStreamException

warnings

protected void warnings(XMLStreamWriter w)
                 throws XMLStreamException

Throws:

XMLStreamException

getRoot

protected String getRoot(IXmlValidator xmlValidator)

getRoot

protected String getRoot(IXmlValidator xmlValidator,
 boolean outputMode)

getRootElement

protected QName getRootElement(Set<IXSD> xsds,
 String root)

getRootElement

protected QName getRootElement(Set<IXSD> xsds,
 String root,
 String namespace)

getHeaderElement

protected QName getHeaderElement(IXmlValidator xmlValidator,
 Set<IXSD> xsds)

getBodyElement

protected QName getBodyElement(IXmlValidator xmlValidator,
 Set<IXSD> xsds,
 String type)

getBodyElement

protected QName getBodyElement(IXmlValidator xmlValidator,
 Set<IXSD> xsds,
 String type,
 boolean outputMode)

warn

protected void warn(String warning,
 Exception e)

warn

protected void warn(String warning)