| 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.axis.message.NodeImpl
org.apache.axis.message.MessageElement
org.apache.axis.message.SOAPHeader
Holder for header elements.
| Nested Class Summary | 
| Nested classes inherited from class org.apache.axis.message.MessageElement | 
| MessageElement.QNameAttr | 
| Field Summary | 
| Fields inherited from class org.apache.axis.message.MessageElement | 
| _isRoot, context, encodingStyle, endEventIndex, fixupDeserializer, href, id, message, namespaces, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName | 
| Fields inherited from class org.apache.axis.message.NodeImpl | 
| _isDirty, attributes, children, document, name, namespaceURI, parent, prefix, textRep | 
| 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 | 
| Constructor Summary | |
| SOAPHeader(java.lang.String namespace,
           java.lang.String localPart,
           java.lang.String prefix,
           org.xml.sax.Attributes attributes,
           DeserializationContext context,
           SOAPConstants soapConsts) | |
| Method Summary | |
|  void | addChild(MessageElement element)Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement. | 
|  SOAPElement | addChildElement(Name name)Creates a new SOAPElementobject initialized with the
 givenNameobject and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(SOAPElement element)Add a SOAPElementas a child of thisSOAPElementinstance. | 
|  SOAPElement | addChildElement(java.lang.String localName)Creates a new SOAPElementobject initialized with the
 givenStringobject and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(java.lang.String localName,
                java.lang.String prefix)Creates a new SOAPElementobject initialized with the
 specified local name and prefix and adds the new element to thisSOAPElementobject. | 
|  SOAPElement | addChildElement(java.lang.String localName,
                java.lang.String prefix,
                java.lang.String uri)Creates a new SOAPElementobject initialized with the
 specified local name, prefix, and URI and adds the new element to thisSOAPElementobject. | 
|  SOAPHeaderElement | addHeaderElement(Name name)Creates a new SOAPHeaderElementobject
 initialized with the specified name and adds it to thisSOAPHeaderobject. | 
|  org.w3c.dom.Node | appendChild(org.w3c.dom.Node newChild)Adds the node newChildto the end of the list of children
 of this node. | 
|  java.util.Iterator | examineAllHeaderElements()Returns an Iteratorover all theSOAPHeaderElementobjects in thisSOAPHeaderobject. | 
|  java.util.Iterator | examineHeaderElements(java.lang.String actor)Returns a list of all the SOAPHeaderElementobjects in thisSOAPHeaderobject that have the
 the specified actor. | 
|  java.util.Iterator | examineMustUnderstandHeaderElements(java.lang.String actor)Returns an Iteratorover all theSOAPHeaderElementobjects in thisSOAPHeaderobject that have the specified actor and that have a MustUnderstand
 attribute whose value is equivalent totrue. | 
|  java.util.Iterator | extractAllHeaderElements()Returns an Iteratorover all theSOAPHeaderElementobjects in thisSOAPHeader object and detaches them from thisSOAPHeaderobject. | 
|  java.util.Iterator | extractHeaderElements(java.lang.String actor)Returns a list of all the SOAPHeaderElementobjects in thisSOAPHeaderobject that have
   the the specified actor and detaches them from this
   SOAPHeaderobject. | 
| protected  void | outputImpl(SerializationContext context)override point -output to a serialization context. | 
|  void | setParentElement(SOAPElement parent)Sets the parent of this Nodeobject to the givenSOAPElementobject. | 
| Methods inherited from class org.apache.axis.message.NodeImpl | 
| convertAttrSAXtoDOM, detachNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, initializeChildren, insertBefore, isDirty, isSupported, makeAttributesEditable, normalize, recycleNode, removeChild, replaceChild, reset, setDirty, setDirty, setNodeValue, setOwnerDocument, setParent, setPrefix | 
| Methods inherited from class java.lang.Object | 
| clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait | 
| Methods inherited from interface javax.xml.soap.SOAPElement | 
| addAttribute, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle | 
| Methods inherited from interface javax.xml.soap.Node | 
| detachNode, getParentElement, getValue, recycleNode, setValue | 
| Methods inherited from interface org.w3c.dom.Node | 
| 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 | 
| Constructor Detail | 
public SOAPHeader(java.lang.String namespace,
                  java.lang.String localPart,
                  java.lang.String prefix,
                  org.xml.sax.Attributes attributes,
                  DeserializationContext context,
                  SOAPConstants soapConsts)
           throws AxisFault
| Method Detail | 
public void setParentElement(SOAPElement parent)
                      throws SOAPException
NodeNode object to the given
 SOAPElement object.
setParentElement in interface NodesetParentElement in class NodeImplparent - the SOAPElement object to be set as
               the parent of this Node object
SOAPException - if there is a problem in setting the
                                      parent to the given elementgetParentElement()
public SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException
SOAPHeaderSOAPHeaderElement object
 initialized with the specified name and adds it to this
 SOAPHeader object.
addHeaderElement in interface SOAPHeadername - a Name object with
     the name of the new SOAPHeaderElement
     object
SOAPHeaderElement object that
     was inserted into this SOAPHeader
     object
SOAPException - if a SOAP error occurspublic java.util.Iterator examineHeaderElements(java.lang.String actor)
SOAPHeaderSOAPHeaderElement
 objects in this SOAPHeader object that have the
 the specified actor. An actor is a global attribute that
 indicates the intermediate parties to whom the message should
 be sent. An actor receives the message and then sends it to
 the next actor. The default actor is the ultimate intended
 recipient for the message, so if no actor attribute is
 included in a SOAPHeader object, the message is
 sent to its ultimate destination.
