|
Oracle Security Developer Tools XML Security Java API Reference 11g (11.1.1) E10680-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.xmlsec.util.XMLNode
oracle.security.xmlsec.util.XMLElement
oracle.security.xmlsec.soap.v11.SOAPEnvelope
public class SOAPEnvelope
A SOAP v1.1 Envelope element. The envelope contains a required Body child element and an optional Header child element.
SOAPFault
Field Summary |
---|
Fields inherited from class oracle.security.xmlsec.util.XMLNode |
---|
node, systemId |
Constructor Summary | |
---|---|
SOAPEnvelope(org.w3c.dom.Document owner) Creates a new v1.1 SOAPEnvelope instance in the given owner document, but does not appended the Envelope element to the document node. |
|
SOAPEnvelope(org.w3c.dom.Element env) Creates a SOAPEnvelope instance for the given SOAP-ENV:Envelope element. |
|
SOAPEnvelope(org.w3c.dom.Element env, java.lang.String systemId) Creates a SOAPEnvelope instance for the given SOAP-ENV:Envelope element. |
Method Summary | |
---|---|
void |
addBodyElement(org.w3c.dom.Element bodyElement) Add a body entry to the Body child of this SOAP Envelope. |
void |
addBodyElement(XMLElement bodyElement) Add a body entry to the Body child of this SOAP Envelope. |
void |
addHeaderElement(org.w3c.dom.Element headerElement) Adds a header entry to the Header child of this SOAP Envelope. |
void |
addHeaderElement(XMLElement headerElement) Add a header entry to the Header child of this SOAP Envelope. |
SOAPFault |
addSOAPFault(java.lang.String faultCode, java.lang.String faultString) Create a new SOAP-ENV:Fault element with the given fault code and fault string and add it to the Body child of this SOAP Envelope. |
org.w3c.dom.Element |
getBody() Get the Body child element of this SOAP Envelope. |
java.util.List |
getBodyElements() Get all the Body entries in the Body child element of the this SOAP Envelope. |
java.util.List |
getBodyElementsByTagNameNS(java.lang.String nsURI, java.lang.String localName) Get all the Body entries with the given namespace URI and local name in the Body child element of the this SOAP Envelope. |
org.w3c.dom.Element |
getHeader() Get the Header child element of this SOAP Envelope. |
java.util.List |
getHeaderElements() Get all the Header entries in the Header child element of this SOAP Envelope. |
java.util.List |
getHeaderElements(boolean mustUnderstand) Get all the Header entries in the Header element for the given mustUnderstand setting. |
java.util.List |
getHeaderElements(java.lang.String actor) Get all the Header entries in the Header element for the given actor. |
SOAPFault |
getSOAPFault() Get the SOAP-ENV:Fault body element in this SOAP Envelope. |
Methods inherited from class oracle.security.xmlsec.util.XMLNode |
---|
appendChild, appendChild, appendTo, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNode, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getSystemId, hasAttributes, hasChildNodes, insertBefore, insertBefore, isSupported, normalize, removeChild, removeChild, replaceChild, replaceChild, setNodeValue, setPrefix, setSystemId, toBytesXML, toStringXML |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SOAPEnvelope(org.w3c.dom.Document owner) throws org.w3c.dom.DOMException
SOAPEnvelope
instance in the given owner document, but does not appended the Envelope element to the document node. The default prefix for the SOAP Envelope namespace is used, and a SOAP-ENV:Body child element is also created.
owner
- The document to contain the SOAP-ENV:Envelope.org.w3c.dom.DOMException
public SOAPEnvelope(org.w3c.dom.Element env) throws org.w3c.dom.DOMException
SOAPEnvelope
instance for the given SOAP-ENV:Envelope element.
env
- A SOAP Envelope element.org.w3c.dom.DOMException
public SOAPEnvelope(org.w3c.dom.Element env, java.lang.String systemId) throws org.w3c.dom.DOMException
SOAPEnvelope
instance for the given SOAP-ENV:Envelope element.
env
- A SOAP Envelope element.systemId
- The URI string system ID for the SOAPEnvelope
.org.w3c.dom.DOMException
Method Detail |
---|
public void addHeaderElement(org.w3c.dom.Element headerElement) throws org.w3c.dom.DOMException
headerElement
- An XML element specifies a header entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addHeaderElement(XMLElement headerElement) throws org.w3c.dom.DOMException
headerElement
- An XMLElement that specifies a header entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addBodyElement(org.w3c.dom.Element bodyElement) throws org.w3c.dom.DOMException
bodyElement
- A XML element specifies a body entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public void addBodyElement(XMLElement bodyElement) throws org.w3c.dom.DOMException
bodyElement
- An XMLElement
object specifies a body entry (block) for this SOAP Envelope.org.w3c.dom.DOMException
public SOAPFault addSOAPFault(java.lang.String faultCode, java.lang.String faultString) throws org.w3c.dom.DOMException
faultCode
- A string that specifies the text value of the faultcode element.faultString
- A string that specifies the human-readable text value of the faultstring element.XMLSOAPFault
instance created.org.w3c.dom.DOMException
public org.w3c.dom.Element getHeader()
null
if the Header is not specified.public java.util.List getHeaderElements()
List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope.public java.util.List getHeaderElements(java.lang.String actor)
actor
- A URI string specifying the actor of the header entries.List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope with the specified actor or role attribute value.public java.util.List getHeaderElements(boolean mustUnderstand)
role
- A boolean specifying the mustUnderstand value of the header entries.List
of org.w3c.dom.Element
s for all the header entries in this SOAP Envelope with the specified SOAP-ENV:mustUnderstand attribute value.public org.w3c.dom.Element getBody()
null
if none is present.public java.util.List getBodyElements()
List
of XML element for all the Body entries in this SOAP Envelope.public java.util.List getBodyElementsByTagNameNS(java.lang.String nsURI, java.lang.String localName)
nsURI
- The namespace URI of the elements to match on. The special value "*" matches all namespaces.localName
- The local name of the elements to match on. The special value "*" matches all local names.List
of XML elements for all matched the Body entries.public SOAPFault getSOAPFault()
SOAPFault
instance, or null
if no SOAP-ENV:Fault entry is present in the Body child.
|
Oracle Security Developer Tools XML Security Java API Reference 11g (11.1.1) E10680-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |