-
- すべてのスーパー・インタフェース:
Element
,Node
,Node
,SOAPBodyElement
,SOAPElement
public interface SOAPFault extends SOAPBodyElement
エラー情報またはステータス情報、あるいはその両方を格納するSOAPBody
オブジェクト内の要素。 この情報は、SOAPMessage
オブジェクト内のエラーまたはメッセージ自体のコンテンツに関連しない問題に関連している場合があります。 メッセージ自体に関連しない問題は、通常、上流のサーバーと通信できないなどの処理上のエラーです。MessageFactory
インスタンスの作成中に指定されたprotocol
によっては、SOAPFault
がSOAP 1.1/SOAP 1.2仕様で定義されたサブ要素を持ちます。- 導入されたバージョン:
- 1.6
-
-
フィールドのサマリー
-
インタフェース org.w3c.dom.Nodeで宣言されたフィールド
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
-
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 抽象メソッド 修飾子と型 メソッド 説明 Detail
addDetail()
オプションのDetail
オブジェクトを作成し、それをこのSOAPFault
オブジェクトのDetail
オブジェクトとして設定します。void
addFaultReasonText(String text, Locale locale)
指定したテキスト・メッセージおよびlocale
から派生したxml:langを含むReason Text項目を追加または置換します。void
appendFaultSubcode(QName subcode)
このSOAPFault
によって格納されるサブコードのシーケンスの最後に、サブコードを追加します。Detail
getDetail()
このSOAPFault
オブジェクトの、オプションの詳細要素を返します。String
getFaultActor()
このSOAPFault
オブジェクトのフォルト・アクターを取得します。String
getFaultCode()
このSOAPFault
オブジェクトのフォルト・コードを取得します。Name
getFaultCodeAsName()
このSOAPFault
オブジェクトの必須SOAP 1.1フォルト・コードを、SAAJName
オブジェクトとして取得します。QName
getFaultCodeAsQName()
このSOAPFault
オブジェクトのフォルト・コードをQName
オブジェクトとして取得します。String
getFaultNode()
このSOAPFault
オブジェクトの、オプションのNode要素値を返します。Iterator<Locale>
getFaultReasonLocales()
関連付けられたReason Text項目があるLocale
の別々のシーケンスについてのIterator
を返します。String
getFaultReasonText(Locale locale)
指定したLocale
と関連付けられたReason Textを返します。Iterator<String>
getFaultReasonTexts()
このSOAPFault
のReason Text項目すべてを含むString
オブジェクトのシーケンスについてのIterator
を返します。String
getFaultRole()
このSOAPFault
オブジェクトの、オプションのRole要素値を返します。String
getFaultString()
このSOAPFault
オブジェクトのフォルト文字列を取得します。Locale
getFaultStringLocale()
このSOAPFault
オブジェクトのフォルト文字列のロケールを取得します。Iterator<QName>
getFaultSubcodes()
このSOAPFault
のサブコードを、QNames
のイテレータとして取得します。boolean
hasDetail()
このSOAPFault
がDetail
サブ要素を保持する場合はtrue、それ以外の場合はfalseを返します。void
removeAllFaultSubcodes()
このSOAPFault
によって格納されるサブコードを削除します。void
setFaultActor(String faultActor)
指定したフォルト・アクターでこのSOAPFault
オブジェクトを設定します。void
setFaultCode(String faultCode)
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。void
setFaultCode(QName faultCodeQName)
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。void
setFaultCode(Name faultCodeQName)
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。void
setFaultNode(String uri)
このSOAPFault
オブジェクトの既存のNode要素値を作成または置換します。void
setFaultRole(String uri)
このSOAPFault
オブジェクトの既存のRole要素値を作成または置換します。void
setFaultString(String faultString)
指定した文字列に対して、このSOAPFault
オブジェクトのフォルト文字列を設定します。void
setFaultString(String faultString, Locale locale)
指定した文字列に対して、このSOAPFault
オブジェクトのフォルト文字列を設定し、指定したロケールにローカライズします。-
インタフェース org.w3c.dom.Elementで宣言されたメソッド
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
インタフェース javax.xml.soap.Nodeで宣言されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
インタフェース org.w3c.dom.Nodeで宣言されたメソッド
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
-
インタフェース javax.xml.soap.SOAPElementで宣言されたメソッド
addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
-
-
-
-
メソッドの詳細
-
setFaultCode
void setFaultCode(Name faultCodeQName) throws SOAPException
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。フォルト・コードはフォルトに関する情報を提供し、SOAP 1.1仕様で定義されています。 フォルト・コードは必須で、
Name
型である必要があります。 このメソッドは、フォルト・コードを設定する簡単な方法を提供します。 次に例を示します。
このメソッドをSOAPEnvelope se = ...; // Create a qualified name in the SOAP namespace with a localName // of "Client". Note that prefix parameter is optional and is null // here which causes the implementation to use an appropriate prefix. Name qname = se.createName("Client", null, SOAPConstants.URI_NS_SOAP_ENVELOPE); SOAPFault fault = ...; fault.setFaultCode(qname);
setFaultCode(String)
に対して使用するのが適切です。- パラメータ:
faultCodeQName
- 設定するフォルト・コードを示すName
オブジェクト。 名前空間で修飾されている必要がある。- 例外:
SOAPException
- faultcode要素を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
getFaultCodeAsName()
-
setFaultCode
void setFaultCode(QName faultCodeQName) throws SOAPException
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。 このメソッドをsetFaultCode(Name)
に対して使用するのが適切です。- パラメータ:
faultCodeQName
- 設定するフォルト・コードを示すQName
オブジェクト。 名前空間で修飾されている必要がある。- 例外:
SOAPException
-faultcode
要素を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
getFaultCodeAsQName()
,setFaultCode(Name)
,getFaultCodeAsQName()
-
setFaultCode
void setFaultCode(String faultCode) throws SOAPException
指定したフォルト・コードでこのSOAPFault
オブジェクトを設定します。フォルト・コードはフォルトに関する情報を提供し、SOAP 1.1仕様で定義されています。 この要素は、SOAP 1.1で必須です。 フォルト・コードはQNameである必要があるため、このメソッドの
setFaultCode(Name)
形式を使用するのが適切です。- パラメータ:
faultCode
- 設定するフォルト・コードを示すString
。 接頭辞が名前空間宣言で定義された"prefix:localName"の形式であることが必要。- 例外:
SOAPException
-faultCode
を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 関連項目:
setFaultCode(Name)
,getFaultCode()
,SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
-
getFaultCodeAsName
Name getFaultCodeAsName()
このSOAPFault
オブジェクトの必須SOAP 1.1フォルト・コードを、SAAJName
オブジェクトとして取得します。 SOAP 1.1仕様では、「faultcode」要素の値はQName型であることが必要です。 このメソッドは、要素のコンテンツをQNameとして、SAAJ Nameオブジェクトの形式で返します。 このメソッドは、アプリケーションが追加の解析を行うことなく名前空間名に容易にアクセスできるため、getFaultCode
メソッドの代わりに使用すべきです。- 戻り値:
- フォルト・コードを表現する
Name
- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
setFaultCode(Name)
-
getFaultCodeAsQName
QName getFaultCodeAsQName()
このSOAPFault
オブジェクトのフォルト・コードをQName
オブジェクトとして取得します。- 戻り値:
- フォルト・コードを表現する
QName
- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
setFaultCode(QName)
-
getFaultSubcodes
Iterator<QName> getFaultSubcodes()
このSOAPFault
のサブコードを、QNames
のイテレータとして取得します。- 戻り値:
QNames
のシーケンスにアクセスするIterator
。 このIterator
は、オプションのremove
メソッドをサポートすべきではない。 サブコードが返される順序には、フォルトに存在する上から下へのサブコードの階層が反映される。- 例外:
UnsupportedOperationException
- このメッセージが、SOAP 1.2のサブコードの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
removeAllFaultSubcodes
void removeAllFaultSubcodes()
このSOAPFault
によって格納されるサブコードを削除します。 以降getFaultSubcodes
を呼び出すと、appendFaultSubcode
への呼出しが行われるまで空のイテレータが返されます。- 例外:
UnsupportedOperationException
- このメッセージが、SOAP 1.2のサブコードの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
appendFaultSubcode
void appendFaultSubcode(QName subcode) throws SOAPException
このSOAPFault
によって格納されるサブコードのシーケンスの最後に、サブコードを追加します。 サブコードはSOAP 1.2で導入されましたが、SOAP Faultの必須Codeサブ要素をルートとする、サブ要素の再帰的なシーケンスによって表現されます。- パラメータ:
subcode
- サブコードの値を格納するQName。- 例外:
SOAPException
- サブコードの設定時にエラーが発生した場合UnsupportedOperationException
- このメッセージが、SOAP 1.2のサブコードの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getFaultCode
String getFaultCode()
このSOAPFault
オブジェクトのフォルト・コードを取得します。- 戻り値:
- フォルト・コードを含む
String
- 関連項目:
getFaultCodeAsName()
,setFaultCode(javax.xml.soap.Name)
-
setFaultActor
void setFaultActor(String faultActor) throws SOAPException
指定したフォルト・アクターでこのSOAPFault
オブジェクトを設定します。フォルト・アクターは、フォルトを発生させたメッセージ・パス内での受信者です。
この
SOAPFault
がSOAP 1.2をサポートする場合、この呼出しはsetFaultRole(String)
と等しくなります- パラメータ:
faultActor
- このSOAPFault
オブジェクトを発生させたアクターを識別するString
- 例外:
SOAPException
-faultActor
を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 関連項目:
getFaultActor()
-
getFaultActor
String getFaultActor()
このSOAPFault
オブジェクトのフォルト・アクターを取得します。この
SOAPFault
がSOAP 1.2をサポートする場合、この呼出しはgetFaultRole()
と等しくなります- 戻り値:
- この
SOAPFault
オブジェクトを発生させたメッセージ・パス内でのアクターを示すString
- 関連項目:
setFaultActor(java.lang.String)
-
setFaultString
void setFaultString(String faultString) throws SOAPException
指定した文字列に対して、このSOAPFault
オブジェクトのフォルト文字列を設定します。この
SOAPFault
がSOAP 1.2をサポートするメッセージの一部である場合、この呼出しは次と等しくなります。addFaultReasonText(faultString, Locale.getDefault());
- パラメータ:
faultString
- エラーの説明を提供するString
- 例外:
SOAPException
-faultString
を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 関連項目:
getFaultString()
-
setFaultString
void setFaultString(String faultString, Locale locale) throws SOAPException
指定した文字列に対して、このSOAPFault
オブジェクトのフォルト文字列を設定し、指定したロケールにローカライズします。この
SOAPFault
がSOAP 1.2をサポートするメッセージの一部である場合、この呼出しは次と等しくなります。addFaultReasonText(faultString, locale);
- パラメータ:
faultString
- エラーの説明を提供するString
locale
-faultString
のネイティブ言語を示すLocale
オブジェクト- 例外:
SOAPException
-faultString
を基本となるXMLツリーに追加するときに、エラーが発生した場合。- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
getFaultString()
-
getFaultString
String getFaultString()
このSOAPFault
オブジェクトのフォルト文字列を取得します。この
SOAPFault
がSOAP 1.2をサポートするメッセージの一部である場合、この呼出しは次と等しくなります。String reason = null; try { reason = (String) getFaultReasonTexts().next(); } catch (SOAPException e) {} return reason;
- 戻り値:
- フォルトの説明を示す
String
- 関連項目:
setFaultString(String)
,setFaultString(String, Locale)
-
getFaultStringLocale
Locale getFaultStringLocale()
このSOAPFault
オブジェクトのフォルト文字列のロケールを取得します。この
SOAPFault
がSOAP 1.2をサポートするメッセージの一部である場合、この呼出しは次と等しくなります。Locale locale = null; try { locale = (Locale) getFaultReasonLocales().next(); } catch (SOAPException e) {} return locale;
- 戻り値:
- フォルト文字列のネイティブ言語を示す
Locale
オブジェクト。ロケールが指定されていなかった場合はnull
- 導入されたバージョン:
- 1.6, SAAJ 1.2
- 関連項目:
setFaultString(String, Locale)
-
hasDetail
boolean hasDetail()
このSOAPFault
がDetail
サブ要素を保持する場合はtrue、それ以外の場合はfalseを返します。(getDetail()!=null)
と同等です。- 戻り値:
- この
SOAPFault
がDetail
サブ要素を保持する場合はtrue、それ以外の場合はfalse。 - 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getDetail
Detail getDetail()
このSOAPFault
オブジェクトの、オプションの詳細要素を返します。Detail
オブジェクトは、アプリケーション固有のエラー情報を伝え、エラー情報のスコープは、これがSOAP 1.1 Faultの場合SOAPBodyElement
オブジェクト内のフォルトに制限されます。- 戻り値:
- アプリケーション固有のエラー情報がある場合はそれを含む
Detail
オブジェクト、ない場合はnull
-
addDetail
Detail addDetail() throws SOAPException
オプションのDetail
オブジェクトを作成し、それをこのSOAPFault
オブジェクトのDetail
オブジェクトとして設定します。フォルトにすでにDetailが含まれる場合は、Detailを追加することができません。 そのため、このメソッドは既存のDetailが削除されたあとでのみ呼び出すべきです。
- 戻り値:
- 新しい
Detail
オブジェクト - 例外:
SOAPException
-SOAPFault
オブジェクトにすでに有効なDetail
オブジェクトが含まれている場合
-
getFaultReasonLocales
Iterator<Locale> getFaultReasonLocales() throws SOAPException
関連付けられたReason Text項目があるLocale
の別々のシーケンスについてのIterator
を返します。 これらのLocale
はどれでも、Reason Text文字列のローカライズされたバージョンを取得するためにgetFaultReasonText
への呼出しで使用できます。- 戻り値:
- 関連付けられたReason Text項目がある
Locale
オブジェクトのシーケンスのIterator
。 - 例外:
SOAPException
- フォルトReasonロケールの取得でエラーが発生した場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Reasonの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getFaultReasonTexts
Iterator<String> getFaultReasonTexts() throws SOAPException
このSOAPFault
のReason Text項目すべてを含むString
オブジェクトのシーケンスについてのIterator
を返します。- 戻り値:
- env:Fault/env:Reason/env:Text項目についての
Iterator
。 - 例外:
SOAPException
- フォルトReason Textの取得でエラーが発生した場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Reasonの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getFaultReasonText
String getFaultReasonText(Locale locale) throws SOAPException
指定したLocale
と関連付けられたReason Textを返します。 そのようなReason Textが複数存在する場合、最初に一致するTextが返されます。- パラメータ:
locale
- -- ローカライズされたReason Textが要求されているLocale
- 戻り値:
locale
と関連付けられたReason Text- 例外:
SOAPException
- 指定したロケールのフォルトReason Textの取得でエラーが発生した場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Reasonの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
getFaultString()
-
addFaultReasonText
void addFaultReasonText(String text, Locale locale) throws SOAPException
指定したテキスト・メッセージおよびlocale
から派生したxml:langを含むReason Text項目を追加または置換します。 このxml:langを含むReason Text項目がすでに存在する場合、テキストの値はtext
で置換されます。locale
パラメータは、null
にすべきではありませんコード例:
SOAPFault fault = ...; fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
- パラメータ:
text
- -- 理由メッセージの文字列locale
- -- メッセージのロケールを表現するLocaleオブジェクト- 例外:
SOAPException
- Reason Textの追加でエラーが発生した場合、または渡されたlocale
がnull
の場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Reasonの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getFaultNode
String getFaultNode()
このSOAPFault
オブジェクトの、オプションのNode要素値を返します。 Node要素は、SOAP 1.2では省略可能です。- 戻り値:
- Stringとしてのenv:Fault/env:Node要素のコンテンツ。ない場合は
null
- 例外:
UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Nodeの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
setFaultNode
void setFaultNode(String uri) throws SOAPException
このSOAPFault
オブジェクトの既存のNode要素値を作成または置換します。 Node要素は、SOAP 1.2では省略可能です。- パラメータ:
uri
- ノードのURI- 例外:
SOAPException
- このSOAPFault
オブジェクトのNodeの設定時にエラーが発生した場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Nodeの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
getFaultRole
String getFaultRole()
このSOAPFault
オブジェクトの、オプションのRole要素値を返します。 Role要素は、SOAP 1.2では省略可能です。- 戻り値:
- Stringとしてのenv:Fault/env:Role要素のコンテンツ。ない場合は
null
- 例外:
UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Roleの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
setFaultRole
void setFaultRole(String uri) throws SOAPException
このSOAPFault
オブジェクトの既存のRole要素値を作成または置換します。 Role要素は、SOAP 1.2では省略可能です。- パラメータ:
uri
- ロールのURI- 例外:
SOAPException
- このSOAPFault
オブジェクトのRoleの設定時にエラーが発生した場合。UnsupportedOperationException
- このメッセージが、SOAP 1.2のFault Roleの概念をサポートしない場合。- 導入されたバージョン:
- 1.6, SAAJ 1.3
-
-