WorkManagerTaskExecutor (Spring Framework API)

java.lang.ObjectSE
- org.springframework.jndi.JndiAccessor
- - org.springframework.jndi.JndiLocatorSupport
  - - org.springframework.jca.work.WorkManagerTaskExecutor

実装されたすべてのインターフェース:
ExecutorSE, WorkManagerEE, Aware, InitializingBean, AsyncListenableTaskExecutor, AsyncTaskExecutor, TaskExecutor, BootstrapContextAware, SchedulingTaskExecutor
```
public class WorkManagerTaskExecutor
extends JndiLocatorSupport
implements AsyncListenableTaskExecutor, SchedulingTaskExecutor, WorkManagerEE, BootstrapContextAware, InitializingBean
```
WorkManagerEE インターフェースを実装する JCA 1.7 WorkManager に委譲する TaskExecutor 実装。
これは主に JCA ResourceAdapter 実装内での使用を目的としていますが、スタンドアロン環境で使用して、ローカルに埋め込まれた WorkManager 実装（Geronimo など）に委譲することもできます。
また、JCA 1.7 WorkManager インターフェース自体を実装し、すべての呼び出しをターゲット WorkManager に委譲します。呼び出し元は、Spring TaskExecutor インターフェースまたは WorkManager インターフェースを介してこのエグゼキューターと通信するかどうかを選択できます。
このアダプターは、JNDI から JCA WorkManager を取得することもできます。これは、たとえば、WorkManager GBean（たとえば Geronimo のデフォルトの "DefaultWorkManager" GBean）が geronimo-web.xml デプロイ記述子の "gbean-ref" エントリを介して Java EE 環境にリンクできる Geronimo アプリケーションサーバーで適切です。
導入:
2.0.3
作成者:
Juergen Hoeller
関連事項:
setWorkManager(javax.resource.spi.work.WorkManager), WorkManager.scheduleWork(javax.resource.spi.work.Work)EE

フィールドサマリー
- クラス org.springframework.jndi.JndiLocatorSupport から継承されたフィールド
  CONTAINER_PREFIX
- クラス org.springframework.jndi.JndiAccessor から継承されたフィールド
  logger
- インターフェース org.springframework.core.task.AsyncTaskExecutor から継承されたフィールド
  TIMEOUT_IMMEDIATE, TIMEOUT_INDEFINITE
- インターフェース javax.resource.spi.work.WorkManagerEE から継承されたフィールド
  IMMEDIATEEE, INDEFINITEEE, UNKNOWNEE

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

コンストラクター
コンストラクターと説明
`WorkManagerTaskExecutor()` Bean スタイルの構成を想定して、新しい WorkManagerTaskExecutor を作成します。
`WorkManagerTaskExecutor(WorkManagerEE workManager)` 指定された WorkManager の新しい WorkManagerTaskExecutor を作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` すべての Bean プロパティを設定し、`BeanFactoryAware`、`ApplicationContextAware` などを満たした後、包含 `BeanFactory` によって呼び出されます。
`void`	`doWork(WorkEE work)`
`void`	`doWork(WorkEE work, long delay, ExecutionContextEE executionContext, WorkListenerEE workListener)`
`void`	`execute(RunnableSE task)` 指定された `task` を実行します。
`void`	`execute(RunnableSE task, long startTimeout)` 指定された `task` を実行します。
`protected WorkManagerEE`	`getDefaultWorkManager()` 委譲先のデフォルト WorkManager を取得します。
`void`	`scheduleWork(WorkEE work)`
`void`	`scheduleWork(WorkEE work, long delay, ExecutionContextEE executionContext, WorkListenerEE workListener)`
`void`	`setBlockUntilCompleted(boolean blockUntilCompleted)` 作業が完了するまで `execute(java.lang.Runnable)` をブロックさせるかどうかを設定します。
`void`	`setBlockUntilStarted(boolean blockUntilStarted)` 実際に作業が開始されるまで `execute(java.lang.Runnable)` をブロックさせるかどうかを設定します。
`void`	`setBootstrapContext(BootstrapContextEE bootstrapContext)` 委譲先の WorkManager を含む JCA BootstrapContext を指定します。
`void`	`setTaskDecorator(TaskDecorator taskDecorator)` 実行しようとしている `Runnable`SE に適用するカスタム `TaskDecorator` を指定します。
`void`	`setWorkListener(WorkListenerEE workListener)` 適用する JCA WorkListener を指定します（ある場合）。
`void`	`setWorkManager(WorkManagerEE workManager)` 委譲先の JCA WorkManager インスタンスを指定します。
`void`	`setWorkManagerName(StringSE workManagerName)` JCA WorkManager の JNDI 名を設定します。
`long`	`startWork(WorkEE work)`
`long`	`startWork(WorkEE work, long delay, ExecutionContextEE executionContext, WorkListenerEE workListener)`
`<T> FutureSE<T>`	`submit(CallableSE<T> task)` Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。
`FutureSE<?>`	`submit(RunnableSE task)` 実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。
`<T> ListenableFuture<T>`	`submitListenable(CallableSE<T> task)` `Callable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。
`ListenableFuture<?>`	`submitListenable(RunnableSE task)` `Runnable` タスクを実行のために送信し、そのタスクを表す `ListenableFuture` を受け取ります。

