SOAPFault (Jakarta EE Platform API)

すべてのスーパーインターフェース:
ElementSE, NodeSE, SOAPBodyElement, SOAPElement
```
public interface SOAPFault
extends SOAPBodyElement
```
エラーおよび / またはステータス情報を含む SOAPBody オブジェクト内の要素。この情報は、SOAPMessage オブジェクトのエラー、またはメッセージ自体の内容に関連しない問題に関連している可能性があります。メッセージ自体に関係のない問題は、通常、アップストリームサーバーと通信できないなどの処理エラーです。
MessageFactory インスタンスの作成時に指定された protocol に応じて、SOAPFault には、SOAP 1.1/SOAP 1.2 仕様で定義されているサブ要素があります。
導入:
1.6

フィールドサマリー
- インターフェース org.w3c.dom.NodeSE から継承されたフィールド
  ATTRIBUTE_NODESE, CDATA_SECTION_NODESE, COMMENT_NODESE, DOCUMENT_FRAGMENT_NODESE, DOCUMENT_NODESE, DOCUMENT_POSITION_CONTAINED_BYSE, DOCUMENT_POSITION_CONTAINSSE, DOCUMENT_POSITION_DISCONNECTEDSE, DOCUMENT_POSITION_FOLLOWINGSE, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFICSE, DOCUMENT_POSITION_PRECEDINGSE, DOCUMENT_TYPE_NODESE, ELEMENT_NODESE, ENTITY_NODESE, ENTITY_REFERENCE_NODESE, NOTATION_NODESE, PROCESSING_INSTRUCTION_NODESE, TEXT_NODESE

方法の概要

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`Detail`	`addDetail()` オプションの `Detail` オブジェクトを作成し、それをこの `SOAPFault` オブジェクトの `Detail` オブジェクトとして設定します。
`void`	`addFaultReasonText(StringSE text, LocaleSE locale)` 指定されたテキストメッセージと `locale` から派生した xml:lang を含む ReasonText アイテムを追加または置換します。
`void`	`appendFaultSubcode(QNameSE subcode)` この `SOAPFault` に含まれるサブコードのシーケンスの最後にサブコードを追加します。
`Detail`	`getDetail()` この `SOAPFault` オブジェクトのオプションの detail 要素を返します。
`StringSE`	`getFaultActor()` この `SOAPFault` オブジェクトのフォールトアクターを取得します。
`StringSE`	`getFaultCode()` この `SOAPFault` オブジェクトの障害コードを取得します。
`Name`	`getFaultCodeAsName()` この `SOAPFault` オブジェクトの必須の SOAP 1.1 障害コードを SAAJ `Name` オブジェクトとして取得します。
`QNameSE`	`getFaultCodeAsQName()` この `SOAPFault` オブジェクトの障害コードを `QName` オブジェクトとして取得します。
`StringSE`	`getFaultNode()` この `SOAPFault` オブジェクトのオプションのノード要素値を返します。
`IteratorSE<LocaleSE>`	`getFaultReasonLocales()` 理由テキスト項目が関連付けられている `Locale` の個別のシーケンスに対して `Iterator` を返します。
`StringSE`	`getFaultReasonText(LocaleSE locale)` 指定された `Locale` に関連付けられている理由テキストを返します。
`IteratorSE<StringSE>`	`getFaultReasonTexts()` この `SOAPFault` のすべての理由テキスト項目を含む `String` オブジェクトのシーケンスに対して `Iterator` を返します。
`StringSE`	`getFaultRole()` この `SOAPFault` オブジェクトのオプションの Role 要素値を返します。
`StringSE`	`getFaultString()` この `SOAPFault` オブジェクトの障害文字列を取得します。
`LocaleSE`	`getFaultStringLocale()` この `SOAPFault` オブジェクトの障害文字列のロケールを取得します。
`IteratorSE<QNameSE>`	`getFaultSubcodes()` この `SOAPFault` のサブコードを `QNames` のイテレータとして取得します。
`boolean`	`hasDetail()` この `SOAPFault` に `Detail` サブ要素がある場合は true を返し、そうでない場合は false を返します。
`void`	`removeAllFaultSubcodes()` この `SOAPFault` に含まれている可能性のあるサブコードをすべて削除します。
`void`	`setFaultActor(StringSE faultActor)` この `SOAPFault` オブジェクトを指定されたフォールトアクターで設定します。
`void`	`setFaultCode(Name faultCodeQName)` この `SOAPFault` オブジェクトに指定された障害コードを設定します。
`void`	`setFaultCode(QNameSE faultCodeQName)` この `SOAPFault` オブジェクトに指定された障害コードを設定します。
`void`	`setFaultCode(StringSE faultCode)` この `SOAPFault` オブジェクトに give 障害コードを設定します。
`void`	`setFaultNode(StringSE uri)` この `SOAPFault` オブジェクトの既存のノード要素値を作成または置換します。
`void`	`setFaultRole(StringSE uri)` この `SOAPFault` オブジェクトの既存の Role 要素値を作成または置換します。
`void`	`setFaultString(StringSE faultString)` この `SOAPFault` オブジェクトの障害文字列を指定された文字列に設定します。
`void`	`setFaultString(StringSE faultString, LocaleSE locale)` この `SOAPFault` オブジェクトの障害文字列を指定された文字列に設定し、指定されたロケールにローカライズします。

