Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.axis.message.NodeImpl
org.apache.axis.message.MessageElement
org.apache.axis.message.SOAPHeader
Nested Class Summary |
Nested classes/interfaces 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 , log , message , namespaces , qNameAttrs , recorder , startContentsIndex , startEventIndex , typeQName |
Fields inherited from class org.apache.axis.message.NodeImpl | |
_isDirty , attributes , children , document , log , name , namespaceURI , parent , prefix , textRep |
Constructor Summary | |
|
Method Summary | |
void |
|
SOAPElement |
|
SOAPElement |
|
SOAPElement |
|
SOAPElement |
|
SOAPElement |
|
SOAPHeaderElement |
|
Node |
|
Iterator |
|
Iterator |
|
Iterator |
|
Iterator |
|
Iterator |
|
protected void |
|
void |
|
public SOAPHeader(String namespace, String localPart, String prefix, Attributes attributes, DeserializationContext context, SOAPConstants soapConsts) throws AxisFault
public void addChild(MessageElement element) throws SOAPException
Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.
- Overrides:
- addChild in interface MessageElement
public SOAPElement addChildElement(String localName) throws SOAPException
Creates a newSOAPElement
object initialized with the givenString
object and adds the new element to thisSOAPElement
object.
- Specified by:
- addChildElement in interface SOAPElement
- Overrides:
- addChildElement in interface MessageElement
- Parameters:
localName
- aString
giving the local name for the element
- Returns:
- the new
SOAPElement
object that was created
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
public SOAPElement addChildElement(String localName, String prefix) throws SOAPException
Creates a newSOAPElement
object initialized with the specified local name and prefix and adds the new element to thisSOAPElement
object.
- Specified by:
- addChildElement in interface SOAPElement
- Overrides:
- addChildElement in interface MessageElement
- Parameters:
localName
- aString
giving the local name for the new elementprefix
- aString
giving the namespace prefix for the new element
- Returns:
- the new
SOAPElement
object that was created
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
public SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException
Creates a newSOAPElement
object initialized with the specified local name, prefix, and URI and adds the new element to thisSOAPElement
object.
- Specified by:
- addChildElement in interface SOAPElement
- Overrides:
- addChildElement in interface MessageElement
- Parameters:
localName
- aString
giving the local name for the new elementprefix
- aString
giving the namespace prefix for the new elementuri
- aString
giving the URI of the namespace to which the new element belongs
- Returns:
- the new
SOAPElement
object that was created
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
public SOAPElement addChildElement(Name name) throws SOAPException
Creates a newSOAPElement
object initialized with the givenName
object and adds the new element to thisSOAPElement
object.
- Specified by:
- addChildElement in interface SOAPElement
- Overrides:
- addChildElement in interface MessageElement
- Parameters:
name
- aName
object with the XML name for the new element
- Returns:
- the new
SOAPElement
object that was created
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object
public SOAPElement addChildElement(SOAPElement element) throws SOAPException
Add aSOAPElement
as a child of thisSOAPElement
instance. TheSOAPElement
is expected to be created by aSOAPElementFactory
. Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of theSOAPElement
passed into an instance of a differentSOAPElement
implementation. For instance ifaddChildElement()
is called on aSOAPHeader
,element
will be copied into an instance of aSOAPHeaderElement
. The fragment rooted inelement
is either added as a whole or not at all, if there was an error. The fragment rooted inelement
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.
- Specified by:
- addChildElement in interface SOAPElement
- Overrides:
- addChildElement in interface MessageElement
- Parameters:
element
- theSOAPElement
to be added as a new child
- Returns:
- an instance representing the new SOAP element that was actually added to the tree.
- Throws:
SOAPException
- if there was an error in adding this element as a child
public SOAPHeaderElement addHeaderElement(Name name) throws SOAPException
Creates a newSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.
- Specified by:
- addHeaderElement in interface SOAPHeader
- Parameters:
name
- aName
object with the name of the newSOAPHeaderElement
object
- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object
- Throws:
SOAPException
- if a SOAP error occurs
public Node appendChild(Node newChild) throws DOMException
- Overrides:
- appendChild in interface NodeImpl
public Iterator examineAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object.
- Specified by:
- examineAllHeaderElements in interface SOAPHeader
- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
public Iterator examineHeaderElements(String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
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 aSOAPHeader
object, the message is sent to its ultimate destination.
- Specified by:
- examineHeaderElements in interface SOAPHeader
- Parameters:
actor
- aString
giving the URI of the actor for which to search
- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor
- See Also:
extractHeaderElements(java.lang.String)
public Iterator examineMustUnderstandHeaderElements(String actor)
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent totrue
.
- Specified by:
- examineMustUnderstandHeaderElements in interface SOAPHeader
- Parameters:
actor
- aString
giving the URI of the actor for which to search
- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor and are marked as MustUnderstand
public Iterator extractAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object and detaches them from thisSOAPHeader
object.
- Specified by:
- extractAllHeaderElements in interface SOAPHeader
- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
public Iterator extractHeaderElements(String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the the specified actor and detaches them from thisSOAPHeader
object. This method allows an actor to process only the parts of theSOAPHeader
object that apply to it and to remove them before passing the message on to the next actor.
- Specified by:
- extractHeaderElements in interface SOAPHeader
- Parameters:
actor
- aString
giving the URI of the actor for which to search
- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor
- See Also:
examineHeaderElements(java.lang.String)
protected void outputImpl(SerializationContext context) throws Exception
override point -output to a serialization context.
- Overrides:
- outputImpl in interface MessageElement
- Parameters:
public void setParentElement(SOAPElement parent) throws SOAPException
Sets the parent of thisNode
object to the givenSOAPElement
object.
- Specified by:
- setParentElement in interface Node
- Overrides:
- setParentElement in interface NodeImpl
- Parameters:
parent
- theSOAPElement
object to be set as the parent of thisNode
object
- Throws:
SOAPException
- if there is a problem in setting the parent to the given element
- See Also:
getParentElement()