クラス org.springframework.jndi.JndiLocatorSupport から継承されたメソッド
convertJndiName, isResourceRef, lookup, lookup, setResourceRef

クラス org.springframework.jndi.JndiAccessor から継承されたメソッド
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

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

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド
prefersShortLivedTasks

- コンストラクターの詳細
  - WorkManagerTaskExecutor
```
public WorkManagerTaskExecutor()
```
    Bean スタイルの構成を想定して、新しい WorkManagerTaskExecutor を作成します。
    関連事項:
    setWorkManager(javax.resource.spi.work.WorkManager)
  - WorkManagerTaskExecutor
```
public WorkManagerTaskExecutor(WorkManagerEE workManager)
```
    指定された WorkManager の新しい WorkManagerTaskExecutor を作成します。
    パラメーター:
    workManager - 委譲する JCA WorkManager
- メソッドの詳細
  - setWorkManager
```
public void setWorkManager(WorkManagerEE workManager)
```
    委譲先の JCA WorkManager インスタンスを指定します。
  - setWorkManagerName
```
public void setWorkManagerName(StringSE workManagerName)
```
    JCA WorkManager の JNDI 名を設定します。
    これは完全修飾 JNDI 名、または "resourceRef" が "true" に設定されている場合は現在の環境のネーミングコンテキストに関連する JNDI 名のいずれかです。
    関連事項:
    setWorkManager(javax.resource.spi.work.WorkManager), JndiLocatorSupport.setResourceRef(boolean)
  - setBootstrapContext
```
public void setBootstrapContext(BootstrapContextEE bootstrapContext)
```
    委譲先の WorkManager を含む JCA BootstrapContext を指定します。
    次で指定:
    インターフェース BootstrapContextAware の setBootstrapContext
    パラメーター:
    bootstrapContext - このオブジェクトによって使用される BootstrapContext オブジェクト
    関連事項:
    InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)
  - setBlockUntilStarted
```
public void setBlockUntilStarted(boolean blockUntilStarted)
```
    実際に作業が開始されるまで execute(java.lang.Runnable) をブロックさせるかどうかを設定します。
    デフォルトの scheduleWork の代わりに、下にある JCA startWork 操作を使用します。
    関連事項:
    WorkManager.startWork(javax.resource.spi.work.Work)EE, WorkManager.scheduleWork(javax.resource.spi.work.Work)EE
  - setBlockUntilCompleted
```
public void setBlockUntilCompleted(boolean blockUntilCompleted)
```
    作業が完了するまで execute(java.lang.Runnable) をブロックさせるかどうかを設定します。
    デフォルトの scheduleWork の代わりに、下にある JCA doWork 操作を使用します。
    関連事項:
    WorkManager.doWork(javax.resource.spi.work.Work)EE, WorkManager.scheduleWork(javax.resource.spi.work.Work)EE
  - setWorkListener
```
public void setWorkListener(@Nullable
                            WorkListenerEE workListener)
```
    適用する JCA WorkListener を指定します（ある場合）。
    この共有 WorkListener インスタンスは、この TaskExecutor のすべての execute(java.lang.Runnable) 呼び出しによって WorkManager に渡されます。
  - setTaskDecorator