インターフェース jakarta.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

インターフェース jakarta.xml.soap.Node から継承されたメソッド
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

インターフェース org.w3c.dom.ElementSE から継承されたメソッド
getAttributeSE, getAttributeNodeSE, getAttributeNodeNSSE, getAttributeNSSE, getElementsByTagNameSE, getElementsByTagNameNSSE, getSchemaTypeInfoSE, getTagNameSE, hasAttributeSE, hasAttributeNSSE, removeAttributeSE, removeAttributeNodeSE, removeAttributeNSSE, setAttributeSE, setAttributeNodeSE, setAttributeNodeNSSE, setAttributeNSSE, setIdAttributeSE, setIdAttributeNodeSE, setIdAttributeNSSE

インターフェース org.w3c.dom.NodeSE から継承されたメソッド
appendChildSE, cloneNodeSE, compareDocumentPositionSE, getAttributesSE, getBaseURISE, getChildNodesSE, getFeatureSE, getFirstChildSE, getLastChildSE, getLocalNameSE, getNamespaceURISE, getNextSiblingSE, getNodeNameSE, getNodeTypeSE, getNodeValueSE, getOwnerDocumentSE, getParentNodeSE, getPrefixSE, getPreviousSiblingSE, getTextContentSE, getUserDataSE, hasAttributesSE, hasChildNodesSE, insertBeforeSE, isDefaultNamespaceSE, isEqualNodeSE, isSameNodeSE, isSupportedSE, lookupNamespaceURISE, lookupPrefixSE, normalizeSE, removeChildSE, replaceChildSE, setNodeValueSE, setPrefixSE, setTextContentSE, setUserDataSE

- メソッドの詳細
  - 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 - 基になる XML ツリーへの faultcode 要素の追加でエラーが発生した場合。
    導入:
    1.6、SAAJ 1.2
    関連事項:
    getFaultCodeAsName()
  - setFaultCode
```
void setFaultCode(QNameSE faultCodeQName)
           throws SOAPException
```
    この SOAPFault オブジェクトに指定された障害コードを設定します。setFaultCode(Name) よりもこの方法を使用することをお勧めします。
    パラメーター:
    faultCodeQName - 設定する障害コードを提供する QName オブジェクト。名前空間で修飾する必要があります。
    例外:
    SOAPException - 基礎となる XML ツリーへの faultcode 要素の追加でエラーが発生した場合。
    導入:
    1.6、SAAJ 1.3
    関連事項:
    getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()
  - setFaultCode
