public final class TaskManager extends Object
修飾子とタイプ | メソッドと説明 |
---|---|
static ParallelizedTaskMessage |
addParallelizedTask(String taskClassName,
Map<String,?> parameter)
並列処理キューにメッセージを追加します。
|
static ParallelizedTaskMessage |
addParallelizedTask(String taskClassName,
Map<String,?> parameter,
boolean keepTaskMessageOnError)
並列処理キューにメッセージを追加します。
|
static SerializedTaskMessage |
addSerializedTask(String queueId,
String taskClassName,
Map<String,?> parameter,
boolean stopProgressOnError)
直列処理キューにメッセージを追加します。
|
static SerializedTaskMessage |
addSerializedTask(String queueId,
String taskClassName,
Map<String,?> parameter,
boolean stopProgressOnError,
boolean keepTaskMessageOnError)
直列処理キューにメッセージを追加します。
|
static boolean |
addSerializedTaskQueue(String queueId,
boolean active)
キューIDで指定された直列タスクキューを追加します。
|
static List<RegisteredSerializedTaskQueueStatus> |
getAllSerializedTaskQueuesStatus()
すべて直列キューの状態を取得します。
|
static SearchRegisteredParallelizedTaskInfo |
getParallelizedErroredTaskInfo(String sort,
String order,
int startIndex,
int length)
並列キューのエラー終了タスク情報を取得します。
|
static SearchRegisteredParallelizedTaskInfo |
getParallelizedRunningTaskInfo(String sort,
String order,
int startIndex,
int length)
並列キューの実行中タスク情報を取得します。
|
static RegisteredParallelizedTaskQueueStatus |
getParallelizedTaskQueuesStatus()
並列キューのタスク状態を取得します。
|
static SearchRegisteredParallelizedTaskInfo |
getParallelizedWaitingTaskInfo(String sort,
String order,
int startIndex,
int length)
並列キューの待ちタスク情報を取得します。
|
static RegisteredInfo |
getRegisteredInfo()
現在登録されているタスクやキューの状態を取得します。
|
static SearchRegisteredSerializedTaskInfo |
getSerializedErroredTaskInfo(String queueId,
String sort,
String order,
int startIndex,
int length)
直列キューのエラー終了タスク情報を取得します。
|
static SearchRegisteredSerializedTaskInfo |
getSerializedTaskInfo(String queueId,
String sort,
String order,
int startIndex,
int length)
直列キューのタスク情報を取得します。
|
static RegisteredSerializedTaskQueueStatus |
getSerializedTaskQueuesStatusById(String queueId)
キューIDにより、直列キューの状態を取得します。
|
static TaskStatus |
getTaskStatusById(String messageId)
指定されたタスクの状況を取得します。
|
static TaskMessage |
reentryErroredTask(String messageId,
boolean usePreviousContext)
メッセージIDで指定されたエラー終了タスクを、前回実行時と同一のパラメータで再登録します。
|
static TaskMessage |
reentryErroredTask(String messageId,
boolean usePreviousContext,
Map<String,?> parameter)
メッセージIDで指定されたエラー終了タスクを、指定されたパラメータで再登録します。
|
static ParallelizedTaskMessage |
releaseRunningParallelizedTask(String messageId,
boolean reentry,
boolean stop)
メッセージIDで指定された並列タスクに対して終了を通知します。
|
static SerializedTaskMessage |
releaseRunningSerializedTask(String messageId,
boolean reentry,
boolean stop)
メッセージIDで指定された直列タスクに対して終了を通知します。
|
static SearchRegisteredTaskInfo<? extends RegisteredTaskInfo> |
removeErroredTask(String messageId)
メッセージIDで指定されたエラー終了タスクを削除します。
|
static boolean |
removeParallelizedTask(String messageId)
指定された並列タスクを削除します。
|
static boolean |
removeSerializedTask(String messageId)
指定された直列タスクを削除します。
|
static boolean |
removeSerializedTaskQueue(String queueId)
キューIDで指定された直列タスクキューを削除します。
|
static void |
setParallelizedTaskQueueActive(boolean active)
並列タスクの処理実行を開始または停止します。
|
static void |
setSerializedTaskQueueActive(String queueId,
boolean active)
キューIDで指定された直列タスクの処理実行を開始または停止します。
|
static ParallelizedTaskMessage |
stopRunningParallelizedTask(String messageId,
boolean reentry,
boolean stop)
非推奨です。
このメソッドは内部で
Thread.stop() を呼び出します。このメソッドの代わりに
releaseRunningParallelizedTask(String, boolean, boolean) を利用するようにしてください。 |
static SerializedTaskMessage |
stopRunningSerializedTask(String messageId,
boolean reentry,
boolean stop)
非推奨です。
このメソッドは内部で
Thread.stop() を呼び出します。このメソッドの代わりに
releaseRunningSerializedTask(String, boolean, boolean) を利用するようにしてください。 |
public static void setParallelizedTaskQueueActive(boolean active) throws TaskControlException
active
- true
: 並列タスクの処理実行を開始false
: 並列タスクの処理実行を停止TaskControlException
- 開始または停止時に例外が発生public static ParallelizedTaskMessage addParallelizedTask(String taskClassName, Map<String,?> parameter) throws TaskControlException
taskClassName
- 並列タスク処理クラス名parameter
- パラメータParallelizedTaskMessage
TaskControlException
- キュー管理サービスで異常が発生した場合NullPointerException
- 引数で指定された並列タスク処理クラス名がnull
IllegalArgumentException
- 引数で指定されたパラメータが不正public static ParallelizedTaskMessage addParallelizedTask(String taskClassName, Map<String,?> parameter, boolean keepTaskMessageOnError) throws TaskControlException
taskClassName
- 並列タスク処理クラス名parameter
- パラメータkeepTaskMessageOnError
- true
: 指定したタスクの実行時に例外が発生した場合、タスクメッセージを削除せずに残すfalse
: 指定したタスクの実行時に例外が発生した場合でもタスクメッセージを削除するParallelizedTaskMessage
TaskControlException
- キュー管理サービスで異常が発生した場合NullPointerException
- 引数で指定された並列タスク処理クラス名がnull
IllegalArgumentException
- 引数で指定されたパラメータが不正@Deprecated public static ParallelizedTaskMessage stopRunningParallelizedTask(String messageId, boolean reentry, boolean stop) throws TaskControlException
Thread.stop()
を呼び出します。このメソッドの代わりに
releaseRunningParallelizedTask(String, boolean, boolean)
を利用するようにしてください。停止された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。
このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
null
を返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。
messageId
- メッセージIDreentry
- true
: 待機中並列タスクキューの先頭に同じタスクを追加するfalse
: 待機中並列タスクには再追加しないstop
- true
: 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にするfalse
: 並列タスクキューの処理状態(活性化または非活性化)は変更しないnull
。TaskControlException
- 並列タスクを停止する時に例外が発生public static ParallelizedTaskMessage releaseRunningParallelizedTask(String messageId, boolean reentry, boolean stop) throws TaskControlException
このメソッドでは内部でTask.release()
を呼び出します。
終了を通知された並列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。
このメソッドを呼び出す際、並列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
null
を返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。
messageId
- メッセージIDreentry
- true
: 待機中並列タスクキューの先頭に同じタスクを追加するfalse
: 待機中並列タスクには再追加しないstop
- true
: 並列タスクキューの現在の処理状態にかかわらず並列タスクキューを非活性化状態にするfalse
: 並列タスクキューの処理状態(活性化または非活性化)は変更しないnull
。TaskControlException
- 並列タスクへ終了を通知する時に例外が発生public static boolean removeParallelizedTask(String messageId) throws TaskIllegalStateException, InvalidTaskException, TaskControlException
messageId
- タスクメッセージIDtrue
: タスクを正常に削除したfalse
: タスクが既に削除されていたTaskIllegalStateException
- タスクが削除できない状態であった(実行中等)InvalidTaskException
- メッセージIDが並列タスクのものではないTaskControlException
- タスク削除時に例外が発生public static boolean addSerializedTaskQueue(String queueId, boolean active) throws TaskControlException
キューIDで指定された直列タスクが既に存在する場合は何もしません。この場合、戻り値としてfalse
が返されます。
queueId
- キューIDactive
- true
: 直列タスクの処理実行を開始できる状態で登録するfalse
: 直列タスクの処理実行を開始しない状態で登録するtrue
: キューを追加した場合false
: キューを追加しなかった場合TaskControlException
- キュー追加時に例外が発生public static boolean removeSerializedTaskQueue(String queueId) throws TaskQueueIllegalStateException, TaskControlException
キューIDで指定された直列タスクが存在しない場合は何もしません。この場合、戻り値としてfalse
が返されます。
直列タスクキューを削除する場合、キューの中には実行中および待機中のいずれの直列タスクも含まれていない必要があります。もしタスクが存在する状態でこのメソッドを呼び出すとTaskQueueIllegalStateException
が発生します。
queueId
- キューIDtrue
: キューを削除した場合false
: キューを削除しなかった場合TaskQueueIllegalStateException
- キューにタスクが残っているTaskControlException
- キュー削除時に例外が発生public static void setSerializedTaskQueueActive(String queueId, boolean active) throws TaskControlException
queueId
- キューIDactive
- true
: 直列タスクの処理実行を開始false
: 直列タスクの処理実行を停止TaskControlException
- 開始または停止時に例外が発生public static SerializedTaskMessage addSerializedTask(String queueId, String taskClassName, Map<String,?> parameter, boolean stopProgressOnError) throws TaskControlException
queueId
- キューIDtaskClassName
- 直列タスク処理クラス名parameter
- パラメータstopProgressOnError
- true
: 指定したタスクの実行時に例外が発生した場合、同一キュー内の後続タスク処理を停止するfalse
: 指定したタスクの実行時に例外が発生した場合でも同一キュー内の後続タスク処理を続行するSerializedTaskMessage
、失敗した場合はnull
TaskControlException
- キュー管理サービスで異常が発生した場合NullPointerException
- 引数で指定されたキューIDまたは直列タスク処理クラス名がnull
IllegalArgumentException
- 引数で指定されたパラメータが不正public static SerializedTaskMessage addSerializedTask(String queueId, String taskClassName, Map<String,?> parameter, boolean stopProgressOnError, boolean keepTaskMessageOnError) throws TaskControlException
stopProgressOnError
とkeepTaskMessageOnError
いずれもtrue
が指定されている状態でタスクの実行時に例外が発生した場合は、stopProgressOnError
の指定が優先されます。
そのため、当該タスクメッセージは直列処理キューに再登録され、エラー状態としては残りません。
明示的にエラー状態としてタスクメッセージを残す場合は、stopProgressOnError
にfalse
、keepTaskMessageOnError
にtrue
を指定します。
queueId
- キューIDtaskClassName
- 直列タスク処理クラス名parameter
- パラメータstopProgressOnError
- true
: 指定したタスクの実行時に例外が発生した場合、同一キュー内の後続タスク処理を停止するfalse
: 指定したタスクの実行時に例外が発生した場合でも同一キュー内の後続タスク処理を続行するkeepTaskMessageOnError
- true
: 指定したタスクの実行時に例外が発生した場合、タスクメッセージを削除せずに残すfalse
: 指定したタスクの実行時に例外が発生した場合でもタスクメッセージを削除するSerializedTaskMessage
、失敗した場合はnull
TaskControlException
- キュー管理サービスで異常が発生した場合NullPointerException
- 引数で指定されたキューIDまたは直列タスク処理クラス名がnull
IllegalArgumentException
- 引数で指定されたパラメータが不正@Deprecated public static SerializedTaskMessage stopRunningSerializedTask(String messageId, boolean reentry, boolean stop) throws TaskControlException
Thread.stop()
を呼び出します。このメソッドの代わりに
releaseRunningSerializedTask(String, boolean, boolean)
を利用するようにしてください。停止された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。
このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
null
を返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。
messageId
- メッセージIDreentry
- true
: 待機中直列タスクキューの先頭に同じタスクを追加するfalse
: 待機中直列タスクには再追加しないstop
- true
: 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にするfalse
: 直列タスクキューの処理状態(活性化または非活性化)は変更しないnull
。TaskControlException
- 直列タスクを停止する時に例外が発生public static SerializedTaskMessage releaseRunningSerializedTask(String messageId, boolean reentry, boolean stop) throws TaskControlException
このメソッドでは内部でTask.release()
を呼び出します。
終了を通知された直列タスクをそのまま廃棄するか、再度キューの先頭に追加するかのいずれかの状態にすることが可能です。
このメソッドを呼び出す際、直列処理タスクキューの処理状態に対して以下のいずれかの操作が可能です。
null
を返す場合には、非活性化状態にする指定は無視しタスクキューの処理状態は変更しません。
messageId
- メッセージIDreentry
- true
: 待機中直列タスクキューの先頭に同じタスクを追加するfalse
: 待機中直列タスクには再追加しないstop
- true
: 直列タスクキューの現在の処理状態にかかわらず直列タスクキューを非活性化状態にするfalse
: 直列タスクキューの処理状態(活性化または非活性化)は変更しないnull
。TaskControlException
- 直列タスクへ終了を通知する時に例外が発生public static boolean removeSerializedTask(String messageId) throws TaskIllegalStateException, InvalidTaskException, TaskControlException
messageId
- タスクメッセージIDtrue
: タスクを正常に削除したfalse
: タスクが既に削除されていたTaskIllegalStateException
- タスクが削除できない状態であった(実行中等)InvalidTaskException
- メッセージIDが並列タスクのものではないTaskControlException
- タスク削除時に例外が発生public static RegisteredInfo getRegisteredInfo() throws TaskControlException
RegisteredInfo
TaskControlException
- タスクやキューの状態取得時に例外が発生public static RegisteredSerializedTaskQueueStatus getSerializedTaskQueuesStatusById(String queueId) throws TaskControlException
queueId
- 対象とするキューIDRegisteredSerializedTaskQueueStatus
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredSerializedTaskInfo getSerializedTaskInfo(String queueId, String sort, String order, int startIndex, int length) throws TaskControlException
queueId
- キューIDsort
- ソートカラム名order
- 昇順 asc/降順 descstartIndex
- 取得開始位置(1から)length
- 取得件数(負数場合、全件取得)SearchRegisteredSerializedTaskInfo
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredSerializedTaskInfo getSerializedErroredTaskInfo(String queueId, String sort, String order, int startIndex, int length) throws TaskControlException
queueId
- キューIDsort
- ソートカラム名order
- 昇順 asc/降順 descstartIndex
- 取得開始位置(1から)length
- 取得件数(負数場合、全件取得)SearchRegisteredSerializedTaskInfo
TaskControlException
- キューの状態取得時に例外が発生public static List<RegisteredSerializedTaskQueueStatus> getAllSerializedTaskQueuesStatus() throws TaskControlException
RegisteredSerializedTaskQueueStatus
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredParallelizedTaskInfo getParallelizedRunningTaskInfo(String sort, String order, int startIndex, int length) throws TaskControlException
sort
- ソートカラム名order
- 昇順 asc/降順 descstartIndex
- 取得開始位置(1から)length
- 取得件数(負数場合、全件取得)SearchRegisteredTaskInfo
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredParallelizedTaskInfo getParallelizedWaitingTaskInfo(String sort, String order, int startIndex, int length) throws TaskControlException
sort
- ソートカラム名order
- 昇順 asc/降順 descstartIndex
- 取得開始位置(1から)length
- 取得件数(負数場合、全件取得)SearchRegisteredTaskInfo
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredParallelizedTaskInfo getParallelizedErroredTaskInfo(String sort, String order, int startIndex, int length) throws TaskControlException
sort
- ソートカラム名order
- 昇順 asc/降順 descstartIndex
- 取得開始位置(1から)length
- 取得件数(負数場合、全件取得)SearchRegisteredParallelizedTaskInfo
TaskControlException
- キューの状態取得時に例外が発生public static RegisteredParallelizedTaskQueueStatus getParallelizedTaskQueuesStatus() throws TaskControlException
RegisteredParallelizedTaskQueueStatus
TaskControlException
- キューの状態取得時に例外が発生public static TaskStatus getTaskStatusById(String messageId) throws TaskControlException
messageId
- タスクメッセージIDTaskStatus
TaskControlException
- キューの状態取得時に例外が発生public static SearchRegisteredTaskInfo<? extends RegisteredTaskInfo> removeErroredTask(String messageId) throws TaskIllegalStateException, TaskControlException
messageId
- タスクメッセージIDRegisteredSerializedTaskInfo
、並列タスクを削除した場合: RegisteredParallelizedTaskInfo
)。null
。TaskIllegalStateException
- タスクの状況がエラー終了以外(待機中、実行中)であったTaskControlException
- タスク削除時に例外が発生IllegalArgumentException
- 引数で指定されたパラメータが不正public static TaskMessage reentryErroredTask(String messageId, boolean usePreviousContext) throws TaskIllegalStateException, TaskControlException
messageId
- タスクメッセージIDusePreviousContext
- true
: 前回実行時のアクセスコンテキスト情報を使用するfalse
: 現在のアクセスコンテキスト情報を使用するSerializedTaskMessage
、並列タスクの場合: ParallelizedTaskMessage
)。null
。TaskIllegalStateException
- タスクの状況がエラー終了以外(待機中、実行中)であったTaskControlException
- キュー管理サービスで異常が発生した場合IllegalArgumentException
- 引数で指定されたパラメータが不正public static TaskMessage reentryErroredTask(String messageId, boolean usePreviousContext, Map<String,?> parameter) throws TaskIllegalStateException, TaskControlException
messageId
- タスクメッセージIDusePreviousContext
- true
: 前回実行時のアクセスコンテキスト情報を使用するfalse
: 現在のアクセスコンテキスト情報を使用するparameter
- パラメータSerializedTaskMessage
、並列タスクの場合: ParallelizedTaskMessage
)。null
。TaskIllegalStateException
- タスクの状況がエラー終了以外(待機中、実行中)であったTaskControlException
- キュー管理サービスで異常が発生した場合IllegalArgumentException
- 引数で指定されたパラメータが不正Copyright © 2012 NTT DATA INTRAMART CORPORATION