GenericMessageEndpointManager (Spring Framework API)

java.lang.ObjectSE
- org.springframework.jca.endpoint.GenericMessageEndpointManager

実装されたすべてのインターフェース:
DisposableBean, InitializingBean, Lifecycle, Phased, SmartLifecycle
既知の直属サブクラス
JmsMessageEndpointManager
```
public class GenericMessageEndpointManager
extends ObjectSE
implements SmartLifecycle, InitializingBean, DisposableBean
```
Spring アプリケーションコンテキスト内の JCA 1.7 メッセージエンドポイントを管理し、アプリケーションコンテキストのライフサイクルの一部としてエンドポイントをアクティブ化および非アクティブ化する汎用 Bean。
このクラスは、ResourceAdapter、MessageEndpointFactory、および ActivationSpec で機能するという点で完全に汎用的です。次のように、Spring の XML Bean 定義形式などを使用して、標準の Bean スタイルで構成できます。
```
 <bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager">
         <property name="resourceAdapter" ref="resourceAdapter"/>
         <property name="messageEndpointFactory">
     <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory">
       <property name="messageListener" ref="messageListener"/>
     </bean>
         </property>
         <property name="activationSpec">
     <bean class="org.apache.activemq.ra.ActiveMQActivationSpec">
       <property name="destination" value="myQueue"/>
       <property name="destinationType" value="javax.jms.Queue"/>
     </bean>
   </property>
 </bean>
```
この例では、Spring 自身の GenericMessageEndpointFactory を使用して、指定されたターゲット ResourceAdapter によってサポートされている標準のメッセージリスナオブジェクト (この場合は、ActiveMQ メッセージブローカーによってサポートされ、Spring Bean として定義されている JMS MessageListenerEE オブジェクト) を示します。
```
 <bean id="messageListener" class="com.myorg.messaging.myMessageListener">
   ...
 </bean>
```
ターゲット ResourceAdapter は、ローカル Spring Bean として構成することも（典型的なケース）、JNDI から取得することもできます（例: WebLogic）。上記の例では、ローカル ResourceAdapter Bean を次のように定義できます（上記の "resourceAdapter" Bean 参照と一致）。
```
 <bean id="resourceAdapter" class="org.springframework.jca.support.ResourceAdapterFactoryBean">
   <property name="resourceAdapter">
     <bean class="org.apache.activemq.ra.ActiveMQResourceAdapter">
       <property name="serverUrl" value="tcp://localhost:61616"/>
     </bean>
   </property>
   <property name="workManager">
     <bean class="org.springframework.jca.work.SimpleTaskWorkManager"/>
   </property>
 </bean>
```
別のターゲットリソースの場合、構成は、別の ResourceAdapter および別の ActivationSpec オブジェクト（どちらもリソースプロバイダーに固有）を指し、場合によっては別のメッセージリスナー（たとえば、以下に基づくリソースアダプターの CCI MessageListenerEE）を指すだけです。JCA Common Client Interface）。
非同期実行戦略は、ResourceAdapterFactoryBean の "workManager" プロパティを介してカスタマイズできます（上記を参照）。SimpleTaskWorkManager の javadoc で構成オプションを確認してください。あるいは、他の JCA 準拠の WorkManager を使用できます（Geronimo など）。
トランザクション実行は、指定された MessageEndpointFactory によって構築された、具体的なメッセージエンドポイントの責任です。GenericMessageEndpointFactory は、通常、Spring JtaTransactionManager またはプレーンな TransactionManagerSE 実装がそこで指定されている "transactionManager" プロパティを通じて XA トランザクション参加をサポートします。
```
 <bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager">
         <property name="resourceAdapter" ref="resourceAdapter"/>
         <property name="messageEndpointFactory">
     <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory">
       <property name="messageListener" ref="messageListener"/>
       <property name="transactionManager" ref="transactionManager"/>
     </bean>
         </property>
         <property name="activationSpec">
     <bean class="org.apache.activemq.ra.ActiveMQActivationSpec">
       <property name="destination" value="myQueue"/>
       <property name="destinationType" value="javax.jms.Queue"/>
     </bean>
   </property>
 </bean>

 <bean id="transactionManager" class="org.springframework.transaction.jta.JtaTransactionManager"/>
```
または、リソースプロバイダーの ActivationSpec オブジェクトを確認してください。これは、プロバイダー固有の構成フラグ（例: ActiveMQActivationSpec の "useRAManagedTransaction" Bean プロパティ。
```
 <bean class="org.springframework.jca.endpoint.GenericMessageEndpointManager">
         <property name="resourceAdapter" ref="resourceAdapter"/>
         <property name="messageEndpointFactory">
     <bean class="org.springframework.jca.endpoint.GenericMessageEndpointFactory">
       <property name="messageListener" ref="messageListener"/>
     </bean>
         </property>
         <property name="activationSpec">
     <bean class="org.apache.activemq.ra.ActiveMQActivationSpec">
       <property name="destination" value="myQueue"/>
       <property name="destinationType" value="javax.jms.Queue"/>
       <property name="useRAManagedTransaction" value="true"/>
     </bean>
   </property>
 </bean>
```
導入:
2.5
作成者:
Juergen Hoeller
関連事項:
ResourceAdapter.endpointActivation(javax.resource.spi.endpoint.MessageEndpointFactory, javax.resource.spi.ActivationSpec)EE, ResourceAdapter.endpointDeactivation(javax.resource.spi.endpoint.MessageEndpointFactory, javax.resource.spi.ActivationSpec)EE, MessageEndpointFactoryEE, ActivationSpecEE