```
void setFaultCode(StringSE faultCode)
           throws SOAPException
```
    この SOAPFault オブジェクトに give 障害コードを設定します。
    障害に関する情報を提供する障害コードは、SOAP 1.1 仕様で定義されています。この要素は、SOAP1.1 では必須です。障害コードは QName である必要があるため、このメソッドの setFaultCode(Name) 形式を使用することをお勧めします。
    パラメーター:
    faultCode - 設定する障害コードを指定する String。プレフィックスが名前空間宣言で定義されている場合は、"prefix:localName" という形式にする必要があります。
    例外:
    SOAPException - 基礎となる XML ツリーへの faultCode の追加でエラーが発生した場合。
    関連事項:
    setFaultCode(Name), getFaultCode(), SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
  - getFaultCodeAsName
```
Name getFaultCodeAsName()
```
    この SOAPFault オブジェクトの必須の SOAP 1.1 障害コードを SAAJ Name オブジェクトとして取得します。SOAP 1.1 仕様では、"faultcode" 要素の値が QName 型である必要があります。このメソッドは、要素のコンテンツを SAAJName オブジェクトの形式で QName として返します。このメソッドは、アプリケーションが追加の解析なしで名前空間名に簡単にアクセスできるようにするため、getFaultCode メソッドの代わりに使用する必要があります。
    戻り値:
    障害コードを表す Name
    導入:
    1.6、SAAJ 1.2
    関連事項:
    setFaultCode(Name)
  - getFaultCodeAsQName
```
QNameSE getFaultCodeAsQName()
```
    この SOAPFault オブジェクトの障害コードを QName オブジェクトとして取得します。
    戻り値:
    障害コードを表す QName
    導入:
    1.6、SAAJ 1.3
    関連事項:
    setFaultCode(QName)
  - getFaultSubcodes
```
IteratorSE<QNameSE> getFaultSubcodes()
```
    この SOAPFault のサブコードを QNames のイテレータとして取得します。
    戻り値:
    QNames のシーケンスにアクセスする Iterator。この Iterator は、オプションの remove メソッドをサポートするべきではありません。サブコードが返される順序は、障害に存在するサブコードの階層を上から下に反映します。
    例外:
    UnsupportedOperationExceptionSE - このメッセージがサブコードの SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - removeAllFaultSubcodes
```
void removeAllFaultSubcodes()
```
    この SOAPFault に含まれている可能性のあるサブコードをすべて削除します。後続の getFaultSubcodes の呼び出しは、appendFaultSubcode の呼び出しが行われるまで、空のイテレーターを返します。
    例外:
    UnsupportedOperationExceptionSE - このメッセージがサブコードの SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - appendFaultSubcode
```
void appendFaultSubcode(QNameSE subcode)
                 throws SOAPException
```
    この SOAPFault に含まれるサブコードのシーケンスの最後にサブコードを追加します。SOAP 1.2 で導入されたサブコードは、SOAP 障害の必須の Code サブ要素をルートとするサブ要素の再帰的なシーケンスによって表されます。
    パラメーター:
    subcode - サブコードの値を含む QName。
    例外:
    SOAPException - サブコードの設定でエラーが発生した場合
    UnsupportedOperationExceptionSE - このメッセージがサブコードの SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - getFaultCode
```
StringSE getFaultCode()
```
    この SOAPFault オブジェクトの障害コードを取得します。
    戻り値:
    障害コード付きの String
    関連事項:
    getFaultCodeAsName(), setFaultCode(jakarta.xml.soap.Name)
  - setFaultActor
```
void setFaultActor(StringSE faultActor)
            throws SOAPException
```
    この SOAPFault オブジェクトを指定されたフォールトアクターで設定します。
    フォールトアクターは、フォールトを発生させたメッセージパスの受信者です。
    この SOAPFault が SOAP 1.2 をサポートしている場合、この呼び出しは setFaultRole(String) と同等です。
    パラメーター:
    faultActor - この SOAPFault オブジェクトの原因となったアクターを識別する String
    例外:
    SOAPException - 基礎となる XML ツリーへの faultActor の追加でエラーが発生した場合。
    関連事項:
    getFaultActor()
  - getFaultActor
