SOAPFactory (Java Platform SE 8)

java.lang.Object
- javax.xml.soap.SOAPFactory

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

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

コンストラクタ
コンストラクタと説明

SOAPFactory()

コンストラクタ
コンストラクタと説明
`SOAPFactory()`

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`abstract Detail`	`createDetail()` `DetailEntry`オブジェクトのコンテナとして機能する`Detail`オブジェクトを作成します。
`SOAPElement`	`createElement(Element domElement)` `SOAPElement`オブジェクトを既存のDOM `Element`から作成します。
`abstract SOAPElement`	`createElement(Name name)` 指定された`Name`オブジェクトで初期化された`SOAPElement`オブジェクトを作成します。
`SOAPElement`	`createElement(QName qname)` 指定された`QName`オブジェクトで初期化された`SOAPElement`オブジェクトを作成します。
`abstract SOAPElement`	`createElement(String localName)` 指定されたローカル名を使用して初期化された`SOAPElement`オブジェクトを作成します。
`abstract SOAPElement`	`createElement(String localName, String prefix, String uri)` 指定したローカル名、接頭辞、およびURIで新しい`SOAPElement`オブジェクトを作成します。
`abstract SOAPFault`	`createFault()` 新しいデフォルトの`SOAPFault`オブジェクトを作成します。
`abstract SOAPFault`	`createFault(String reasonText, QName faultCode)` 指定した`reasonText`および`faultCode`を使用して初期化された、新しい`SOAPFault`オブジェクトを作成します。
`abstract Name`	`createName(String localName)` 指定されたローカル名を使用して初期化された新しい`Name`オブジェクトを作成します。
`abstract Name`	`createName(String localName, String prefix, String uri)` 指定したローカル名、名前空間接頭辞および名前空間URIを使用して初期化された新しい`Name`オブジェクトを作成します。
`static SOAPFactory`	`newInstance()` デフォルトの実装(SOAP 1.1)のインスタンスである、新しい`SOAPFactory`オブジェクトを作成します。このメソッドは次の順序の検索手順で、ロードするSOAPFactory実装クラスを決定します。javax.xml.soap.SOAPFactoryシステム・プロパティを使用します。
`static SOAPFactory`	`newInstance(String protocol)` 指定した実装のインスタンスである新しい`SOAPFactory`オブジェクトを作成し、このメソッドはSAAJMetaFactoryを使用して実装クラスの場所を特定してSOAPFactoryインスタンスを作成します。

クラス java.lang.Objectから継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - SOAPFactory
```
public SOAPFactory()
```
- メソッドの詳細
  - createElement
