MsgFactoryインタフェース

表6-4にMsgFactoryインタフェースで使用できるメソッドの概要を示します。

表6-4 MsgFactoryインタフェースの概要

データ型	説明
~MsgFactory()	SOAPメッセージ・ファクトリ・インスタンスを破棄します。
MsgFactory()	SOAPメッセージ・ファクトリ・インスタンスを作成して戻します。
addBodyElement()	SOAPメッセージの本文に要素を追加します。
addFaultReason()	他のフォルト原因を追加します。
addHeaderElement()	SOAPヘッダーに要素を追加します。
createConnection()	SOAP接続を作成します。
createMessage()	空のSOAPメッセージを作成して戻します。
destroyMessage()	SOAPメッセージを破棄します。
getBody()	SOAPメッセージのエンベロープ本文を戻します。
getBodyElement()	SOAP本文から要素を取得します。
getEnvelope()	SOAPパートのエンベロープを戻します。
getFault()	フォルトのコード、理由および詳細を戻します。
getHeader()	SOAPメッセージのエンベロープ・ヘッダーを戻します。
getHeaderElement()	SOAPヘッダーから要素を取得します。
getMustUnderstand()	SOAPヘッダー要素から`mustUnderstand`属性を取得します。
getReasonNum()	`Fault`要素の理由の数を取得します。
getReasonLang()	特定のインデックスを持つ理由の言語を取得します。
getRole()	SOAPヘッダー要素からロールを取得します。
hasFault()	SOAPメッセージにフォルト・オブジェクトが含まれているかどうかを判別します。
setFault()	SOAPメッセージにフォルトを設定します。
setMustUnderstand()	SOAPヘッダー要素に`mustUnderstand`属性を設定します。
setRole()	SOAPヘッダー要素にロールを設定します。

~MsgFactory()

デストラクタです。SOAPメッセージ・ファクトリを破棄します。割り当てられているメモリーはすべて解放され、接続はすべて閉じます。

構文

~MsgFactory() throw (SoapException);

MsgFactory()

SOAPメッセージ・ファクトリ・インスタンスを作成して戻します。

構文

MsgFactory(
   Context* ctx_ptr) throw (SoapException);

パラメータ	説明
ctx_ptr	`TContext` オブジェクト

戻り値

(MsgFactory) オブジェクト。

addBodyElement()

SOAPメッセージの本文に要素を追加します。

構文

Node* addBodyElement( DocumentRef< Node>& msg,
   oratext *qname,
   oratext *uri) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
qname	追加する要素のQName
uri	追加する要素の名前空間URI

戻り値

(Node*) 作成された要素へのポインタ。

addFaultReason()

他のフォルト原因を追加します。同じ理由のテキストを別の言語で提供できます。フォルトが作成されると、そのときにプライマリ言語と理由が追加されます。この関数は、その理由の翻訳を追加するのに使用します。

構文

void addFaultReason(
   DocumentRef< Node>& msg,
   oratext *reason,
   oratext *lang) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
reason	可読的なフォルト理由
lang	理由の言語

addHeaderElement()

SOAPヘッダーに要素を追加します。

構文

Node* addHeaderElement(
   DocumentRef< Node>& msg,
   oratext *qname, oratext *uri) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
qname	追加する要素のQName
uri	追加する要素の名前空間URI

戻り値

(Node*) 作成された要素へのポインタ。

createConnection()

SOAP接続オブジェクトを作成します。接続参照オブジェクトはユーザーが明示的に削除する必要があります。

構文

ConnectRef< Node>* createConnection(
   SoapBinding bind,
   void *endp,
   oratext *buf,
   ubig_ora bufsiz,
   oratext *msgbuf,
   ubig_ora msgbufsiz) throw (SoapException);

パラメータ	説明
bind	接続バインディング
endp	接続エンド・ポイント
buf	データ・バッファ（バッファの割当てを受けるときは`NULL`）
bufsiz	データ・バッファのサイズ（デフォルトのサイズは0）
msgbuf	メッセージ・バッファ（バッファの割当てを受けるときは`NULL`）
msgfubsiz	メッセージ・バッファのサイズ（デフォルトのサイズは0）

戻り値

(ConnectRef) 接続オブジェクト。

createMessage()

空のSOAPメッセージを作成して戻します。不要になった場合、参照オブジェクトはユーザーが明示的に削除する必要があります。

構文

DocumentRef< Node>* CreateMessage() throw (SoapException);

戻り値

(DocumentRef*) SOAPメッセージ、または例外。

destroyMessage()

SOAPメッセージを破棄します。

構文