```
StringSE getFaultActor()
```
    この SOAPFault オブジェクトのフォールトアクターを取得します。
    この SOAPFault が SOAP 1.2 をサポートしている場合、この呼び出しは getFaultRole() と同等です。
    戻り値:
    この SOAPFault オブジェクトの原因となったメッセージパス内のアクターを提供する String
    関連事項:
    setFaultActor(java.lang.String)
  - setFaultString
```
void setFaultString(StringSE faultString)
             throws SOAPException
```
    この SOAPFault オブジェクトの障害文字列を指定された文字列に設定します。
    この SOAPFault が SOAP 1.2 をサポートするメッセージの一部である場合、この呼び出しは次と同等です。
```
      addFaultReasonText(faultString, Locale.getDefault());
 
```
    パラメーター:
    faultString - 障害の説明を提供する String
    例外:
    SOAPException - 基礎となる XML ツリーへの faultString の追加でエラーが発生した場合。
    関連事項:
    getFaultString()
  - setFaultString
```
void setFaultString(StringSE faultString,
                    LocaleSE locale)
             throws SOAPException
```
    この SOAPFault オブジェクトの障害文字列を指定された文字列に設定し、指定されたロケールにローカライズします。
    この SOAPFault が SOAP 1.2 をサポートするメッセージの一部である場合、この呼び出しは次と同等です。
```
      addFaultReasonText(faultString, locale);
 
```
    パラメーター:
    faultString - 障害の説明を提供する String
    locale - faultString の母国語を示す LocaleSE オブジェクト
    例外:
    SOAPException - 基礎となる XML ツリーへの faultString の追加でエラーが発生した場合。
    導入:
    1.6、SAAJ 1.2
    関連事項:
    getFaultString()
  - getFaultString
```
StringSE 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
```
LocaleSE 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 要素を返します。
    Detail オブジェクトは、アプリケーション固有のエラー情報を伝達します。これが SOAP 1.1 障害である場合、エラー情報の範囲は SOAPBodyElement オブジェクトの障害に制限されます。
    戻り値:
    アプリケーション固有のエラー情報が存在する場合は Detail オブジェクト、存在しない場合は null
  - addDetail
```
Detail addDetail()
          throws SOAPException
```
    オプションの Detail オブジェクトを作成し、それをこの SOAPFault オブジェクトの Detail オブジェクトとして設定します。
    障害にすでに詳細が含まれている場合、詳細を追加することは不正です。このメソッドは、既存の詳細が削除された後にのみ呼び出す必要があります。
    戻り値:
    新しい Detail オブジェクト
    例外:
    SOAPException - この SOAPFault オブジェクトにすでに有効な Detail オブジェクトが含まれている場合
  - getFaultReasonLocales
```
IteratorSE<LocaleSE> getFaultReasonLocales()
                                throws SOAPException
```
    理由テキスト項目が関連付けられている Locale の個別のシーケンスに対して Iterator を返します。これらの Locale のいずれも、理由テキスト文字列のローカライズされたバージョンを取得するために getFaultReasonText の呼び出しで使用できます。
    戻り値:
    理由テキスト項目が関連付けられている Locale オブジェクトのシーケンスに対する Iterator。
    例外:
    SOAPException - 障害理由ロケールの取得中にエラーが発生した場合。
    UnsupportedOperationExceptionSE - このメッセージが FaultReason の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - getFaultReasonTexts
```
IteratorSE<StringSE> getFaultReasonTexts()
                              throws SOAPException
```
    この SOAPFault のすべての理由テキスト項目を含む String オブジェクトのシーケンスに対して Iterator を返します。
    戻り値:
    env:Fault/env:Reason/env:Text アイテム上の Iterator。
    例外:
    SOAPException - 障害理由テキストの取得中にエラーが発生した場合。
    UnsupportedOperationExceptionSE - このメッセージが FaultReason の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - getFaultReasonText