フィールドサマリー
- インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
  DEFAULT_PHASE

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
GenericMessageEndpointManager()

コンストラクター
コンストラクターと説明
`GenericMessageEndpointManager()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` メッセージのエンドポイントを準備し、"autoStartup" フラグが "true" に設定されている場合は、それを自動的にアクティブにします。
`void`	`destroy()` メッセージエンドポイントを非アクティブ化し、シャットダウンの準備をします。
`ActivationSpecEE`	`getActivationSpec()` エンドポイントのアクティブ化に使用する JCA ActivationSpec を返します。
`MessageEndpointFactoryEE`	`getMessageEndpointFactory()` JCA MessageEndpointFactory を返却してアクティブにします。
`int`	`getPhase()` このエンドポイントマネージャーが開始および停止されるフェーズを返します。
`ResourceAdapterEE`	`getResourceAdapter()` エンドポイントを管理する JCA ResourceAdapter を返します。
`boolean`	`isAutoStartup()` 'autoStartup' プロパティの値を返します。
`boolean`	`isRunning()` 設定されたメッセージエンドポイントが現在アクティブかどうかを返します。
`void`	`setActivationSpec(ActivationSpecEE activationSpec)` エンドポイントのアクティブ化に使用する JCA ActivationSpec を設定します。
`void`	`setAutoStartup(boolean autoStartup)` このエンドポイントマネージャーが初期化され、コンテキストがリフレッシュされた後に、エンドポイントのアクティブ化を自動で開始するかどうかを設定します。
`void`	`setMessageEndpointFactory(MessageEndpointFactoryEE messageEndpointFactory)` エンドポイントが委譲する MessageListener オブジェクトを指すように、JCA MessageEndpointFactory をアクティブに設定します。
`void`	`setPhase(int phase)` この Endpoint Manager を開始および停止するフェーズを指定します。
`void`	`setResourceAdapter(ResourceAdapterEE resourceAdapter)` エンドポイントを管理する JCA ResourceAdapter を設定します。
`void`	`start()` 設定されたメッセージエンドポイントをアクティブ化します。
`void`	`stop()` 設定されたメッセージエンドポイントを非アクティブ化します。
`void`	`stop(RunnableSE callback)` Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - GenericMessageEndpointManager
```
public GenericMessageEndpointManager()
```
- メソッドの詳細
  - setResourceAdapter
```
public void setResourceAdapter(@Nullable
                               ResourceAdapterEE resourceAdapter)
```
    エンドポイントを管理する JCA ResourceAdapter を設定します。
  - getResourceAdapter
```
@Nullable
public ResourceAdapterEE getResourceAdapter()
```
    エンドポイントを管理する JCA ResourceAdapter を返します。
  - setMessageEndpointFactory
```
public void setMessageEndpointFactory(@Nullable
                                      MessageEndpointFactoryEE messageEndpointFactory)
```
    エンドポイントが委譲する MessageListener オブジェクトを指すように、JCA MessageEndpointFactory をアクティブに設定します。
    MessageEndpointFactory インスタンスは、異なる ActivationSpec オブジェクトを適用して、複数のエンドポイント（つまり、複数の GenericMessageEndpointManager インスタンス）で共有できます。
    関連事項:
    GenericMessageEndpointFactory.setMessageListener(java.lang.Object)
  - getMessageEndpointFactory
```
@Nullable
public MessageEndpointFactoryEE getMessageEndpointFactory()
```
    JCA MessageEndpointFactory を返却してアクティブにします。
  - setActivationSpec
```
public void setActivationSpec(@Nullable
                              ActivationSpecEE activationSpec)
```
    エンドポイントのアクティブ化に使用する JCA ActivationSpec を設定します。
    この ActivationSpec インスタンスを複数の ResourceAdapter インスタンス間で共有しないでください。
  - getActivationSpec
