Package org.jboss.as.ejb3.timerservice

Class TimerServiceImpl

  • All Implemented Interfaces:
    javax.ejb.TimerService, org.jboss.msc.Service, org.jboss.msc.service.Service<javax.ejb.TimerService>, org.jboss.msc.value.Value<javax.ejb.TimerService>
    public class TimerServiceImpl
extends Object
implements javax.ejb.TimerService, org.jboss.msc.service.Service<javax.ejb.TimerService>
    MK2 implementation of Enterprise Beans 3.1 TimerService
    Version:
    $Revision: $
    Author:
    Carlo de Wolf

    • Field Detail

      • SERVICE_NAME

        public static final org.jboss.msc.service.ServiceName SERVICE_NAME

    • Constructor Detail

      • TimerServiceImpl

        public TimerServiceImpl​(Map<Method,​List<AutoTimer>> autoTimers,
                        org.jboss.msc.service.ServiceName serviceName,
                        TimerServiceRegistry registry)
        Creates a TimerServiceImpl
        Parameters:
        autoTimers - The auto timers associated with this timer service
        serviceName - The service name of this timer service
        registry - The TimerServiceRegistry which has the knowledge of other timer services belonging to the EJB module to which this timer service belongs.

    • Method Detail

      • start

        public void start​(org.jboss.msc.service.StartContext context)
           throws org.jboss.msc.service.StartException
        Specified by:
        start in interface org.jboss.msc.Service
        Specified by:
        start in interface org.jboss.msc.service.Service<javax.ejb.TimerService>
        Throws:
        org.jboss.msc.service.StartException

      • stop

        public void stop​(org.jboss.msc.service.StopContext context)
        Specified by:
        stop in interface org.jboss.msc.Service
        Specified by:
        stop in interface org.jboss.msc.service.Service<javax.ejb.TimerService>

      • activate

        public void activate()

      • deactivate

        public void deactivate()

      • loadAutoTimer

        public TimerImpl loadAutoTimer​(javax.ejb.ScheduleExpression schedule,
                               javax.ejb.TimerConfig timerConfig,
                               Method timeoutMethod)

      • getPersistedTimerInfo

        public Serializable getPersistedTimerInfo​(TimerImpl timer)
        Retrieves the timer info from the timer database.
        Parameters:
        timer - the timer whose info to be retrieved
        Returns:
        the timer info from database; cached timer info if the timer persistence store is not database

      • getTimer

        public TimerImpl getTimer​(String timerId,
                          String timedObjectId)
        Returns the timer corresponding to the passed timer id and timed object id.
        Parameters:
        timerId - timer id
        timedObjectId - timed object id
        Returns:
        the TimerImpl corresponding to the passed timer id and timed object id

      • getTransaction

        protected javax.transaction.Transaction getTransaction()
        Returns:
        Returns the current transaction, if any. Else returns null.
        Throws:
        javax.ejb.EJBException - If there is any system level exception

      • persistTimer

        public void persistTimer​(TimerImpl timer,
                         boolean newTimer)
        Persists the passed timer.

        If the passed timer is null or is non-persistent (i.e. Timer.isPersistent() returns false), then this method acts as a no-op

        Parameters:
        timer -

      • expireTimer

        public void expireTimer​(TimerImpl timer)

      • suspendTimers

        public void suspendTimers()
        Suspends any currently scheduled tasks for Timers

        Note that, suspend does not cancel the Timer. Instead, it just cancels the next scheduled timeout. So once the Timer is restored (whenever that happens), the Timer will continue to timeout at appropriate times.

      • restoreTimers

        public void restoreTimers​(List<AutoTimer> newAutoTimers)
        Restores persisted timers, corresponding to this timerservice, which are eligible for any new timeouts.

        This includes timers whose TimerState is neither of the following:

        All such restored timers will be schedule for their next timeouts.

        Parameters:
        newAutoTimers -

      • startTimer

        protected void startTimer​(TimerImpl timer)
        Registers a timer with a transaction (if any in progress) and then moves the timer to an active state, so that it becomes eligible for timeouts

      • isLifecycleCallbackInvocation

        protected boolean isLifecycleCallbackInvocation()
        Returns true if the CurrentInvocationContext represents a lifecycle callback invocation. Else returns false.

        This method internally relies on CurrentInvocationContext.get() to obtain the current invocation context.

        • If the context is available then it looks for the method that was invoked. The absence of a method indicates a lifecycle callback.
        • If the context is not available, then this method returns false (i.e. it doesn't consider the current invocation as a lifecycle callback). This is for convenience, to allow the invocation of TimerService methods in the absence of CurrentInvocationContext

        Returns:

      • scheduleTimeout

        protected void scheduleTimeout​(TimerImpl timer,
                               boolean newTimer)
        Creates and schedules a TimerTask for the next timeout of the passed timer

      • cancelTimeout

        protected void cancelTimeout​(TimerImpl timer)
        Cancels any scheduled Future corresponding to the passed timer
        Parameters:
        timer - the timer to cancel

      • isScheduled

        public boolean isScheduled​(String tid)

      • getEjbComponentInjectedValue

        public org.jboss.msc.value.InjectedValue<EJBComponent> getEjbComponentInjectedValue()

      • getExecutorServiceInjectedValue

        public org.jboss.msc.value.InjectedValue<ExecutorService> getExecutorServiceInjectedValue()

      • getTimerInjectedValue

        public org.jboss.msc.value.InjectedValue<Timer> getTimerInjectedValue()

      • getTimerPersistence

        public org.jboss.msc.value.InjectedValue<TimerPersistence> getTimerPersistence()

      • getServiceName

        public org.jboss.msc.service.ServiceName getServiceName()

      • isStarted

        public boolean isStarted()

      • getTimedObjectInvoker

        public org.jboss.msc.value.InjectedValue<TimedObjectInvoker> getTimedObjectInvoker()

      • shouldRun

        public boolean shouldRun​(TimerImpl timer)
        Check if a persistent timer is already executed from a different instance or should be executed. For non-persistent timer it always return true.
        Parameters:
        timer - the timer which should be checked
        Returns:
        true if the timer is not persistent or the persistent timer should start

      • safeClose

        public static void safeClose​(AutoCloseable resource)
        Safely closes some resource without throwing an exception. Any exception will be logged at TRACE level.
        Parameters:
        resource - the resource to close