SOAPHeader

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.soap
Interface SOAPHeader

All Superinterfaces:: org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPElement (src)

All Known Implementing Classes:: SOAPHeaderImpl (src)

public interface SOAPHeader
extends SOAPElement (src)

A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a SOAPHeader object. A SOAPEnvelope object contains an empty SOAPHeader object by default. If the SOAPHeader object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is a SOAPEnvelope object. se.getHeader().detachNode(); A SOAPHeader object is created with the SOAPEnvelope method addHeader. This method, which creates a new header and adds it to the envelope, may be called only after the existing header has been removed. se.getHeader().detachNode(); SOAPHeader sh = se.addHeader(); A SOAPHeader object can have only SOAPHeaderElement objects as its immediate children. The method addHeaderElement creates a new HeaderElement object and adds it to the SOAPHeader object. In the following line of code, the argument to the method addHeaderElement is a Name object that is the name for the new HeaderElement object. SOAPHeaderElement shElement = sh.addHeaderElement(name);

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary
`SOAPHeaderElement (src)`	`addHeaderElement(Name (src) name)`
`java.util.Iterator`	`examineAllHeaderElements()`
`java.util.Iterator`	`examineHeaderElements(java.lang.String actor)`
`java.util.Iterator`	`examineMustUnderstandHeaderElements(java.lang.String actor)`
`java.util.Iterator`	`extractAllHeaderElements()`
`java.util.Iterator`	`extractHeaderElements(java.lang.String actor)`

Methods inherited from interface javax.xml.soap.SOAPElement (src)

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node (src)

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS

Method Detail

addHeaderElement

public SOAPHeaderElement (src)  addHeaderElement(Name (src)  name)
                                   throws SOAPException (src)

Throws:: SOAPException (src)

examineAllHeaderElements

public java.util.Iterator examineAllHeaderElements()

examineHeaderElements

public java.util.Iterator examineHeaderElements(java.lang.String actor)

examineMustUnderstandHeaderElements

public java.util.Iterator examineMustUnderstandHeaderElements(java.lang.String actor)

extractAllHeaderElements

public java.util.Iterator extractAllHeaderElements()

extractHeaderElements

public java.util.Iterator extractHeaderElements(java.lang.String actor)