パッケージ jakarta.ejb

インターフェース TimerService

public interface TimerService
TimerService インターフェースは、エンタープライズ Bean コンポーネントに、コンテナー提供のタイマーサービスへのアクセスを提供します。エンタープライズ Bean タイマーサービスによって、ステートレスセッション Bean、シングルトンセッション Bean、メッセージ駆動型 Bean、およびエンタープライズ Bean 2.x エンティティ Bean を、指定時刻、指定経過時間後、指定間隔後、カレンダーベースのスケジュールに従ってタイマーコールバックイベントに登録することが可能となります。
導入:
EJB 2.1

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    Timer
    createCalendarTimer(ScheduleExpression schedule)
    入力スケジュール式に基づいてカレンダーベースのタイマーを作成します。
    Timer
    createCalendarTimer(ScheduleExpression schedule, TimerConfig timerConfig)
    入力スケジュール式に基づいてカレンダーベースのタイマーを作成します。
    Timer
    createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig)
    指定した期間後に最初の有効期限が発生し、指定した間隔後に後続の有効期限が発生する間隔タイマーを作成します。
    Timer
    createIntervalTimer(DateSE initialExpiration, long intervalDuration, TimerConfig timerConfig)
    最初の有効期限が特定の時点で発生し、後続の有効期限が指定された間隔後に発生するインターバルタイマーを作成します。
    Timer
    createSingleActionTimer(long duration, TimerConfig timerConfig)
    指定された期間の後に期限切れになる単一アクションタイマーを作成します。
    Timer
    createSingleActionTimer(DateSE expiration, TimerConfig timerConfig)
    特定の時点で期限切れになる単一アクションタイマーを作成します。
    Timer
    createTimer(long initialDuration, long intervalDuration, SerializableSE info)
    指定した期間後に最初の有効期限が発生し、指定した間隔後に後続の有効期限が発生する間隔タイマーを作成します。
    Timer
    createTimer(long duration, SerializableSE info)
    指定された期間の後に期限切れになる単一アクションタイマーを作成します。
    Timer
    createTimer(DateSE initialExpiration, long intervalDuration, SerializableSE info)
    最初の有効期限が特定の時点で発生し、後続の有効期限が指定された間隔後に発生するインターバルタイマーを作成します。
    Timer
    createTimer(DateSE expiration, SerializableSE info)
    特定の時点で期限切れになる単一アクションタイマーを作成します。
    CollectionSE<Timer>
    getAllTimers()
    呼び出し元 Bean がパッケージ化されている同じモジュール内の Bean に関連付けられているすべてのアクティブなタイマーを返します。
    CollectionSE<Timer>
    getTimers()
    この Bean に関連付けられているすべてのアクティブタイマーを返します。

  • メソッドの詳細

    • createTimer

      Timer createTimer(long duration, SerializableSE info) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      指定された期間の後に期限切れになる単一アクションタイマーを作成します。
      パラメーター:
      duration - タイマーが期限切れになるまでに経過しなければならないミリ秒数。
      info - タイマー満了通知とともに配信されるアプリケーション情報。これは null にすることができます。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - 期間が負の場合
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - この方法がシステムレベルの障害のために失敗した場合。

    • createSingleActionTimer

      Timer createSingleActionTimer(long duration, TimerConfig timerConfig) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      指定された期間の後に期限切れになる単一アクションタイマーを作成します。
      パラメーター:
      duration - タイマーが期限切れになるまでに経過しなければならないミリ秒数。
      timerConfig - タイマー設定。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - 期間が負の場合
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - この方法がシステムレベルの障害のために失敗した場合。
      導入:
      EJB 3.1

    • createTimer

      Timer createTimer(long initialDuration, long intervalDuration, SerializableSE info) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      指定した期間後に最初の有効期限が発生し、指定した間隔後に後続の有効期限が発生する間隔タイマーを作成します。
      パラメーター:
      initialDuration - 最初のタイマー満了通知までに経過する必要があるミリ秒数。
      intervalDuration - タイマーの期限切れ通知の間に経過しなければならないミリ秒数。期限切れ通知は、最初の期限切れの時間を基準にしてスケジュールされます。有効期限が遅延する場合（たとえば、Bean での他のメソッド呼び出しのインターリーブが原因）、「追いつく」ために 2 つ以上の有効期限通知が連続して発生する場合があります。
      info - タイマーの有効期限とともに配信されるアプリケーション情報。これは null にすることができます。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - initialDuration が負の場合、または intervalDuration が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。

    • createIntervalTimer

      Timer createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      指定した期間後に最初の有効期限が発生し、指定した間隔後に後続の有効期限が発生する間隔タイマーを作成します。
      パラメーター:
      initialDuration - 最初のタイマー満了通知までに経過する必要があるミリ秒数。
      intervalDuration - タイマーの期限切れ通知の間に経過しなければならないミリ秒数。期限切れ通知は、最初の期限切れの時間を基準にしてスケジュールされます。有効期限が遅延する場合（たとえば、Bean での他のメソッド呼び出しのインターリーブが原因）、「追いつく」ために 2 つ以上の有効期限通知が連続して発生する場合があります。
      timerConfig - タイマー設定
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - initialDuration が負の場合、または intervalDuration が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.1

    • createTimer

      Timer createTimer(DateSE expiration, SerializableSE info) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      特定の時点で期限切れになる単一アクションタイマーを作成します。
      パラメーター:
      expiration - タイマーの有効期限が切れる時点。
      info - タイマー満了通知とともに配信されるアプリケーション情報。これは null にすることができます。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - 有効期限が null または expiration.getTime() が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。

    • createSingleActionTimer

      Timer createSingleActionTimer(DateSE expiration, TimerConfig timerConfig) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      特定の時点で期限切れになる単一アクションタイマーを作成します。
      パラメーター:
      expiration - タイマーが期限切れになる必要がある時点。
      timerConfig - タイマー設定。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - 有効期限が null または expiration.getTime() が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.1

    • createTimer

      Timer createTimer(DateSE initialExpiration, long intervalDuration, SerializableSE info) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      最初の有効期限が特定の時点で発生し、後続の有効期限が指定された間隔後に発生するインターバルタイマーを作成します。
      パラメーター:
      initialExpiration - 最初のタイマー満了が発生する必要がある時点。
      intervalDuration - タイマーの期限切れ通知の間に経過しなければならないミリ秒数。有効期限の通知は、最初の有効期限の時刻を基準にしてスケジュールされます。（Bean の他のメソッド呼び出しのインターリーブなどが原因で）有効期限が遅延している場合、「追いつき」に連続して 2 つ以上の有効期限通知が発生することがあります。
      info - タイマーの有効期限とともに配信されるアプリケーション情報。これは null にすることができます。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - initialExpiration が null の場合、initialExpiration.getTime() が負の場合、または intervalDuration が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。

    • createIntervalTimer

      Timer createIntervalTimer(DateSE initialExpiration, long intervalDuration, TimerConfig timerConfig) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      最初の有効期限が特定の時点で発生し、後続の有効期限が指定された間隔後に発生するインターバルタイマーを作成します。
      パラメーター:
      initialExpiration - 最初のタイマー満了が発生する必要がある時点。
      intervalDuration - タイマーの期限切れ通知の間に経過しなければならないミリ秒数。有効期限の通知は、最初の有効期限の時刻を基準にしてスケジュールされます。（Bean の他のメソッド呼び出しのインターリーブなどが原因で）有効期限が遅延している場合、「追いつき」に連続して 2 つ以上の有効期限通知が発生することがあります。
      timerConfig - タイマー設定。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - initialExpiration が null の場合、initialExpiration.getTime() が負の場合、または intervalDuration が負の場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.1

    • createCalendarTimer

      Timer createCalendarTimer(ScheduleExpression schedule) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      入力スケジュール式に基づいてカレンダーベースのタイマーを作成します。
      パラメーター:
      schedule - このタイマーのタイムアウトを説明するスケジュール式。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - Schedule が無効なスケジュール式を表す場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.1

    • createCalendarTimer

      Timer createCalendarTimer(ScheduleExpression schedule, TimerConfig timerConfig) throws IllegalArgumentExceptionSE, IllegalStateExceptionSE, EJBException
      入力スケジュール式に基づいてカレンダーベースのタイマーを作成します。
      パラメーター:
      schedule - このタイマーのタイムアウトを説明するスケジュール式。
      timerConfig - タイマー設定。
      戻り値:
      新しく作成されたタイマー。
      例外:
      IllegalArgumentExceptionSE - Schedule が無効なスケジュール式を表す場合。
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.1

    • getTimers

      CollectionSE<Timer> getTimers() throws IllegalStateExceptionSE, EJBException
      この Bean に関連付けられているすべてのアクティブなタイマーを返します。これらには、プログラムで作成されたタイマーと自動的に作成されたタイマーの両方が含まれます。
      戻り値:
      jakarta.ejb.Timer オブジェクトのコレクション。
      例外:
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。

    • getAllTimers

      CollectionSE<Timer> getAllTimers() throws IllegalStateExceptionSE, EJBException
      呼び出し元の Bean がパッケージ化されている同じモジュール内の Bean に関連付けられているすべてのアクティブなタイマーを返します。これらには、プログラムで作成されたタイマーと自動的に作成されたタイマーの両方が含まれます。
      戻り値:
      jakarta.ejb.Timer オブジェクトのコレクション。
      例外:
      IllegalStateExceptionSE - インスタンスがこのメソッドへのアクセスを許可しない状態にあるときにこのメソッドが呼び出された場合。
      EJBException - システムレベルの障害のためにこの方法を完了できなかった場合。
      導入:
      EJB 3.2