SOAPFactory (Java Platform SE 7)

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()`

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`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, 2013, 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