org.apache.axiom.soap.impl.llom.soap11
Class SOAP11HeaderBlockImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.llom.OMSerializableImpl
      extended by org.apache.axiom.om.impl.llom.OMNodeImpl
          extended by org.apache.axiom.om.impl.llom.OMElementImpl
              extended by org.apache.axiom.om.impl.llom.OMSourcedElementImpl
                  extended by org.apache.axiom.soap.impl.llom.SOAPHeaderBlockImpl
                      extended by org.apache.axiom.soap.impl.llom.soap11.SOAP11HeaderBlockImpl
All Implemented Interfaces:
OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, OMSerializable, OMSourcedElement, SOAPHeaderBlock

public class SOAP11HeaderBlockImpl
extends SOAPHeaderBlockImpl


Field Summary
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
nextSibling, nodeType, parent, previousSibling
 
Fields inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl
builder, done, factory
 
Fields inherited from interface org.apache.axiom.soap.SOAPHeaderBlock
MUST_UNDERSTAND_PROPERTY, RELAY_PROPERTY, ROLE_PROPERTY
 
Fields inherited from interface org.apache.axiom.om.OMNode
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
 
Fields inherited from interface org.apache.axiom.om.OMConstants
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
 
Constructor Summary
SOAP11HeaderBlockImpl(String localName, OMNamespace ns, OMElement parent, OMXMLParserWrapper builder, SOAPFactory factory)
          Constructor SOAPHeaderBlockImpl
SOAP11HeaderBlockImpl(String localName, OMNamespace ns, SOAPFactory factory)
           
SOAP11HeaderBlockImpl(String localName, OMNamespace ns, SOAPFactory factory, OMDataSource ds)
           
SOAP11HeaderBlockImpl(String localName, OMNamespace ns, SOAPHeader parent, SOAPFactory factory)
           
 
Method Summary
protected  void checkParent(OMElement parent)
           
 boolean getMustUnderstand()
          Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on.
 boolean getRelay()
          Returns the relay status associated with this SOAPHeaderBlock object.
 String getRole()
          Returns the uri of the actor associated with this SOAPHeaderBlock object.
 SOAPVersion getVersion()
          What SOAP version is this HeaderBlock?
 void setMustUnderstand(boolean mustUnderstand)
          Sets the mustUnderstand attribute for this SOAPHeaderBlock object to be on or off.
 void setMustUnderstand(String mustUnderstand)
           
 void setRelay(boolean relay)
          Sets the relay attribute for this SOAPHeaderBlock to be either true or false.
 void setRole(String roleURI)
          Sets the actor associated with this SOAPHeaderBlock object to the specified actor.
 
Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPHeaderBlockImpl
getAttribute, getOMDataSourceProperty, hasOMDataSourceProperty, isProcessed, setAttribute, setProcessed
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMSourcedElementImpl
addAttribute, addAttribute, addChild, build, buildNext, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDataSource, getDefaultNamespace, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getNextOMSibling, getNextOMSiblingIfAvailable, getQName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, isComplete, isExpanded, notifyChildComplete, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setComplete, setDataSource, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl
getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling, setType
 
Methods inherited from class org.apache.axiom.om.impl.llom.OMSerializableImpl
close, getOMFactory, serialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.axiom.om.OMSourcedElement
getDataSource, isExpanded, setDataSource
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getQName, getText, getTextAsQName, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
 
Methods inherited from interface org.apache.axiom.om.OMNode
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore
 
Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching
 
Methods inherited from interface org.apache.axiom.om.OMSerializable
build, close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume
 

Constructor Detail

SOAP11HeaderBlockImpl

public SOAP11HeaderBlockImpl(String localName,
                             OMNamespace ns,
                             SOAPFactory factory)

SOAP11HeaderBlockImpl

public SOAP11HeaderBlockImpl(String localName,
                             OMNamespace ns,
                             SOAPFactory factory,
                             OMDataSource ds)

SOAP11HeaderBlockImpl

public SOAP11HeaderBlockImpl(String localName,
                             OMNamespace ns,
                             SOAPHeader parent,
                             SOAPFactory factory)
                      throws SOAPProcessingException
Parameters:
localName -
ns -
Throws:
SOAPProcessingException

SOAP11HeaderBlockImpl

public SOAP11HeaderBlockImpl(String localName,
                             OMNamespace ns,
                             OMElement parent,
                             OMXMLParserWrapper builder,
                             SOAPFactory factory)
Constructor SOAPHeaderBlockImpl

Parameters:
localName -
ns -
parent -
builder -
Method Detail

checkParent

protected void checkParent(OMElement parent)
                    throws SOAPProcessingException
Throws:
SOAPProcessingException

setRole

public void setRole(String roleURI)
Description copied from interface: SOAPHeaderBlock
Sets the actor associated with this SOAPHeaderBlock object to the specified actor.

Parameters:
roleURI - a String giving the URI of the actor to set
See Also:
getRole()

getRole

public String getRole()
Description copied from interface: SOAPHeaderBlock
Returns the uri of the actor associated with this SOAPHeaderBlock object.

Returns:
a String giving the URI of the actor
See Also:
setRole(java.lang.String)

setMustUnderstand

public void setMustUnderstand(boolean mustUnderstand)
Description copied from interface: SOAPHeaderBlock
Sets the mustUnderstand attribute for this SOAPHeaderBlock object to be on or off.

If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderBlock must process it correctly. This ensures, for example, that if the SOAPHeaderBlock object modifies the message, that the message is being modified correctly.

Parameters:
mustUnderstand - true to set the mustUnderstand attribute on; false to turn if off
See Also:
getMustUnderstand()

setMustUnderstand

public void setMustUnderstand(String mustUnderstand)
                       throws SOAPProcessingException
Throws:
SOAPProcessingException

getMustUnderstand

public boolean getMustUnderstand()
                          throws SOAPProcessingException
Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on.

Returns:
true if the mustUnderstand attribute of this SOAPHeaderBlock object is turned on; false otherwise
Throws:
SOAPProcessingException

setRelay

public void setRelay(boolean relay)
Description copied from interface: SOAPHeaderBlock
Sets the relay attribute for this SOAPHeaderBlock to be either true or false. The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it.

Parameters:
relay - a boolean giving the value to be set

getRelay

public boolean getRelay()
Description copied from interface: SOAPHeaderBlock
Returns the relay status associated with this SOAPHeaderBlock object.

Returns:
a boolean giving the relay status

getVersion

public SOAPVersion getVersion()
Description copied from interface: SOAPHeaderBlock
What SOAP version is this HeaderBlock?

Returns:
a SOAPVersion, one of the two singletons.


Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.