javax.xml.soap

クラスSAAJResult

java.lang.Object

javax.xml.transform.dom.DOMResult

javax.xml.soap.SAAJResult

すべての実装されたインタフェース:

Result

public class SAAJResult
extends DOMResult

SAAJツリー形式で、JAXP変換、またはJAXB整列化の結果のホルダーとして動作します。これらの結果にはgetResult()メソッドでアクセスするべきです。DOMResult.getNode()メソッドの使用は極力回避してください。

導入されたバージョン:

SAAJ 1.3

フィールドのサマリー

クラス javax.xml.transform.dom.DOMResultから継承されたフィールド

FEATURE

インタフェース javax.xml.transform.Resultから継承されたフィールド

PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SAAJResult() デフォルト(SOAP 1.1)プロトコルをサポートするSAAJツリー形式で結果を提供するSAAJResultを作成します。
SAAJResult(SOAPElement rootNode) 指定のSOAPElementの子ノードとして結果を書き込むSAAJResultを作成します。
SAAJResult(SOAPMessage message) 提供されたSOAPMessageのSOAPPartに結果を書き込むSAAJResultを作成します。
SAAJResult(String protocol) 指定のプロトコルをサポートするSAAJツリー形式で結果を提供するSAAJResultを作成します。

メソッドのサマリー

修飾子と型	メソッドと説明
Node	getResult()

クラス javax.xml.transform.dom.DOMResultから継承されたメソッド

getNextSibling, getNode, getSystemId, setNextSibling, setNode, setSystemId

クラス java.lang.Objectから継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

SAAJResult

public SAAJResult()
           throws SOAPException

デフォルト(SOAP 1.1)プロトコルをサポートするSAAJツリー形式で結果を提供するSAAJResultを作成します。

このSAAJResultのタイプが使用されるのは、結果が、SAAJ APIから抽出するパラメータ・タイプ(SOAPElementなど)を取得するメソッドのパラメータとして使用される場合です。変換に使用した場合、その結果は内部的に作成されるSOAPMessageのSOAPPartに生成されます。DOMResult.getNode()で返されたSOAPPartは、形式が整っていない場合があります。

例外:

SOAPException - SOAPMessageの作成時に問題が発生した場合

導入されたバージョン:

SAAJ 1.3

SAAJResult

public SAAJResult(String protocol)
           throws SOAPException

指定のプロトコルをサポートするSAAJツリー形式で結果を提供するSAAJResultを作成します。DYNAMIC_SOAP_PROTOCOLがこのコンテキストではあいまいなため、このコンストラクタがUnsupportedOperationExceptionをスローします。

このSAAJResultのタイプが使用されるのは、結果が、SAAJ APIから抽出するパラメータ・タイプ(SOAPElementなど)を取得するメソッドのパラメータとして使用される場合です。変換に使用した場合、その結果は内部的に作成されるSOAPMessageのSOAPPartに生成されます。DOMResult.getNode()で返されたSOAPPartは、形式が整っていない場合があります。

パラメータ:

protocol - - SAAJツリーの結果でサポートする必要のあるSOAPプロトコルの名前

例外:

SOAPException - 指定のプロトコルをサポートするSOAPMessageを作成できない場合

導入されたバージョン:

SAAJ 1.3

SAAJResult

public SAAJResult(SOAPMessage message)

提供されたSOAPMessageのSOAPPartに結果を書き込むSAAJResultを作成します。通常、これらの結果はDOM APIを使用して書き込まれます。そのため、作成に使用したデータが整形式でないかぎり、書き込まれたSOAPPartが整形式になることは保証されません。変換に使用する場合、変換後のSOAPMessageの有効性は、SAAJ仕様の枠外の方法を使用することによってのみ保証できます。

パラメータ:

message - - 変換や整列化操作の結果として生成されるSOAPPartを持つメッセージ

導入されたバージョン:

SAAJ 1.3

SAAJResult

public SAAJResult(SOAPElement rootNode)

指定のSOAPElementの子ノードとして結果を書き込むSAAJResultを作成します。通常、これらの結果はDOM APIを使用して書き込まれるため、SAAJツリー構造が無効になります。このSAAJResultタイプは、着信データの有効性をSAAJ仕様以外の方法で保証できるときにのみ使用してください。

パラメータ:

rootNode - - 結果が追加されるルート

導入されたバージョン:

SAAJ 1.3

メソッドの詳細

getResult

public Node getResult()

戻り値:

指定のルートNodeの下に作成された結果として得られるTree。

導入されたバージョン:

SAAJ 1.3