```
public void setTaskDecorator(TaskDecorator taskDecorator)
```
    実行しようとしている RunnableSE に適用するカスタム TaskDecorator を指定します。
    このようなデコレータは、必ずしもユーザー提供の Runnable/Callable に適用されるのではなく、実際の実行コールバック（ユーザー提供のタスクのラッパーである可能性があります）に適用されることに注意してください。
    主な使用例は、タスクの呼び出しの周囲に実行コンテキストを設定するか、タスク実行の監視 / 統計を提供することです。
    注意 : TaskDecorator 実装での例外処理は、execute 呼び出しによる単純な Runnable 実行に制限されています。#submit 呼び出しの場合、公開された Runnable は、例外を伝搬しない FutureTask になります。例外を評価するには、キャストして Future#get を呼び出す必要がある場合があります。
    導入:
    4.3
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws NamingExceptionSE
```
    インターフェースからコピーされた説明: InitializingBean
    すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    NamingExceptionSE
  - getDefaultWorkManager
```
protected WorkManagerEE getDefaultWorkManager()
```
    委譲先のデフォルト WorkManager を取得します。明示的な WorkManager または WorkManager JNDI 名が指定されていない場合に呼び出されます。
    デフォルトの実装は SimpleTaskWorkManager を返します。サブクラスでオーバーライドできます。
  - execute
```
public void execute(RunnableSE task)
```
    インターフェースからコピーされた説明: TaskExecutor
    指定された task を実行します。
    実装が非同期実行戦略を使用している場合、呼び出しはすぐに戻るか、同期実行の場合はブロックする可能性があります。
    次で指定:
    インターフェース ExecutorSE の executeSE
    次で指定:
    インターフェース TaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
  - execute
```
public void execute(RunnableSE task,
                    long startTimeout)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    指定された task を実行します。
    次で指定:
    インターフェース AsyncTaskExecutor の execute
    パラメーター:
    task - 実行する Runnable (非 null)
    startTimeout - タスクが開始される予定の期間（ミリ秒）。これはエグゼキューターへのヒントとして意図されており、即時タスクの優先処理を可能にします。一般的な値は AsyncTaskExecutor.TIMEOUT_IMMEDIATE または AsyncTaskExecutor.TIMEOUT_INDEFINITE（TaskExecutor.execute(Runnable) で使用されるデフォルト）です。
  - submit
```
public FutureSE<?> submit(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    実行可能な Runnable タスクを送信し、そのタスクを表す Future を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    タスクの保留中の補完を表す Future
  - submit
```
public <T> FutureSE<T> submit(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncTaskExecutor
    Callable タスクを送信して実行し、そのタスクを表す Future を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncTaskExecutor の submit
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    タスクの保留中の補完を表す Future
  - submitListenable
```
public ListenableFuture<?> submitListenable(RunnableSE task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Runnable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は完了時に null の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Runnable (非 null)
    戻り値:
    保留中のタスクの補完を表す ListenableFuture
  - submitListenable
```
public <T> ListenableFuture<T> submitListenable(CallableSE<T> task)
```
    インターフェースからコピーされた説明: AsyncListenableTaskExecutor
    Callable タスクを実行のために送信し、そのタスクを表す ListenableFuture を受け取ります。Future は、完了時に Callable の結果を返します。
    次で指定:
    インターフェース AsyncListenableTaskExecutor の submitListenable
    パラメーター:
    task - 実行する Callable (非 null)
    戻り値:
    保留中のタスクの補完を表す ListenableFuture
  - doWork
```
public void doWork(WorkEE work)
            throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の doWorkEE
    例外:
    WorkExceptionEE
  - doWork
```
public void doWork(WorkEE work,
                   long delay,
                   ExecutionContextEE executionContext,
                   WorkListenerEE workListener)
            throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の doWorkEE
    例外:
    WorkExceptionEE
  - startWork
```
public long startWork(WorkEE work)
               throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の startWorkEE
    例外:
    WorkExceptionEE
  - startWork
```
public long startWork(WorkEE work,
                      long delay,
                      ExecutionContextEE executionContext,
                      WorkListenerEE workListener)
               throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の startWorkEE
    例外:
    WorkExceptionEE
  - scheduleWork
```
public void scheduleWork(WorkEE work)
                  throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の scheduleWorkEE
    例外:
    WorkExceptionEE
  - scheduleWork
```
public void scheduleWork(WorkEE work,
                         long delay,
                         ExecutionContextEE executionContext,
                         WorkListenerEE workListener)
                  throws WorkExceptionEE
```
    次で指定:
    インターフェース WorkManagerEE の scheduleWorkEE
    例外:
    WorkExceptionEE

クラス WorkManagerTaskExecutor

フィールドサマリー

クラス org.springframework.jndi.JndiLocatorSupport から継承されたフィールド

クラス org.springframework.jndi.JndiAccessor から継承されたフィールド

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

インターフェース javax.resource.spi.work.WorkManagerEE から継承されたフィールド

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

メソッドのサマリー

クラス org.springframework.jndi.JndiLocatorSupport から継承されたメソッド

クラス org.springframework.jndi.JndiAccessor から継承されたメソッド

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

インターフェース org.springframework.scheduling.SchedulingTaskExecutor から継承されたメソッド

コンストラクターの詳細

WorkManagerTaskExecutor

WorkManagerTaskExecutor

メソッドの詳細

setWorkManager

setWorkManagerName

setBootstrapContext

setBlockUntilStarted

setBlockUntilCompleted

setWorkListener

setTaskDecorator

afterPropertiesSet

getDefaultWorkManager

execute

execute

submit

submit

submitListenable

submitListenable

doWork

doWork

startWork

startWork

scheduleWork

scheduleWork