org.apache.axiom.soap.impl.llom.soap12
Class SOAP12HeaderBlockImpl
java.lang.Object
org.apache.axiom.om.impl.llom.OMSerializableImpl
org.apache.axiom.om.impl.llom.OMNodeImpl
org.apache.axiom.om.impl.llom.OMElementImpl
org.apache.axiom.om.impl.llom.OMSourcedElementImpl
org.apache.axiom.soap.impl.llom.SOAPHeaderBlockImpl
org.apache.axiom.soap.impl.llom.soap12.SOAP12HeaderBlockImpl
- All Implemented Interfaces:
- OMContainerEx, OMNodeEx, OMConstants, OMContainer, OMElement, OMNode, OMSerializable, OMSourcedElement, SOAP12Constants, SOAPConstants, SOAPHeaderBlock
public class SOAP12HeaderBlockImpl
- extends SOAPHeaderBlockImpl
- implements SOAP12Constants
Fields inherited from interface org.apache.axiom.soap.SOAP12Constants |
FAULT_CODE_RECEIVER, FAULT_CODE_SENDER, QNAME_FAULT_CODE, QNAME_FAULT_DETAIL, QNAME_FAULT_NODE, QNAME_FAULT_REASON, QNAME_FAULT_ROLE, QNAME_FAULT_SUBCODE, QNAME_FAULT_TEXT, QNAME_FAULT_VALUE, QNAME_MU_FAULTCODE, QNAME_RECEIVER_FAULTCODE, QNAME_RELAY, QNAME_ROLE, QNAME_SENDER_FAULTCODE, SOAP_12_CONTENT_TYPE, SOAP_ENCODING_NAMESPACE_URI, SOAP_ENVELOPE_NAMESPACE_URI, SOAP_FAULT_CODE_LOCAL_NAME, SOAP_FAULT_DETAIL_LOCAL_NAME, SOAP_FAULT_NODE_LOCAL_NAME, SOAP_FAULT_REASON_LOCAL_NAME, SOAP_FAULT_ROLE_LOCAL_NAME, SOAP_FAULT_SUB_CODE_LOCAL_NAME, SOAP_FAULT_TEXT_LANG_ATTR_LOCAL_NAME, SOAP_FAULT_TEXT_LANG_ATTR_NS_PREFIX, SOAP_FAULT_TEXT_LANG_ATTR_NS_URI, SOAP_FAULT_TEXT_LOCAL_NAME, SOAP_FAULT_VALUE_DATA_ENCODING_UKNOWN, SOAP_FAULT_VALUE_LOCAL_NAME, SOAP_FAULT_VALUE_MUST_UNDERSTAND, SOAP_FAULT_VALUE_RECEIVER, SOAP_FAULT_VALUE_SENDER, SOAP_FAULT_VALUE_VERSION_MISMATCH, SOAP_RELAY, SOAP_ROLE, SOAP_ROLE_NEXT, SOAP_ROLE_NONE, SOAP_ROLE_ULTIMATE_RECEIVER |
Fields inherited from interface org.apache.axiom.soap.SOAPConstants |
ATTR_MUSTUNDERSTAND, ATTR_MUSTUNDERSTAND_0, ATTR_MUSTUNDERSTAND_1, ATTR_MUSTUNDERSTAND_FALSE, ATTR_MUSTUNDERSTAND_TRUE, BODY_FAULT_LOCAL_NAME, BODY_LOCAL_NAME, BODY_NAMESPACE_PREFIX, FAULT_CODE_DATA_ENCODING_UNKNOWN, FAULT_CODE_MUST_UNDERSTAND, FAULT_CODE_VERSION_MISMATCH, HEADER_LOCAL_NAME, SOAP_DEFAULT_NAMESPACE_PREFIX, SOAP_FAULT_DETAIL_EXCEPTION_ENTRY, SOAPBODY_FIRST_CHILD_ELEMENT_QNAME, SOAPENVELOPE_LOCAL_NAME, SOAPFAULT_DETAIL_LOCAL_NAME, SOAPFAULT_LOCAL_NAME |
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 |
SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPFactory factory)
|
SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPFactory factory,
OMDataSource ds)
|
SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPHeader parent,
OMXMLParserWrapper builder,
SOAPFactory factory)
Constructor SOAPHeaderBlockImpl |
SOAP12HeaderBlockImpl(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.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 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.OMContainer |
addChild, buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching |
SOAP12HeaderBlockImpl
public SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPFactory factory)
SOAP12HeaderBlockImpl
public SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPFactory factory,
OMDataSource ds)
SOAP12HeaderBlockImpl
public SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPHeader parent,
SOAPFactory factory)
throws SOAPProcessingException
- Parameters:
localName
- ns
-
- Throws:
SOAPProcessingException
SOAP12HeaderBlockImpl
public SOAP12HeaderBlockImpl(String localName,
OMNamespace ns,
SOAPHeader parent,
OMXMLParserWrapper builder,
SOAPFactory factory)
- Constructor SOAPHeaderBlockImpl
- Parameters:
localName
- ns
- parent
- builder
-
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.
- Specified by:
setRole
in interface SOAPHeaderBlock
- 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.
- Specified by:
getRole
in interface SOAPHeaderBlock
- 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.
- Specified by:
setMustUnderstand
in interface SOAPHeaderBlock
- 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
- Specified by:
setMustUnderstand
in interface SOAPHeaderBlock
- Throws:
SOAPProcessingException
getMustUnderstand
public boolean getMustUnderstand()
throws SOAPProcessingException
- Description copied from interface:
SOAPHeaderBlock
- Returns whether the mustUnderstand attribute for this
SOAPHeaderBlock
object is
turned on.
- Specified by:
getMustUnderstand
in interface SOAPHeaderBlock
- 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.
- Specified by:
setRelay
in interface SOAPHeaderBlock
- 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.
- Specified by:
getRelay
in interface SOAPHeaderBlock
- Returns:
- a
boolean
giving the relay status
getVersion
public SOAPVersion getVersion()
- What SOAP version is this HeaderBlock?
- Specified by:
getVersion
in interface SOAPHeaderBlock
- Returns:
- a SOAPVersion, one of the two singletons.
Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.