概要  パッケージ   クラス  使用  階層ツリー  非推奨 API  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド

javax.xml.soap
クラス SOAPFactory

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()
           
 
メソッドの概要
abstract  Detail createDetail()
          DetailEntry オブジェクトのコンテナとして機能する Detail オブジェクトを作成します。
 SOAPElement createElement(Element domElement)
          SOAPElement オブジェクトを既存の 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 を作成します。
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 オブジェクトを既存の 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 オブジェクトを作成します。@param reasonText フォルト用の ReasonText/FaultString @param faultCode フォルト用の FaultCode @return SOAPFault オブジェクト @throws SOAPException SOAP エラーが存在する場合 @since SAAJ 1.3

例外:
SOAPException

createFault

public abstract SOAPFault createFault()
                               throws SOAPException
新しいデフォルトの SOAPFault オブジェクトを作成します。 @return SOAPFault オブジェクト @throws SOAPException SOAP エラーが存在する場合 @since SAAJ 1.3

例外:
SOAPException

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 実装クラスを決定します。

戻り値:
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  索引  ヘルプ 
JavaTM Platform
Standard Ed. 6
 前のクラス   次のクラス フレームあり    フレームなし    
概要: 入れ子 | フィールド | コンストラクタ | メソッド 詳細: フィールド | コンストラクタ | メソッド
バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。