```
StringSE getFaultReasonText(LocaleSE locale)
                   throws SOAPException
```
    指定された Locale に関連付けられている理由テキストを返します。そのような理由テキストが複数存在する場合、最初に一致するテキストが返されます
    パラメーター:
    locale - - ローカライズされた理由テキストが必要な Locale
    戻り値:
    locale に関連付けられている理由テキスト
    例外:
    SOAPException - 指定されたロケールの障害理由テキストの取得中にエラーが発生した場合。
    UnsupportedOperationExceptionSE - このメッセージが FaultReason の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
    関連事項:
    getFaultString()
  - addFaultReasonText
```
void addFaultReasonText(StringSE text,
                        LocaleSE locale)
                 throws SOAPException
```
    指定されたテキストメッセージと locale から派生した xml:lang を含む理由テキストアイテムを追加または置換します。 この xml:lang を持つ Reason Text アイテムがすでに存在する場合、そのテキスト値は text に置き換えられます。locale パラメーターは null であってはなりません
    コードサンプル:
```
 SOAPFault fault = ...;
 fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
 
```
    パラメーター:
    text - - 理由メッセージ文字列
    locale - - メッセージのロケールを表すロケールオブジェクト
    例外:
    SOAPException - 理由テキストの追加でエラーが発生した場合、または渡された locale が null であった場合。
    UnsupportedOperationExceptionSE - このメッセージが FaultReason の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - getFaultNode
```
StringSE getFaultNode()
```
    この SOAPFault オブジェクトのオプションのノード要素値を返します。Node 要素は SOAP 1.2 ではオプションです。
    戻り値:
    文字列としての env:Fault/env:Node 要素のコンテンツまたは存在しない場合は null
    例外:
    UnsupportedOperationExceptionSE - このメッセージが FaultNode の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - setFaultNode
```
void setFaultNode(StringSE uri)
           throws SOAPException
```
    この SOAPFault オブジェクトの既存のノード要素値を作成または置換します。Node 要素は SOAP 1.2 ではオプションです。
    パラメーター:
    uri - ノードの URI
    例外:
    SOAPException - この SOAPFault オブジェクトのノードの設定でエラーが発生した場合。
    UnsupportedOperationExceptionSE - このメッセージが FaultNode の SOAP 1.2 概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - getFaultRole
```
StringSE getFaultRole()
```
    この SOAPFault オブジェクトのオプションの Role 要素値を返します。Role 要素は SOAP 1.2 ではオプションです。
    戻り値:
    文字列としての env:Fault/env:Role 要素のコンテンツまたは存在しない場合は null
    例外:
    UnsupportedOperationExceptionSE - このメッセージが SOAP 1.2 の障害のロールの概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3
  - setFaultRole
```
void setFaultRole(StringSE uri)
           throws SOAPException
```
    この SOAPFault オブジェクトの既存の Role 要素値を作成または置換します。Role 要素は SOAP 1.2 ではオプションです。
    パラメーター:
    uri - ロールの URI
    例外:
    SOAPException - この SOAPFault オブジェクトのロールの設定でエラーが発生した場合。
    UnsupportedOperationExceptionSE - このメッセージが SOAP 1.2 の障害のロールの概念をサポートしていない場合。
    導入:
    1.6、SAAJ 1.3

インターフェース SOAPFault

フィールドサマリー

インターフェース org.w3c.dom.NodeSE から継承されたフィールド

方法の概要

インターフェース jakarta.xml.soap.SOAPElement から継承されたメソッド

インターフェース jakarta.xml.soap.Node から継承されたメソッド

インターフェース org.w3c.dom.ElementSE から継承されたメソッド

インターフェース org.w3c.dom.NodeSE から継承されたメソッド

メソッドの詳細

setFaultCode

setFaultCode

setFaultCode

getFaultCodeAsName

getFaultCodeAsQName

getFaultSubcodes

removeAllFaultSubcodes

appendFaultSubcode

getFaultCode

setFaultActor

getFaultActor

setFaultString

setFaultString

getFaultString

getFaultStringLocale

hasDetail

getDetail

addDetail

getFaultReasonLocales

getFaultReasonTexts

getFaultReasonText

addFaultReasonText

getFaultNode

setFaultNode

getFaultRole

setFaultRole