```
public SOAPElement createElement(Element domElement)
                          throws SOAPException
```
    SOAPElementオブジェクトを既存のDOM Elementから作成します。引数として渡されたDOM ElementがすでにSOAPElementである場合、このメソッドは変更を加えずに返す必要があります。そうでない場合、新しいSOAPElementが作成され、ディープ・コピーがdomElement引数で作成されます。戻り値の具象型は、domElement引数の名前に依存します。domElementをルートにするツリーの一部でもSOAP規則に違反すると、SOAPExceptionがスローされます。
    
    パラメータ:
    
    domElement - コピーされるElement。
    
    戻り値:
    
    domElementのコピーである新しいSOAPElement。
    
    例外:
    
    SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合
    
    導入されたバージョン:
    
    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(QName 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オブジェクトの作成時にエラーが発生した場合
    
    導入されたバージョン:
    
    SAAJ 1.3
    
    関連項目:
    
    createElement(Name)
  - createElement
```
public abstract SOAPElement createElement(String localName)
                                   throws SOAPException
```
    指定されたローカル名を使用して初期化されたSOAPElementオブジェクトを作成します。
    
    パラメータ:
    
    localName - 新規要素のローカル名を示すString
    
    戻り値:
    
    作成された新しいSOAPElementオブジェクト
    
    例外:
    
    SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合
  - createElement
```
public abstract SOAPElement createElement(String localName,
                                          String prefix,
                                          String 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
    
    例外:
    
    SOAPException - SOAPElementオブジェクトの作成時にエラーが発生した場合
  - createDetail
```
public abstract Detail createDetail()
                             throws SOAPException
```
    DetailEntryオブジェクトのコンテナとして機能するDetailオブジェクトを作成します。
    このファクトリ・メソッドは、SOAPFault抽象を使用するのが実際的でない状況で使用するために、Detailオブジェクトを作成します。
    
    戻り値:
    
    Detailオブジェクト
    
    例外:
    
    SOAPException - SOAPエラーが存在する場合
    
    UnsupportedOperationException - SOAPFactory用に指定されたプロトコルがDYNAMIC_SOAP_PROTOCOLであった場合
  - createFault
```
public abstract SOAPFault createFault(String reasonText,
                                      QName faultCode)
                               throws SOAPException
```
    指定したreasonTextおよびfaultCodeを使用して初期化された、新しいSOAPFaultオブジェクトを作成します。
    
    パラメータ:
    
    reasonText - フォルト用のReasonText/FaultString
    
    faultCode - フォルト用のFaultCode
    
    戻り値:
    
    SOAPFaultオブジェクト
    
    例外:
    
    SOAPException - SOAPエラーが存在する場合
    
    導入されたバージョン:
    
    SAAJ 1.3
  - createFault
```
public abstract SOAPFault createFault()
                               throws SOAPException
```
    新しいデフォルトのSOAPFaultオブジェクトを作成します。
    
    戻り値:
    
    SOAPFaultオブジェクト
    
    例外:
    
    SOAPException - SOAPエラーが存在する場合
    
    導入されたバージョン:
    
    SAAJ 1.3
  - createName
```
public abstract Name createName(String localName,
                                String prefix,
                                String uri)
                         throws SOAPException
```
    指定したローカル名、名前空間接頭辞および名前空間URIを使用して初期化された新しいNameオブジェクトを作成します。
    このファクトリ・メソッドは、SOAPEnvelope抽象を使用するのが実際的でない状況で使用するために、Nameオブジェクトを作成します。
    
    パラメータ:
    
    localName - ローカル名を指定するString
    
    prefix - 名前空間の接頭辞を指定するString
    
    uri - 名前空間のURIを指定するString
    
    戻り値:
    
    指定のローカル名、名前空間接頭辞、および名前空間URIで初期化されたNameオブジェクト
    
    例外:
    
    SOAPException - SOAPエラーが存在する場合
  - createName
```
public abstract Name createName(String localName)
                         throws SOAPException
```
    指定されたローカル名を使用して初期化された新しいNameオブジェクトを作成します。
    このファクトリ・メソッドは、SOAPEnvelope抽象を使用するのが実際的でない状況で使用するために、Nameオブジェクトを作成します。
    
    パラメータ:
    
    localName - ローカル名を指定するString
    
    戻り値:
    
    指定のローカル名で初期化されたNameオブジェクト
    
    例外:
    
    SOAPException - SOAPエラーが存在する場合
  - newInstance
```
public static SOAPFactory newInstance()
                               throws SOAPException
```
    デフォルトの実装(SOAP 1.1)のインスタンスである、新しいSOAPFactoryオブジェクトを作成します。このメソッドは次の順序の検索手順で、ロードするSOAPFactory実装クラスを決定します。
    - javax.xml.soap.SOAPFactoryシステム・プロパティを使用する。
    - JREディレクトリ内のプロパティ・ファイルlib/jaxm.propertiesを使用する。この構成ファイルは標準のjava.util.Properties形式であり、上記のように定義されたシステム・プロパティであるキーを持つ実装クラスの完全指定の名前を含む。
    - 可能であれば、JAR仕様で詳細に説明されているサービスAPIを使用して、クラス名を判定する。サービスAPIは、実行時に使用できるjar内のMETA-INF/services/javax.xml.soap.SOAPFactoryファイルからクラス名を検索する。
    - SOAPFactory実装クラスの場所を特定するSAAJMetaFactoryインスタンスを使用する。
    戻り値:
    
    SOAPFactoryの新しいインスタンス
    
    例外:
    
    SOAPException - 次の作成時にエラーが発生した場合: デフォルトのSOAPFactory
    
    関連項目:
    
    SAAJMetaFactory
  - newInstance
```
public static SOAPFactory newInstance(String 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の作成時にエラーが発生した場合
    
    導入されたバージョン:
    
    SAAJ 1.3
    
    関連項目:
    
    SAAJMetaFactory

バグまたは機能を送信
詳細なAPIリファレンスおよび開発者ドキュメントについては、Java SEのドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright© 1993, 2014, Oracle and/or its affiliates. All rights reserved.

クラスSOAPFactory

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

メソッドのサマリー

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

コンストラクタの詳細

SOAPFactory

メソッドの詳細

createElement

createElement

createElement

createElement

createElement

createDetail

createFault

createFault

createName

createName

newInstance

newInstance