|
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.SOAPFault
public class SOAPFault
A SOAP 1.1 Fault element.
A SOAP Fault element contains mandatory faultcode and faultstring child elements, and optional faultactor and detail child elements.
SOAPEnvelope
Field Summary | |
---|---|
static java.lang.String |
Client Fault Code "Client" |
static java.lang.String |
MustUnderstand Fault Code "MustUnderstand" |
static java.lang.String |
Server Fault Code "Server" |
static java.lang.String |
VersionMismatch Fault Code "VersionMismatch" |
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 SOAP-ENV:Fault element. |
|
SOAPFault(org.w3c.dom.Element soapFault, java.lang.String systemId) Create a SOAPFault instance from the given SOAP-ENV:Fault element. |
Method Summary | |
---|---|
void |
addDetailEntry(org.w3c.dom.Element detailEntry) Add a detail entry to this Fault elemet. |
org.w3c.dom.Element |
getDetail() Return the detail child element which contains details entries carrying specific error information related to the Body element. |
java.util.List |
getDetailElements() Return all the detail entries in the detail child element. |
java.lang.String |
getFaultActor() Get the faultactor value. |
java.lang.String |
getFaultCode() Return the fault code QName string. |
java.lang.String |
getFaultString() Get the fault string value. |
void |
setFaultActor(java.lang.String actorURI) Set the faultactor child with the given URI identifying the source of the fault. |
void |
setFaultCode(java.lang.String localPart) Set the faultcode child in this Fault element with the given fault code, which will be qualified with this SOAP-ENV:Fault's namespace prefix. |
void |
setFaultCode(java.lang.String localPart, java.lang.String prefix) Set the faultcode child in this Fault element with the given fault code and namespace prefix. |
void |
setFaultCode(java.lang.String localPart, java.lang.String prefix, java.lang.String NS) Set the faultcode child in this Fault element with the given fault code and namespace prefix. |
void |
setFaultString(java.lang.String faultString) Set the faultstring child element with the given fault string. |
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 |
Field Detail |
---|
public static final java.lang.String VersionMismatch
public static final java.lang.String MustUnderstand
public static final java.lang.String Client
public static final java.lang.String Server
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 SOAP-ENV:Fault element.
soapFault
- A SOAP-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 SOAP-ENV:Fault element.
soapFault
- A SOAP-ENV:Fault
element.systemId
- The URI string system ID for the XMLSOAPFault
.org.w3c.dom.DOMException
Method Detail |
---|
public void setFaultCode(java.lang.String localPart) throws org.w3c.dom.DOMException
localPart
- A string specifying the local (unqualified) part of the fault code QName.org.w3c.dom.DOMException
VersionMismatch
, MustUnderstand
, Client
, Server
public void setFaultCode(java.lang.String localPart, java.lang.String prefix) throws org.w3c.dom.DOMException
localPart
- A string specifying the local (unqualified) part of the fault code QName.prefix
- A string specifying the namespace prefix for the fault code QName. If null
, the Fault element's prefix will be used.org.w3c.dom.DOMException
VersionMismatch
, MustUnderstand
, Client
, Server
public void setFaultCode(java.lang.String localPart, java.lang.String prefix, java.lang.String NS) throws org.w3c.dom.DOMException
localPart
- A string specifying the local (unqualified) part of the fault code QName.prefix
- A string specifying the namespace prefix for the fault code QName. If null
, the Fault element's prefix will be used.NS
- A string specifying the namespace definitionorg.w3c.dom.DOMException
VersionMismatch
, MustUnderstand
, Client
, Server
public java.lang.String getFaultCode()
null
if not specified.public void setFaultString(java.lang.String faultString) throws org.w3c.dom.DOMException
faultString
- fault string value which provide a human readable explaination of fault.org.w3c.dom.DOMException
public java.lang.String getFaultString()
public void setFaultActor(java.lang.String actorURI) throws org.w3c.dom.DOMException
actorURI
- A URI string identifying the source of fault.org.w3c.dom.DOMException
public java.lang.String getFaultActor()
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()
null
if it is not present.public java.util.List getDetailElements()
List
of org.w3c.dom.Element
s representing the detail entries.
|
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 |