org.apache.woden.internal.wsdl20.extensions.soap

Class SOAPHeaderBlockImpl

java.lang.Object

org.apache.woden.internal.wsdl20.extensions.soap.SOAPHeaderBlockImpl

All Implemented Interfaces:

AttributeExtensible, ElementExtensible, ExtensionElement, SOAPHeaderBlock, SOAPHeaderBlockElement

public class SOAPHeaderBlockImpl
extends Object
implements SOAPHeaderBlock, SOAPHeaderBlockElement

This class represents the SOAPHeaderBlock Component and the <wsoap:header> extension element that can appear within a Binding Fault or Binding Message Reference.

Author:

jkaputin@apache.org

Constructor Summary

Constructors

Constructor and Description
SOAPHeaderBlockImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocumentationElement(DocumentationElement docEl)
void	addExtensionElement(ExtensionElement extEl)
DocumentationElement[]	getDocumentationElements()
org.apache.ws.commons.schema.XmlSchemaElement	getElement() Returns the Schema element declaration identified by the QName in the 'element' attribute of the <wsoap:header> element.
ElementDeclaration	getElementDeclaration()
QName	getElementName()
XMLAttr	getExtensionAttribute(QName attrType) Return the extension attribute with this QName.
XMLAttr[]	getExtensionAttributes() Return all extension attributes.
XMLAttr[]	getExtensionAttributesForNamespace(URI namespace) Return the extension attributes from this namespace.
ExtensionElement[]	getExtensionElements()
ExtensionElement[]	getExtensionElementsOfType(QName extType)
QName	getExtensionType()
WSDLComponent	getParent()
WSDLElement	getParentElement()
boolean	hasExtensionAttributesForNamespace(URI namespace) Return true if the implementor has extension attributes belonging to this namespace, otherwise false.
boolean	hasExtensionElementsForNamespace(URI namespace) Return true if the implementor has extension elements belonging to this namespace, otherwise false.
Boolean	isRequired()
Boolean	mustUnderstand()
void	removeExtensionElement(ExtensionElement extEl)
void	setElementName(QName qname) Set the QName that identifies the Schema element declaration relating to this soap header.
void	setExtensionAttribute(QName attrType, XMLAttr attr) Store the extension attribute object identified by the QName.
void	setExtensionType(QName qname)
void	setMustUnderstand(Boolean understood)
void	setParentElement(WSDLElement wsdlEl)
void	setRequired(Boolean required)
void	setTypes(TypesElement types)
SOAPHeaderBlockElement	toElement()

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPHeaderBlockImpl

public SOAPHeaderBlockImpl()

Method Detail

getElementDeclaration

public ElementDeclaration getElementDeclaration()

Specified by:

getElementDeclaration in interface SOAPHeaderBlock

mustUnderstand

public Boolean mustUnderstand()

Specified by:

mustUnderstand in interface SOAPHeaderBlock

Specified by:

mustUnderstand in interface SOAPHeaderBlockElement

isRequired

public Boolean isRequired()

Specified by:

isRequired in interface ExtensionElement

Specified by:

isRequired in interface SOAPHeaderBlock

getParent

public WSDLComponent getParent()

Specified by:

getParent in interface SOAPHeaderBlock

toElement

public SOAPHeaderBlockElement toElement()

Specified by:

toElement in interface SOAPHeaderBlock

setElementName

public void setElementName(QName qname)

Description copied from interface: SOAPHeaderBlockElement

Set the QName that identifies the Schema element declaration relating to this soap header.

Specified by:

setElementName in interface SOAPHeaderBlockElement

Parameters:

qname - the QName that identifies a Schema element declaration

getElementName

public QName getElementName()

Specified by:

getElementName in interface SOAPHeaderBlockElement

getElement

public org.apache.ws.commons.schema.XmlSchemaElement getElement()

Description copied from interface: SOAPHeaderBlockElement

Returns the Schema element declaration identified by the QName in the 'element' attribute of the <wsoap:header> element. If this QName does not resolve to an element declaration in a schema that is visible to the containing WSDL description, null will be returned by this method. To be visible, the Schema must have been correctly imported or inlined within the <types> element.

Specified by:

getElement in interface SOAPHeaderBlockElement

Returns:

the XmlSchemaElement identified by the 'element' attribute

setMustUnderstand

public void setMustUnderstand(Boolean understood)

Specified by:

setMustUnderstand in interface SOAPHeaderBlockElement

setParentElement

public void setParentElement(WSDLElement wsdlEl)

Specified by:

setParentElement in interface SOAPHeaderBlockElement

getParentElement

public WSDLElement getParentElement()

Specified by:

getParentElement in interface SOAPHeaderBlockElement

addDocumentationElement

public void addDocumentationElement(DocumentationElement docEl)

Specified by:

addDocumentationElement in interface SOAPHeaderBlockElement

getDocumentationElements

public DocumentationElement[] getDocumentationElements()

Specified by:

getDocumentationElements in interface SOAPHeaderBlockElement

setExtensionType

public void setExtensionType(QName qname)

Specified by:

setExtensionType in interface ExtensionElement

getExtensionType

public QName getExtensionType()

Specified by:

getExtensionType in interface ExtensionElement

setRequired

public void setRequired(Boolean required)

Specified by:

setRequired in interface ExtensionElement

setExtensionAttribute

public void setExtensionAttribute(QName attrType,
                         XMLAttr attr)

Description copied from interface: AttributeExtensible

Store the extension attribute object identified by the QName. If the attribute argument is null, remove the extension attribute identified by the specified QName argument. TODO ? @throws IllegalArgumentException if the QName is null

Specified by:

setExtensionAttribute in interface AttributeExtensible

getExtensionAttribute

public XMLAttr getExtensionAttribute(QName attrType)

Description copied from interface: AttributeExtensible

Return the extension attribute with this QName.

Specified by:

getExtensionAttribute in interface AttributeExtensible

getExtensionAttributesForNamespace

public XMLAttr[] getExtensionAttributesForNamespace(URI namespace)

Description copied from interface: AttributeExtensible

Return the extension attributes from this namespace.

Specified by:

getExtensionAttributesForNamespace in interface AttributeExtensible

getExtensionAttributes

public XMLAttr[] getExtensionAttributes()

Description copied from interface: AttributeExtensible

Return all extension attributes.

Specified by:

getExtensionAttributes in interface AttributeExtensible

hasExtensionAttributesForNamespace

public boolean hasExtensionAttributesForNamespace(URI namespace)

Description copied from interface: AttributeExtensible

Return true if the implementor has extension attributes belonging to this namespace, otherwise false.

Specified by:

hasExtensionAttributesForNamespace in interface AttributeExtensible

addExtensionElement

public void addExtensionElement(ExtensionElement extEl)

Specified by:

addExtensionElement in interface ElementExtensible

removeExtensionElement

public void removeExtensionElement(ExtensionElement extEl)

Specified by:

removeExtensionElement in interface ElementExtensible

getExtensionElements

public ExtensionElement[] getExtensionElements()

Specified by:

getExtensionElements in interface ElementExtensible

getExtensionElementsOfType

public ExtensionElement[] getExtensionElementsOfType(QName extType)

Specified by:

getExtensionElementsOfType in interface ElementExtensible

hasExtensionElementsForNamespace

public boolean hasExtensionElementsForNamespace(URI namespace)

Description copied from interface: ElementExtensible

Return true if the implementor has extension elements belonging to this namespace, otherwise false.

Specified by:

hasExtensionElementsForNamespace in interface ElementExtensible

setTypes

public void setTypes(TypesElement types)