com.nec.webotx.jbi.engine.user
インタフェース IMessageExchange

既知のサブインタフェースの一覧:
IInOnly, IInOptionalOut, IInOut, IRobustInOnly

public interface IMessageExchange

MessageExchangeのFacadeパターンのインタフェースです。実装クラスはMessageExchange オブジェクトの参照を持ちます。


フィールドの概要
static java.lang.String JTA_TRANSACTION_PROPERTY_NAME
          JTAトランザクションコンテキストの属性名です。
 
メソッドの概要
 javax.jbi.messaging.Fault createFault()
          Faultオブジェクトの汎用ファクトリメソッドです。
 javax.jbi.messaging.NormalizedMessage createMessage()
          保有しているメッセージエクスチェンジに基づき、Normalizedメッセージを作成します。
 javax.jbi.servicedesc.ServiceEndpoint getEndpoint()
          このメッセージエクスチェンジで使用するエンドポイントを取得します。
 java.lang.String getExchangeId()
          NMRにより割り当てられたユニークな識別子を取得します。
 javax.jbi.messaging.Fault getFault()
          Faultメッセージがセットされているならば、このメッセージエクスチェンジから取得できます。
 javax.xml.namespace.QName getInterfaceName()
          このメッセージエクスチェンジで使用するインタフェースを取得します。
 javax.jbi.messaging.NormalizedMessage getMessage(java.lang.String name)
          保有しているメッセージの参照からNormalizedメッセージを取得します。
 javax.xml.namespace.QName getOperation()
          このメッセージエクスチェンジで使用するオペレーションを取得します。
 java.net.URI getPattern()
          このメッセージエクスチェンジのURIを取得します。
 java.lang.Object getProperty(java.lang.String name)
          指定される属性を取得します。
 java.util.Set getPropertyNames()
          このメッセージエクスチェンジから全ての属性名を取得します。
 javax.jbi.messaging.MessageExchange.Role getRole()
          このメッセージエクスチェンジのロールを取得します。
 javax.xml.namespace.QName getService()
          このメッセージエクスチェンジで使用するサービスを取得します。
 javax.jbi.messaging.ExchangeStatus getStatus()
          このメッセージエクスチェンジの処理ステータスを取得します。
 boolean isTransacted()
          トランザクションコンテキストの存在を判断します。
 void setFault(javax.jbi.messaging.Fault fault)
          Faultメッセージをこのメッセージエクスチェンジに設定します。
 void setMessage(javax.jbi.messaging.NormalizedMessage msg, java.lang.String name)
          指定したメッセージの参照でNoramlizedメッセージを設定します。
 void setProperty(java.lang.String name, java.lang.Object obj)
          メッセージエクスチェンジに属性を設定します。
 

フィールドの詳細

JTA_TRANSACTION_PROPERTY_NAME

static final java.lang.String JTA_TRANSACTION_PROPERTY_NAME
JTAトランザクションコンテキストの属性名です。

関連項目:
定数フィールド値
メソッドの詳細

getPattern

java.net.URI getPattern()
このメッセージエクスチェンジのURIを取得します。

戻り値:
このメッセージエクスチェンジのURI

getExchangeId

java.lang.String getExchangeId()
NMRにより割り当てられたユニークな識別子を取得します。

戻り値:
NMRにより割り当てられたユニークな識別子

getStatus

javax.jbi.messaging.ExchangeStatus getStatus()
このメッセージエクスチェンジの処理ステータスを取得します。

戻り値:
このメッセージエクスチェンジの処理ステータス

getFault

javax.jbi.messaging.Fault getFault()
Faultメッセージがセットされているならば、このメッセージエクスチェンジから取得できます。一つのメッセージは 一つFaultしか保有しないので、Fault/messageの参照は必須ではありません。 そして、このメッセージエクスチェンジは必ず最後のメッセージとなります。

戻り値:
このメッセージエクスチェンジに関連付けるFault。セットされていない場合、nullが返される

setFault

void setFault(javax.jbi.messaging.Fault fault)
              throws javax.jbi.messaging.MessagingException
Faultメッセージをこのメッセージエクスチェンジに設定します。一つのメッセージは 一つFaultしか保有しませんので、Fault/messageの参照は必須ではありません。

パラメータ:
fault - Faultメッセージ
例外:
javax.jbi.messaging.MessagingException - メッセージエクスチェンジのステータスによりセットできない場合

createMessage

javax.jbi.messaging.NormalizedMessage createMessage()
                                                    throws javax.jbi.messaging.MessagingException
保有しているメッセージエクスチェンジに基づき、Normalizedメッセージを作成します。 このメッセージに関連付けるパターンの参照となる定義を保有しなければなりません。

戻り値:
新規Normalizedメッセージ
例外:
javax.jbi.messaging.MessagingException - 生成に失敗した場合

createFault

javax.jbi.messaging.Fault createFault()
                                      throws javax.jbi.messaging.MessagingException
Faultオブジェクトの汎用ファクトリメソッドです。

戻り値:
新規Fault
例外:
javax.jbi.messaging.MessagingException - 生成に失敗した場合

getMessage

javax.jbi.messaging.NormalizedMessage getMessage(java.lang.String name)
保有しているメッセージの参照からNormalizedメッセージを取得します。

パラメータ:
name - 参照するメッセージ名
戻り値:
Normalizedメッセージ

setMessage

void setMessage(javax.jbi.messaging.NormalizedMessage msg,
                java.lang.String name)
                throws javax.jbi.messaging.MessagingException
指定したメッセージの参照でNoramlizedメッセージを設定します。

パラメータ:
msg - Normalizedメッセージ
name - 参照するメッセージ名
例外:
javax.jbi.messaging.MessagingException - メッセージエクスチェンジのステータスによりセットできない場合

getProperty

java.lang.Object getProperty(java.lang.String name)
指定される属性を取得します。

パラメータ:
name - 属性名
戻り値:
取得した属性値

setProperty

void setProperty(java.lang.String name,
                 java.lang.Object obj)
メッセージエクスチェンジに属性を設定します。

パラメータ:
name - 属性名
obj - 属性値

getEndpoint

javax.jbi.servicedesc.ServiceEndpoint getEndpoint()
このメッセージエクスチェンジで使用するエンドポイントを取得します。

戻り値:
このメッセージエクスチェンジで使用するエンドポイント

getInterfaceName

javax.xml.namespace.QName getInterfaceName()
このメッセージエクスチェンジで使用するインタフェースを取得します。

戻り値:
このメッセージエクスチェンジで使用するインタフェース

getService

javax.xml.namespace.QName getService()
このメッセージエクスチェンジで使用するサービスを取得します。

戻り値:
このメッセージエクスチェンジで使用するサービス

getOperation

javax.xml.namespace.QName getOperation()
このメッセージエクスチェンジで使用するオペレーションを取得します。

戻り値:
このメッセージエクスチェンジで使用するオペレーション名

isTransacted

boolean isTransacted()
トランザクションコンテキストの存在を判断します。

戻り値:
トランザクションの有効性

getRole

javax.jbi.messaging.MessageExchange.Role getRole()
このメッセージエクスチェンジのロールを取得します。

戻り値:
このメッセージエクスチェンジのロール

getPropertyNames

java.util.Set getPropertyNames()
このメッセージエクスチェンジから全ての属性名を取得します。

戻り値:
属性名の集合


Copyright (C) 1998 - 2012 NEC Corporation. All rights reserved.