void destroyMessage(
   DocumentRef< Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

getBody()

SOAPメッセージのエンベロープ本文を、本文の要素ノードへのポインタとして戻します。

構文

Node* getBody(
   DocumentRef<Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

戻り値

(Node*) SOAPメッセージのエンベロープ本文へのポインタ。

getBodyElement()

SOAP本文から要素を、要素ノードへのポインタとして取得します。

構文

Node* getBodyElement(
   DocumentRef< Node>& msg,
   oratext *uri,
   oratext *local) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
uri	追加する要素の名前空間URI
local	取得する要素のローカル名

戻り値

(Node*) 指定した要素へのポインタ。

getEnvelope()

SOAPパートのエンベロープを、エンベロープ要素ノードへのポインタとして戻します。

構文

Node* getEnvelope(
   DocumentRef<Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

戻り値

(Node*) SOAPメッセージのエンベロープへのポインタ。

getFault()

フォルトのコード、理由および詳細を、ユーザー変数を介して戻します。不要なパートにはNULLを指定できます。langについては、ポイント先の変数がNULLである場合、最初の理由に指定するデフォルト言語に設定されます。

構文

Node* getFault(
   DocumentRef< Node>& msg,
   oratext **code,
   oratext **reason,
   oratext **lang,
   oratext **node,
   oratext **role) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
code	フォルト・コード
reason	可読的なフォルト理由
lang	理由に指定する言語または`NULL`（デフォルトの言語。最初の理由と同じ）
node	フォルト・ノード
role	ロール: 次、なしまたは最終受信者（バージョン1.1では使用されていません）

戻り値

(Node) 詳細へのポインタ。

getHeader()

SOAPメッセージのエンベロープ・ヘッダーを、ヘッダーの要素ノードへのポインタとして戻します。

構文

Node* getHeader(
   DocumentRef< Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

戻り値

(Node*) SOAPメッセージのエンベロープ・ヘッダーへのポインタ。

getHeaderElement()

SOAPヘッダーから要素を、要素ノードへのポインタとして取得します。

構文

Node* getHeaderElement(
   DocumentRef< Node>& msg,
   oratext *uri,
   oratext *local) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
uri	取得する要素の名前空間URI
local	取得する要素のローカル名

戻り値

(Node*) 指定した要素へのポインタ。

getMustUnderstand()

SOAPヘッダー要素からmustUnderstand属性を取得します。

構文

boolean getMustUnderstand(
   ElementRef< Node>& elem) throw (SoapException);

パラメータ	説明
elem	SOAPヘッダー要素

戻り値

(boolean) mustUnderstand属性の値。

getReasonNum()

Fault要素の理由の数を判別します。Faultがない場合、0を戻します。

構文

ub4 getReasonNum(
   DocumentRef< Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

戻り値

(up4) Fault要素の理由の数。

getReasonLang()

特定のインデックスを持つ理由の言語を戻します。

構文

oratext* getReasonLang(
   DocumentRef< Node>& msg,
   ub4 idx) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
idx	フォルト理由のインデックス

戻り値

(oratext *) プロパティ値またはNULL。

getRole()

SOAPヘッダー要素からロールを取得します。

構文

SoapRole getRole(
   ElementRef< Node>& elem) throw (SoapException);

パラメータ	説明
elem	ヘッダー要素に対する参照

戻り値

(SoapRole) ヘッダー要素のロール。

hasFault()

SOAPメッセージにフォルト・オブジェクトが含まれているかどうかを判別します。

構文

boolean hasFault(
   DocumentRef< Node>& msg) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ

戻り値

(boolean) フォルトがある場合はTRUE、それ以外はFALSE。

setFault()

SOAPメッセージにフォルトを設定します。

構文

void setFault(
   DocumentRef< Node>& msg,
   oratext *node,
   oratext *code,
   oratext *reason,
   oratext *lang,
   oratext *role,
  ElementRef< Node>& detail) throw (SoapException);

パラメータ	説明
msg	SOAPメッセージ
node	フォルトが発生したSOAPノードのURI。
code	フォルト・コード
reason	可読的なフォルト理由
lang	言語。
role	ロールを示すURI。バージョン1.2ではRole（ロール）、バージョン1.1では使用されていません。
detail	ユーザー定義の要素。

setMustUnderstand()

SOAPヘッダー要素にmustUnderstand属性を設定します。

構文

void setMustUnderstand(
   ElementRef< Node>& elem,
   boolean mustUnderstand) throw (SoapException);

パラメータ	説明
elem	SOAPヘッダー要素
mustUnderstand	`mustUnderstand`の値（`TRUE`または`FALSE`）

setRole()

SOAPヘッダー要素にロールを設定します。

構文

void setRole(
   ElementRef< Node>& elem,
   SoapRole role) throw (SoapException);

パラメータ	説明
elem	ヘッダー要素に対する参照
role	ロール値