```
@Nullable
public ActivationSpecEE getActivationSpec()
```
    エンドポイントのアクティブ化に使用する JCA ActivationSpec を返します。
  - setAutoStartup
```
public void setAutoStartup(boolean autoStartup)
```
    このエンドポイントマネージャーが初期化され、コンテキストがリフレッシュされた後に、エンドポイントのアクティブ化を自動で開始するかどうかを設定します。
    デフォルトは "true" です。このフラグをオフにして、明示的な start() 呼び出しまでエンドポイントのアクティブ化を延期します。
  - isAutoStartup
```
public boolean isAutoStartup()
```
    'autoStartup' プロパティの値を返します。"true" の場合、このエンドポイントマネージャーは ContextRefreshedEvent で起動します。
    次で指定:
    インターフェース SmartLifecycle の isAutoStartup
    関連事項:
    Lifecycle.start(), SmartLifecycle.getPhase(), LifecycleProcessor.onRefresh(), ConfigurableApplicationContext.refresh()
  - setPhase
```
public void setPhase(int phase)
```
    この Endpoint Manager を開始および停止するフェーズを指定します。起動順序は最低から最高に進み、シャットダウン順序はその逆です。デフォルトでは、この値は Integer.MAX_VALUE です。これは、このエンドポイントマネージャーができるだけ遅く開始し、できるだけ早く停止することを意味します。
  - getPhase
```
public int getPhase()
```
    このエンドポイントマネージャーが開始および停止されるフェーズを返します。
    次で指定:
    インターフェース Phased の getPhase
    次で指定:
    インターフェース SmartLifecycle の getPhase
    関連事項:
    SmartLifecycle.isAutoStartup(), Lifecycle.start(), SmartLifecycle.stop(Runnable), DefaultLifecycleProcessor.getPhase(Lifecycle)
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws ResourceExceptionEE
```
    メッセージのエンドポイントを準備し、"autoStartup" フラグが "true" に設定されている場合は、それを自動的にアクティブにします。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    ResourceExceptionEE
  - start
```
public void start()
```
    設定されたメッセージエンドポイントをアクティブ化します。
    次で指定:
    インターフェース Lifecycle の start
    関連事項:
    SmartLifecycle.isAutoStartup()
  - stop
```
public void stop()
```
    設定されたメッセージエンドポイントを非アクティブ化します。
    次で指定:
    インターフェース Lifecycle の stop
    関連事項:
    SmartLifecycle.stop(Runnable), DisposableBean.destroy()
  - stop
```
public void stop(RunnableSE callback)
```
    インターフェースからコピーされた説明: SmartLifecycle
    Lifecycle コンポーネントが現在実行中の場合、停止する必要があることを示します。
    提供されたコールバックは、LifecycleProcessor によって使用され、共通のシャットダウン順序値を持つすべてのコンポーネントの順序付けられた、潜在的に同時のシャットダウンをサポートします。コールバックは、SmartLifecycle コンポーネントが実際に停止した後に実行する必要があります。
    LifecycleProcessor は、stop メソッドのこのバリアントのみを呼び出します。つまり、SmartLifecycle 実装では、このメソッドの実装内に明示的に委譲されない限り、Lifecycle.stop() は呼び出されません。
    デフォルトの実装は Lifecycle.stop() に委譲し、呼び出しスレッドで指定されたコールバックをすぐにトリガーします。2 つの間に同期がないことに注意してください。カスタム実装では、少なくとも共通のライフサイクルモニター（存在する場合）内に同じ手順を入れたい場合があります。
    次で指定:
    インターフェース SmartLifecycle の stop
    関連事項:
    Lifecycle.stop(), SmartLifecycle.getPhase()
  - isRunning
```
public boolean isRunning()
```
    設定されたメッセージエンドポイントが現在アクティブかどうかを返します。
    次で指定:
    インターフェース Lifecycle の isRunning
    戻り値:
    コンポーネントが現在実行中かどうか
  - destroy
```
public void destroy()
```
    メッセージエンドポイントを非アクティブ化し、シャットダウンの準備をします。
    次で指定:
    インターフェース DisposableBean の destroy

クラス GenericMessageEndpointManager

フィールドサマリー

インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

GenericMessageEndpointManager

メソッドの詳細

setResourceAdapter

getResourceAdapter

setMessageEndpointFactory

getMessageEndpointFactory

setActivationSpec

getActivationSpec

setAutoStartup

isAutoStartup

setPhase

getPhase

afterPropertiesSet

start

stop

stop

isRunning

destroy