oracle.security.xmlsec.soap.v12

Class SOAPFault

java.lang.Object

oracle.security.xmlsec.util.XMLNode

oracle.security.xmlsec.util.XMLElement

oracle.security.xmlsec.soap.v12.SOAPFault

public class SOAPFault
extends XMLElement

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

Since:

2.3.0

See Also:

SOAPEnvelope

Field Summary

Fields inherited from class oracle.security.xmlsec.util.XMLNode

node, systemId

Constructor Summary

Constructors

Constructor and Description
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

Methods

Modifier and Type	Method and Description
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.XMLElement

addNSPrefixAttr, addNSPrefixAttr, addNSPrefixAttrDefault, addNSPrefixAttrDefault, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getChildElementsByTagName, getChildElementsByTagName, getChildElementsByTagNameNS, getChildElementsByTagNameNS, getDefaultNSPrefix, getElement, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setDefaultNSPrefix

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

SOAPFault

public SOAPFault(org.w3c.dom.Document owner)
          throws org.w3c.dom.DOMException

Create a new SOAPFault instance in the given owner document, but does not appended the Fault element to the document node.

Parameters:

owner - The document to contain the new SOAPFault.

Throws:

org.w3c.dom.DOMException

SOAPFault

public SOAPFault(org.w3c.dom.Element soapFault)
          throws org.w3c.dom.DOMException

Create a SOAPFault instance from the given env:Fault element.

Parameters:

soapFault - A env:Fault element.

Throws:

org.w3c.dom.DOMException

SOAPFault

public SOAPFault(org.w3c.dom.Element soapFault,
         java.lang.String systemId)
          throws org.w3c.dom.DOMException

Create a SOAPFault instance from the given env:Fault element.

Parameters:

soapFault - A env:Fault element.

systemId - The URI string system ID for the SOAPFault.

Throws:

org.w3c.dom.DOMException

Since:

2.0

Method Detail

setCode

public void setCode(SOAPFaultCode faultCode)
             throws org.w3c.dom.DOMException

Sets the env:Code element for this env:Fault.

Parameters:

faultCode - The SOAPFaultCode element.

Throws:

org.w3c.dom.DOMException

getCode

public SOAPFaultCode getCode()

Return the env:Code element.

Returns:

A SOAPFaultCode, or null if not specified.

addReasonText

public void addReasonText(java.lang.String reasonText,
                 java.lang.String reasonLang)
                   throws org.w3c.dom.DOMException

Appends an env:Text element to this SOAPFault's env:Reason element (creating one if necessary).

Parameters:

reasonText - The text value of the env:Text element.

reasonLang - The xml:lang attribute value for the env:Text element.

Throws:

org.w3c.dom.DOMException

setReason

public void setReason(java.util.List reasonText,
             java.util.List reasonLang)
               throws org.w3c.dom.DOMException

Set the env:Reason child element with the given env:Text contents.

Parameters:

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.

Throws:

org.w3c.dom.DOMException

getReasonTexts

public org.w3c.dom.NodeList getReasonTexts()

Get the fault reason's env:Text nodes.

Returns:

A (possibly empty) NodeList of env:Text Elements. 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.

setFaultNode

public void setFaultNode(java.lang.String nodeURI)
                  throws org.w3c.dom.DOMException

Set the env:Node element with the given URI identifying the source of the fault.

Parameters:

nodeURI - A URI string identifying the source of the fault.

Throws:

org.w3c.dom.DOMException

getFaultNode

public java.lang.String getFaultNode()

Get the env:Node URI string value.

Returns:

The URI string identifying the source of fault, or null if none is present.

setRole

public void setRole(java.lang.String roleURI)
             throws org.w3c.dom.DOMException

Set the env:Role element with the given URI identifying the role of the source of the fault.

Parameters:

roleURI - A URI string identifying the role of the source of the fault.

Throws:

org.w3c.dom.DOMException

See Also:

XMLURI.uri_soap12_role_none, XMLURI.uri_soap12_role_next, XMLURI.uri_soap12_role_ultimateReceiver

getRole

public java.lang.String getRole()

Get the env:Role URI string value.

Returns:

The URI string value of the env:Role element identifying the role of the source of the fault, or null if none is present.

addDetailEntry

public void addDetailEntry(org.w3c.dom.Element detailEntry)
                    throws org.w3c.dom.DOMException

Add a detail entry to this env:Fault element. An env:Detail child element will be created if it does not already exist.

Parameters:

detailEntry - A namespace qualified element carrying certain specific error information related to the Body element.

Throws:

org.w3c.dom.DOMException

getDetail

public org.w3c.dom.Element getDetail()

Returns the env:Detail element, which contains entries carrying specific error information related to the Body element.

Returns:

The env:Detail Element, or null if it is not present.

getDetailEntries

public org.w3c.dom.NodeList getDetailEntries()

Return the detail entries in this env:Fault's env:Detail element.

Returns:

A (possibly empty) NodeList of Elements.