|
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.v12.SOAPFault
public class SOAPFault
A SOAP 1.2 Fault element.
A SOAP Fault element contains mandatory Code and Reason child elements, and optional Role, Node and Detail child elements
SOAPEnvelope
Field Summary |
---|
Fields inherited from class oracle.security.xmlsec.util.XMLNode |
---|
node, systemId |
Constructor Summary | |
---|---|
SOAPFault(org.w3c.dom.Document owner) Create a new SOAPFault instance in the given owner document, but does not appended the Fault element to the document node. |
|
SOAPFault(org.w3c.dom.Element soapFault) Create a SOAPFault instance from the given env:Fault element. |
|
SOAPFault(org.w3c.dom.Element soapFault, java.lang.String systemId) Create a SOAPFault instance from the given env:Fault element. |
Method Summary | |
---|---|
void |
addDetailEntry(org.w3c.dom.Element detailEntry) Add a detail entry to this env:Fault element. |
void |
addReasonText(java.lang.String reasonText, java.lang.String reasonLang) Appends an env:Text element to this SOAPFault's env:Reason element (creating one if necessary). |
SOAPFaultCode |
getCode() Return the env:Code element. |
org.w3c.dom.Element |
getDetail() Returns the env:Detail element, which contains entries carrying specific error information related to the Body element. |
org.w3c.dom.NodeList |
getDetailEntries() Return the detail entries in this env:Fault's env:Detail element. |
java.lang.String |
getFaultNode() Get the env:Node URI string value. |
org.w3c.dom.NodeList |
getReasonTexts() Get the fault reason's env:Text nodes. |
java.lang.String |
getRole() Get the env:Role URI string value. |
void |
setCode(SOAPFaultCode faultCode) Sets the env:Code element for this env:Fault. |
void |
setFaultNode(java.lang.String nodeURI) Set the env:Node element with the given URI identifying the source of the fault. |
void |
setReason(java.util.List reasonText, java.util.List reasonLang) Set the env:Reason child element with the given env:Text contents. |
void |
setRole(java.lang.String roleURI) Set the env:Role element with the given URI identifying the role of the source of the fault. |
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 SOAPFault(org.w3c.dom.Document owner) throws org.w3c.dom.DOMException
SOAPFault
instance in the given owner document, but does not appended the Fault element to the document node.
owner
- The document to contain the new SOAPFault
.org.w3c.dom.DOMException
public SOAPFault(org.w3c.dom.Element soapFault) throws org.w3c.dom.DOMException
SOAPFault
instance from the given env:Fault element.
soapFault
- A env:Fault
element.org.w3c.dom.DOMException
public SOAPFault(org.w3c.dom.Element soapFault, java.lang.String systemId) throws org.w3c.dom.DOMException
SOAPFault
instance from the given env:Fault element.
soapFault
- A env:Fault
element.systemId
- The URI string system ID for the SOAPFault
.org.w3c.dom.DOMException
Method Detail |
---|
public void setCode(SOAPFaultCode faultCode) throws org.w3c.dom.DOMException
faultCode
- The SOAPFaultCode
element.org.w3c.dom.DOMException
public SOAPFaultCode getCode()
SOAPFaultCode
, or null
if not specified.public void addReasonText(java.lang.String reasonText, java.lang.String reasonLang) throws org.w3c.dom.DOMException
reasonText
- The text value of the env:Text element.reasonLang
- The xml:lang attribute value for the env:Text element.org.w3c.dom.DOMException
public void setReason(java.util.List reasonText, java.util.List reasonLang) throws org.w3c.dom.DOMException
reasonText
- List of fault reason text string values which provide a human readable explaination of fault.reasonLang
- List of corresponding xml:lang attribute string values.org.w3c.dom.DOMException
public org.w3c.dom.NodeList getReasonTexts()
NodeList
of env:Text Element
s. Each env:Text element in the result has a child text node containing the reason string and an xml:lang attribute specifying the language of the reason string.public void setFaultNode(java.lang.String nodeURI) throws org.w3c.dom.DOMException
nodeURI
- A URI string identifying the source of the fault.org.w3c.dom.DOMException
public java.lang.String getFaultNode()
null
if none is present.public void setRole(java.lang.String roleURI) throws org.w3c.dom.DOMException
roleURI
- A URI string identifying the role of the source of the fault.org.w3c.dom.DOMException
XMLURI.uri_soap12_role_none
, XMLURI.uri_soap12_role_next
, XMLURI.uri_soap12_role_ultimateReceiver
public java.lang.String getRole()
null
if none is present.public void addDetailEntry(org.w3c.dom.Element detailEntry) throws org.w3c.dom.DOMException
detailEntry
- A namespace qualified element carrying certain specific error information related to the Body element.org.w3c.dom.DOMException
public org.w3c.dom.Element getDetail()
Element
, or null
if it is not present.public org.w3c.dom.NodeList getDetailEntries()
NodeList
of Element
s.
|
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 |