パッケージ jakarta.xml.soap

クラス SOAPFactory

  • public abstract class SOAPFactory
extends ObjectSE
    SOAPFactory は、SOAPXML ツリーに存在するさまざまなオブジェクトを作成するためのファクトリです。SOAPFactory を使用して、最終的に SOAP 部分になる XML フラグメントを作成できます。これらのフラグメントは、SOAPHeaderElement、SOAPBodyElement、SOAPEnvelope、その他の SOAPElement オブジェクトの子として挿入できます。SOAPFactory には、java.xml.soap.Name オブジェクトだけでなく jakarta.xml.soap.Detail オブジェクトを作成するメソッドもあります。
    導入:
    1.6

    • コンストラクターの詳細

      • SOAPFactory

        protected SOAPFactory()
        デフォルトコンストラクター。

    • メソッドの詳細

      • createElement

        public SOAPElement createElement​(ElementSE domElement)
                          throws SOAPException
        既存の DOM Element から SOAPElement オブジェクトを作成します。引数として渡される DOM Element がすでに SOAPElement である場合、このメソッドはそれ以上の作業なしで変更せずにそれを返す必要があります。それ以外の場合は、新しい SOAPElement が作成され、domElement 引数のディープコピーが作成されます。戻り値の具象型は、domElement 引数の名前によって異なります。domElement をルートとするツリーのいずれかの部分が SOAP ルールに違反している場合、SOAPException がスローされます。
        パラメーター:
        domElement - コピーする Element。
        戻り値:
        domElement のコピーである新しい SOAPElement。
        例外:
        SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合
        導入:
        1.6、SAAJ 1.3

      • createElement

        public abstract SOAPElement createElement​(Name name)
                                   throws SOAPException
        指定された Name オブジェクトで初期化された SOAPElement オブジェクトを作成します。戻り値の具象型は、新しい SOAPElement に付けられた名前によって異なります。たとえば、"{http://www.w3.org/2003/05/soap-envelope}Envelope" という名前の新しい SOAPElement を使用すると、SOAP 1.2 動作をサポートする SOAPEnvelope が作成されます。
        パラメーター:
        name - 新しい要素の XML 名を持つ Name オブジェクト
        戻り値:
        作成された新しい SOAPElement オブジェクト
        例外:
        SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合
        関連事項:
        createElement(javax.xml.namespace.QName)

      • createElement

        public SOAPElement createElement​(QNameSE qname)
                          throws SOAPException
        指定された QName オブジェクトで初期化された SOAPElement オブジェクトを作成します。戻り値の具象型は、新しい SOAPElement に付けられた名前によって異なります。たとえば、"{http://www.w3.org/2003/05/soap-envelope}Envelope" という名前の新しい SOAPElement を使用すると、SOAP 1.2 動作をサポートする SOAPEnvelope が作成されます。
        パラメーター:
        qname - 新しい要素の XML 名を持つ QName オブジェクト
        戻り値:
        作成された新しい SOAPElement オブジェクト
        例外:
        SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合
        導入:
        1.6、SAAJ 1.3
        関連事項:
        createElement(Name)

      • createElement

        public abstract SOAPElement createElement​(StringSE localName)
                                   throws SOAPException
        指定されたローカル名で初期化された SOAPElement オブジェクトを作成します。
        パラメーター:
        localName - 新しい要素のローカル名を与える String 
        戻り値:
        作成された新しい SOAPElement オブジェクト
        例外:
        SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

      • createElement

        public abstract SOAPElement createElement​(StringSE localName,
                                          StringSE prefix,
                                          StringSE uri)
                                   throws SOAPException
        指定されたローカル名、プレフィックス、uri を使用して新しい SOAPElement オブジェクトを作成します。戻り値の具象型は、新しい SOAPElement に付けられた名前によって異なります。たとえば、"{http://www.w3.org/2003/05/soap-envelope}Envelope" という名前の新しい SOAPElement を使用すると、SOAP 1.2 動作をサポートする SOAPEnvelope が作成されます。
        パラメーター:
        localName - 新しい要素のローカル名を与える String 
        prefix - この SOAPElement のプレフィックス
        uri - 新しい要素が属する名前空間の URI を提供する String 
        戻り値:
        作成された新しい SOAPElement オブジェクト
        例外:
        SOAPException - SOAPElement オブジェクトの作成中にエラーが発生した場合

      • createDetail

        public abstract Detail createDetail()
                             throws SOAPException
        DetailEntry オブジェクトのコンテナーとして機能する新しい Detail オブジェクトを作成します。

        このファクトリメソッドは、SOAPFault 抽象化を使用することが実用的でない状況で使用するための Detail オブジェクトを作成します。

        戻り値:
        Detail オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合
        UnsupportedOperationExceptionSE - SOAPFactory に指定されたプロトコルが DYNAMIC_SOAP_PROTOCOL の場合

      • createFault

        public abstract SOAPFault createFault​(StringSE reasonText,
                                      QNameSE faultCode)
                               throws SOAPException
        指定された reasonText および faultCode で初期化された新しい SOAPFault オブジェクトを作成します
        パラメーター:
        reasonText - 障害の ReasonText/FaultString
        faultCode - 障害の FaultCode
        戻り値:
        SOAPFault オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合
        IllegalArgumentExceptionSE - reasonText または faultCode が null の場合
        導入:
        1.6、SAAJ 1.3

      • createFault

        public abstract SOAPFault createFault()
                               throws SOAPException
        新しいデフォルトの SOAPFault オブジェクトを作成します
        戻り値:
        SOAPFault オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合
        導入:
        1.6、SAAJ 1.3

      • createName

        public abstract Name createName​(StringSE localName,
                                StringSE prefix,
                                StringSE uri)
                         throws SOAPException
        指定されたローカル名、名前空間プレフィックス、名前空間 URI で初期化された新しい Name オブジェクトを作成します。

        このファクトリメソッドは、SOAPEnvelope 抽象化を使用することが実用的でない状況で使用するための Name オブジェクトを作成します。

        パラメーター:
        localName - ローカル名を与える String 
        prefix - 名前空間のプレフィックスを与える String 
        uri - 名前空間の URI を提供する String 
        戻り値:
        指定されたローカル名、名前空間プレフィックス、名前空間 URI で初期化された Name オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合

      • createName

        public abstract Name createName​(StringSE localName)
                         throws SOAPException
        指定されたローカル名で初期化された新しい Name オブジェクトを作成します。

        このファクトリメソッドは、SOAPEnvelope 抽象化を使用することが実用的でない状況で使用するための Name オブジェクトを作成します。

        パラメーター:
        localName - ローカル名を与える String 
        戻り値:
        指定されたローカル名で初期化された Name オブジェクト
        例外:
        SOAPException - SOAP エラーがある場合

      • newInstance

        public static SOAPFactory newInstance()
                               throws SOAPException
        デフォルト実装（SOAP 1.1）のインスタンスである新しい SOAPFactory オブジェクトを作成します。このメソッドは、jakarta.xml.soap で指定されたルックアップ手順を使用して、SOAPFactory クラスを見つけてロードします。
        戻り値:
        SOAPFactory の新しいインスタンス
        例外:
        SOAPException - デフォルトの SOAPFactory の作成中にエラーが発生した場合
        関連事項:
        SAAJMetaFactory

      • newInstance

        public static SOAPFactory newInstance​(StringSE protocol)
                               throws SOAPException
        指定された実装のインスタンスである新しい SOAPFactory オブジェクトを作成します。このメソッドは、SAAJMetaFactory を使用して実装クラスを検索し、SOAPFactory インスタンスを作成します。
        パラメーター:
        protocol - 指定された SOAP ファクトリ実装のプロトコルを表す文字列定数。DYNAMIC_SOAP_PROTOCOL、DEFAULT_SOAP_PROTOCOL （と同じ） SOAP_1_1_PROTOCOL、SOAP_1_2_PROTOCOL のいずれかです。
        戻り値:
        SOAPFactory の新しいインスタンス
        例外:
        SOAPException - 指定された SOAPFactory の作成中にエラーが発生した場合
        導入:
        1.6、SAAJ 1.3
        関連事項:
        SAAJMetaFactory