インターフェース MessageEndpointFactory
public interface MessageEndpointFactory
これは、メッセージエンドポイントを作成するためのファクトリとして機能します。- 導入:
- 1.5
- バージョン:
- 1.7
- 作成者:
- Ram Jeyaraman, Sivakumar Thyagarajan
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 MessageEndpoint
createEndpoint(XAResourceSE xaResource)
これは、メッセージエンドポイントを作成するために使用されます。MessageEndpoint
createEndpoint(XAResourceSE xaResource, long timeout)
これは、メッセージエンドポイントを作成するために使用されます。StringSE
getActivationName()
MessageEndpointFactory
で表されるメッセージエンドポイントデプロイの一意の名前を返します。ClassSE<?>
getEndpointClass()
メッセージエンドポイントクラスに対応するClass
オブジェクトを返します。boolean
isDeliveryTransacted(MethodSE method)
これは、メッセージエンドポイントまたはgetBeanClass
メソッドによって返されるClass
のターゲットメソッドによって実装されるメッセージリスナインターフェースのターゲットメソッドへのメッセージ配信が処理されるかどうかを確認するために使用されます。
メソッドの詳細
createEndpoint
MessageEndpoint createEndpoint(XAResourceSE xaResource) throws UnavailableException
これは、メッセージエンドポイントを作成するために使用されます。メッセージエンドポイントは、正しいメッセージリスナ型を実装する必要があります。- パラメーター:
xaResource
- メッセージ配信が処理されるときにトランザクション通知を取得するために使用されるオプションのXAResource
インスタンス。- 戻り値:
- メッセージエンドポイントインスタンス。
- 例外:
UnavailableException
- メッセージエンドポイントの作成における一時的な障害を示します。メッセージエンドポイントを作成する後続の試行は成功する可能性があります。
createEndpoint
MessageEndpoint createEndpoint(XAResourceSE xaResource, long timeout) throws UnavailableException
これは、メッセージエンドポイントを作成するために使用されます。メッセージエンドポイントは、正しいメッセージリスナ型を実装する必要があります。- パラメーター:
xaResource
- メッセージ配信が処理されるときにトランザクション通知を取得するために使用されるオプションのXAResource
インスタンス。timeout
-MessageEndpointFactory
によってメッセージエンドポイントを作成する必要がある期間(ミリ秒単位)を指定するために使用されるオプションの値。それ以外の場合、MessageEndpointFactory
は UnavailableException を使用したMessageEndpoint
の作成を拒否します。これは、リアルタイムの保証を提供するものではないことに注意してください。- 戻り値:
- メッセージエンドポイントインスタンス。
- 例外:
UnavailableException
- メッセージエンドポイントの作成における一時的な障害を示します。メッセージエンドポイントを作成する後続の試行は成功する可能性があります。- 導入:
- 1.6
isDeliveryTransacted
boolean isDeliveryTransacted(MethodSE method) throws NoSuchMethodExceptionSE
これは、メッセージエンドポイントまたはgetBeanClass
メソッドによって返されるClass
のターゲットメソッドによって実装されるメッセージリスナインターフェースのターゲットメソッドへのメッセージ配信が処理されるかどうかを確認するために使用されます。メッセージのエンドポイントは、そのデプロイ記述子を介して、トランザクション方式の配信設定(メソッドレベルごと)を示す場合があります。メッセージ配信設定は、メッセージエンドポイントの有効期間中に変更してはなりません。- パラメーター:
method
- ターゲットメソッドの説明。目的のターゲットメソッドに関するこの情報により、アプリケーションサーバーは、ターゲットメソッドの呼び出しが処理されるかどうかを確認できます。- 戻り値:
- メッセージエンドポイントがトランザクションメッセージの配信を必要とする場合は true。
- 例外:
NoSuchMethodExceptionSE
- 指定されたメソッドがターゲットエンドポイントに存在しないことを示します。
getActivationName
StringSE getActivationName()
MessageEndpointFactory
で表されるメッセージエンドポイントデプロイの一意の名前を返します。メッセージエンドポイントがクラスター化されたアプリケーションサーバーにデプロイされている場合、このメソッドは、各アプリケーションサーバーインスタンスでそのメッセージエンドポイントのアクティブ化に対して同じ名前を返す必要があります。この名前は、ユーザーまたは管理者に見える方法でリソースアダプターによって使用される可能性があるため、人間が読める名前にすることをお勧めします。また、アプリケーションサーバーが再起動された場合やメッセージエンドポイントが再デプロイされた場合でも、この名前を変更しないことをお勧めします。- 戻り値:
- メッセージエンドポイントデプロイの一意の名前を表す新しい
String
インスタンス - 導入:
- 1.7
getEndpointClass
ClassSE<?> getEndpointClass()
メッセージエンドポイントクラスに対応するClass
オブジェクトを返します。例: メッセージ駆動型 Bean の場合、これはアプリケーションの MDB クラスに対応するClass
オブジェクトです。リソースアダプターはこれを使用して、メッセージエンドポイントクラスをイントロスペクトし、アノテーションや実装されたインターフェースなどを検出し、それに応じてリソースアダプターの動作を変更できます。null
の戻り値は、MessageEndpoint
が基になるメッセージエンドポイントクラスのビジネスメソッドを実装していないことを示します。- 戻り値:
- メッセージエンドポイントクラスに対応する
Class
。 - 導入:
- 1.7