- 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
オブジェクトを作成するメソッドもあります。- 導入されたバージョン:
- 1.6
-
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 SOAPFactory()
-
メソッドのサマリー
すべてのメソッド staticメソッド インスタンス・メソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract Detail
createDetail()
DetailEntry
オブジェクトのコンテナとして機能するDetail
オブジェクトを作成します。abstract SOAPElement
createElement(String localName)
指定されたローカル名を使用して初期化されたSOAPElement
オブジェクトを作成します。abstract SOAPElement
createElement(String localName, String prefix, String uri)
指定したローカル名、接頭辞、およびURIで新しいSOAPElement
オブジェクトを作成します。SOAPElement
createElement(QName qname)
指定されたQName
オブジェクトで初期化されたSOAPElement
オブジェクトを作成します。abstract SOAPElement
createElement(Name name)
指定されたName
オブジェクトで初期化されたSOAPElement
オブジェクトを作成します。SOAPElement
createElement(Element domElement)
SOAPElement
オブジェクトを既存のDOMElement
から作成します。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インスタンスを作成します。
-
-
-
メソッドの詳細
-
createElement
public SOAPElement createElement(Element domElement) throws SOAPException
SOAPElement
オブジェクトを既存のDOMElement
から作成します。 引数として渡されたDOMElement
がすでに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(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
オブジェクトの作成時にエラーが発生した場合- 導入されたバージョン:
- 1.6, 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
- 戻り値:
- 作成された新しい
SOAPElement
オブジェクト - 例外:
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/FaultStringfaultCode
- フォルト用のFaultCode- 戻り値:
SOAPFault
オブジェクト- 例外:
SOAPException
- SOAPエラーが存在する場合- 導入されたバージョン:
- 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(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
オブジェクトを作成します。 このメソッドは、javax.xml.soap
で指定された参照プロシージャを使用して、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
の作成時にエラーが発生した場合- 導入されたバージョン:
- 1.6, SAAJ 1.3
- 関連項目:
SAAJMetaFactory
-
-