examineHeaderElements in interface SOAPHeaderactor - a String giving the
     URI of the actor for which to search
Iterator object over all the 
     SOAPHeaderElement objects that contain the
     specified actorextractHeaderElements(java.lang.String)public java.util.Iterator extractHeaderElements(java.lang.String actor)
SOAPHeaderSOAPHeaderElement
   objects in this SOAPHeader object that have
   the the specified actor and detaches them from this 
   SOAPHeader object.
   This method allows an actor to process only the parts of
   the SOAPHeader object that apply to it and to
   remove them before passing the message on to the next
   actor.
extractHeaderElements in interface SOAPHeaderactor - a String giving the
     URI of the actor for which to search
Iterator object over all the 
     SOAPHeaderElement objects that contain the
     specified actorexamineHeaderElements(java.lang.String)public java.util.Iterator examineMustUnderstandHeaderElements(java.lang.String actor)
SOAPHeaderIterator over all the
 SOAPHeaderElement objects in this SOAPHeader
 object that have the specified actor and that have a MustUnderstand
 attribute whose value is equivalent to true.
examineMustUnderstandHeaderElements in interface SOAPHeaderactor - a String giving the URI of the actor for which
              to search
Iterator object over all the
              SOAPHeaderElement objects that contain the
              specified actor and are marked as MustUnderstandpublic java.util.Iterator examineAllHeaderElements()
SOAPHeaderIterator over all the
 SOAPHeaderElement objects in this SOAPHeader
 object.
examineAllHeaderElements in interface SOAPHeaderIterator object over all the
              SOAPHeaderElement objects contained by this
              SOAPHeaderpublic java.util.Iterator extractAllHeaderElements()
SOAPHeaderIterator over all the
 SOAPHeaderElement objects in this SOAPHeader 
 object and detaches them from this SOAPHeader object.
extractAllHeaderElements in interface SOAPHeaderIterator object over all the
              SOAPHeaderElement objects contained by this
              SOAPHeader
protected void outputImpl(SerializationContext context)
                   throws java.lang.Exception
MessageElement
outputImpl in class MessageElementcontext - destination.
java.lang.Exception - if something went wrong.
public void addChild(MessageElement element)
              throws SOAPException
MessageElement
addChild in class MessageElementSOAPException
public SOAPElement addChildElement(SOAPElement element)
                            throws SOAPException
SOAPElementSOAPElement as a child of this
 SOAPElement instance. The SOAPElement
 is expected to be created by a
 SOAPElementFactory. Callers should not rely on the
 element instance being added as is into the XML
 tree. Implementations could end up copying the content
 of the SOAPElement passed into an instance of
 a different SOAPElement implementation. For
 instance if addChildElement() is called on a
 SOAPHeader, element will be copied
 into an instance of a SOAPHeaderElement.
 The fragment rooted in element is either added
 as a whole or not at all, if there was an error.
 
The fragment rooted in element cannot contain
 elements named "Envelope", "Header" or "Body" and in the SOAP
 namespace. Any namespace prefixes present in the fragment
 should be fully resolved using appropriate namespace
 declarations within the fragment itself.
addChildElement in interface SOAPElementaddChildElement in class MessageElementSOAPExceptionSOAPElement.addChildElement(javax.xml.soap.SOAPElement)
public SOAPElement addChildElement(Name name)
                            throws SOAPException
SOAPElementSOAPElement object initialized with the
 given Name object and adds the new element to this
 SOAPElement object.
addChildElement in interface SOAPElementaddChildElement in class MessageElementname - uri, prefix and local name of the element to add
SOAPExceptionSOAPElement.addChildElement(javax.xml.soap.Name)
public SOAPElement addChildElement(java.lang.String localName)
                            throws SOAPException
SOAPElementSOAPElement object initialized with the
 given String object and adds the new element to this
 SOAPElement object.
addChildElement in interface SOAPElementaddChildElement in class MessageElementlocalName - 
SOAPExceptionSOAPElement.addChildElement(String)
public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix)
                            throws SOAPException
SOAPElementSOAPElement object initialized with the
 specified local name and prefix and adds the new element to this
 SOAPElement object.
addChildElement in interface SOAPElementaddChildElement in class MessageElementlocalName - prefix - 
SOAPExceptionSOAPElement.addChildElement(String, String)
public SOAPElement addChildElement(java.lang.String localName,
                                   java.lang.String prefix,
                                   java.lang.String uri)
                            throws SOAPException
SOAPElementSOAPElement object initialized with the
 specified local name, prefix, and URI and adds the new element to this
 SOAPElement object.
addChildElement in interface SOAPElementaddChildElement in class MessageElementlocalName - prefix - uri - 
SOAPExceptionSOAPElement.addChildElement(String, String, String)
public org.w3c.dom.Node appendChild(org.w3c.dom.Node newChild)
                             throws org.w3c.dom.DOMException
NodeImplnewChild to the end of the list of children
 of this node. If the newChild is already in the tree, it
 is first removed.
appendChild in interface org.w3c.dom.NodeappendChild in class NodeImplnewChild - The node to add.If it is a
                 DocumentFragment object, the entire contents of the
                 document fragment are moved into the child list of this node
org.w3c.dom.DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not
                                  allow children of the type of the newChild node, or if
                                  the node to append is one of this node's ancestors or this node
                                  itself.
                                  newChild was created
                                  from a different document than the one that created this node.
                                  | 
 | |||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||