org.jboss.as.ejb3.timerservice.TimerServiceImpl Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.ejb3.timerservice;
import java.io.Closeable;
import java.io.Serializable;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.ListIterator;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import java.util.concurrent.ExecutorService;
import javax.ejb.EJBException;
import javax.ejb.ScheduleExpression;
import javax.ejb.Timer;
import javax.ejb.TimerConfig;
import javax.ejb.TimerHandle;
import javax.ejb.TimerService;
import javax.transaction.RollbackException;
import javax.transaction.Status;
import javax.transaction.Synchronization;
import javax.transaction.SystemException;
import javax.transaction.Transaction;
import org.jboss.as.ejb3.logging.EjbLogger;
import org.jboss.as.ejb3.component.EJBComponent;
import org.jboss.as.ejb3.component.TimerServiceRegistry;
import org.jboss.as.ejb3.component.allowedmethods.AllowedMethodsInformation;
import org.jboss.as.ejb3.component.allowedmethods.MethodType;
import org.jboss.as.ejb3.component.singleton.SingletonComponent;
import org.jboss.as.ejb3.component.stateful.CurrentSynchronizationCallback;
import org.jboss.as.ejb3.context.CurrentInvocationContext;
import org.jboss.as.ejb3.subsystem.deployment.TimerServiceResource;
import org.jboss.as.ejb3.timerservice.persistence.TimerPersistence;
import org.jboss.as.ejb3.timerservice.spi.ScheduleTimer;
import org.jboss.as.ejb3.timerservice.spi.TimedObjectInvoker;
import org.jboss.invocation.InterceptorContext;
import org.jboss.msc.service.Service;
import org.jboss.msc.service.ServiceName;
import org.jboss.msc.service.StartContext;
import org.jboss.msc.service.StartException;
import org.jboss.msc.service.StopContext;
import org.jboss.msc.value.InjectedValue;
import org.wildfly.extension.requestcontroller.ControlPoint;
import org.wildfly.transaction.client.ContextTransactionManager;
import org.wildfly.transaction.client.ContextTransactionSynchronizationRegistry;
import org.xnio.IoUtils;
import static org.jboss.as.ejb3.logging.EjbLogger.EJB3_TIMER_LOGGER;
/**
* MK2 implementation of EJB3.1 {@link TimerService}
*
* @author Carlo de Wolf
* @version $Revision: $
*/
public class TimerServiceImpl implements TimerService, Service {
/**
* inactive timer states
*/
private static final Set ineligibleTimerStates;
public static final ServiceName SERVICE_NAME = ServiceName.of("ejb3", "timerService");
/**
* The service name this timer service is registered under
*/
private final ServiceName serviceName;
private final InjectedValue ejbComponentInjectedValue = new InjectedValue();
private final InjectedValue executorServiceInjectedValue = new InjectedValue();
private final InjectedValue timerInjectedValue = new InjectedValue();
private final InjectedValue timedObjectInvoker = new InjectedValue();
/**
* Auto timers that should be added on startup
*/
private final Map> autoTimers;
/**
* Used for persistent timers
*/
private final InjectedValue timerPersistence = new InjectedValue();
/**
* All timers which were created by this {@link TimerService}
*/
private final Map timers = Collections.synchronizedMap(new HashMap());
/**
* Holds the {@link java.util.concurrent.Future} of each of the timer tasks that have been scheduled
*/
private final Map scheduledTimerFutures = new HashMap();
/**
* Key that is used to store timers that are waiting on transaction completion in the transaction local
*/
private final Object waitingOnTxCompletionKey = new Object();
private final TimerServiceRegistry timerServiceRegistry;
/**
* Dynamic resource. Exposed under service=timer-service.
*/
private TimerServiceResource resource = new TimerServiceResource();
private Closeable listenerHandle;
private volatile boolean started = false;
static {
final Set states = new HashSet();
states.add(TimerState.CANCELED);
states.add(TimerState.EXPIRED);
ineligibleTimerStates = Collections.unmodifiableSet(states);
}
/**
* Creates a {@link TimerServiceImpl}
*
* @param autoTimers
* @param serviceName
* @throws IllegalArgumentException If either of the passed param is null
* @deprecated Use {@link #TimerServiceImpl(java.util.Map, org.jboss.msc.service.ServiceName, org.jboss.as.ejb3.component.TimerServiceRegistry)} instead
*/
@Deprecated
public TimerServiceImpl(final Map> autoTimers, final ServiceName serviceName) {
this(autoTimers, serviceName, null);
}
/**
* Creates a {@link TimerServiceImpl}
*
* @param autoTimers The auto timers associated with this timer service
* @param serviceName The service name of this timer service
* @param registry The {@link TimerServiceRegistry} which has the knowledge of other timer services belonging to the EJB module to which this
* timer service belongs.
*/
public TimerServiceImpl(final Map> autoTimers, final ServiceName serviceName, final TimerServiceRegistry registry) {
this.autoTimers = autoTimers;
this.serviceName = serviceName;
this.timerServiceRegistry = registry;
}
@Override
public synchronized void start(final StartContext context) throws StartException {
if (EJB3_TIMER_LOGGER.isDebugEnabled()) {
EJB3_TIMER_LOGGER.debug("Starting timerservice for timedObjectId: " + getInvoker().getTimedObjectId());
}
final TimedObjectInvoker invoker = timedObjectInvoker.getValue();
if (invoker == null) {
throw EJB3_TIMER_LOGGER.invokerIsNull();
}
started = true;
// register ourselves to the TimerServiceRegistry (if any)
if (timerServiceRegistry != null) {
timerServiceRegistry.registerTimerService(this);
}
listenerHandle = timerPersistence.getValue().registerChangeListener(getInvoker().getTimedObjectId(), new TimerRefreshListener());
}
@Override
public synchronized void stop(final StopContext context) {
// un-register ourselves to the TimerServiceRegistry (if any)
if (timerServiceRegistry != null) {
timerServiceRegistry.unRegisterTimerService(this);
}
timerPersistence.getValue().timerUndeployed(timedObjectInvoker.getValue().getTimedObjectId());
started = false;
IoUtils.safeClose(listenerHandle);
listenerHandle = null;
timerInjectedValue.getValue().purge(); //WFLY-3823
}
public synchronized void activate() {
final List timers = new ArrayList();
for (Map.Entry> entry : autoTimers.entrySet()) {
for (AutoTimer timer : entry.getValue()) {
timers.add(new ScheduleTimer(entry.getKey(), timer.getScheduleExpression(), timer.getTimerConfig()));
}
}
// restore the timers
restoreTimers(timers);
}
public synchronized void deactivate() {
suspendTimers();
}
@Override
public synchronized TimerService getValue() throws IllegalStateException, IllegalArgumentException {
return this;
}
/**
* {@inheritDoc}
*/
@Override
public Timer createCalendarTimer(ScheduleExpression schedule) throws IllegalArgumentException,
IllegalStateException, EJBException {
return this.createCalendarTimer(schedule, null);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createCalendarTimer(ScheduleExpression schedule, TimerConfig timerConfig)
throws IllegalArgumentException, IllegalStateException, EJBException {
assertTimerServiceState();
Serializable info = timerConfig == null ? null : timerConfig.getInfo();
boolean persistent = timerConfig == null || timerConfig.isPersistent();
return this.createCalendarTimer(schedule, info, persistent, null);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createIntervalTimer(Date initialExpiration, long intervalDuration, TimerConfig timerConfig)
throws IllegalArgumentException, IllegalStateException, EJBException {
assertTimerServiceState();
if (initialExpiration == null) {
throw EJB3_TIMER_LOGGER.initialExpirationIsNullCreatingTimer();
}
if (initialExpiration.getTime() < 0) {
throw EJB3_TIMER_LOGGER.invalidInitialExpiration("initialExpiration.getTime()");
}
if (intervalDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidInitialExpiration("intervalDuration");
}
return this.createTimer(initialExpiration, intervalDuration, timerConfig.getInfo(), timerConfig.isPersistent());
}
/**
* {@inheritDoc}
*/
@Override
public Timer createIntervalTimer(long initialDuration, long intervalDuration, TimerConfig timerConfig)
throws IllegalArgumentException, IllegalStateException, EJBException {
assertTimerServiceState();
if (initialDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidInitialExpiration("intervalDuration");
}
if (intervalDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidInitialExpiration("intervalDuration");
}
return this.createIntervalTimer(new Date(System.currentTimeMillis() + initialDuration), intervalDuration, timerConfig);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createSingleActionTimer(Date expiration, TimerConfig timerConfig) throws IllegalArgumentException,
IllegalStateException, EJBException {
assertTimerServiceState();
if (expiration == null) {
throw EJB3_TIMER_LOGGER.expirationIsNull();
}
if (expiration.getTime() < 0) {
throw EJB3_TIMER_LOGGER.invalidExpirationActionTimer();
}
return this.createTimer(expiration, 0, timerConfig.getInfo(), timerConfig.isPersistent());
}
/**
* {@inheritDoc}
*/
@Override
public Timer createSingleActionTimer(long duration, TimerConfig timerConfig) throws IllegalArgumentException,
IllegalStateException, EJBException {
assertTimerServiceState();
if (duration < 0)
throw EJB3_TIMER_LOGGER.invalidDurationActionTimer();
return createTimer(new Date(System.currentTimeMillis() + duration), 0, timerConfig.getInfo(), timerConfig
.isPersistent());
}
/**
* {@inheritDoc}
*/
@Override
public Timer createTimer(long duration, Serializable info) throws IllegalArgumentException, IllegalStateException,
EJBException {
assertTimerServiceState();
if (duration < 0)
throw EJB3_TIMER_LOGGER.invalidDurationTimer();
return createTimer(new Date(System.currentTimeMillis() + duration), 0, info, true);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createTimer(Date expiration, Serializable info) throws IllegalArgumentException, IllegalStateException,
EJBException {
assertTimerServiceState();
if (expiration == null) {
throw EJB3_TIMER_LOGGER.expirationDateIsNull();
}
if (expiration.getTime() < 0) {
throw EJB3_TIMER_LOGGER.invalidExpirationTimer();
}
return this.createTimer(expiration, 0, info, true);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createTimer(long initialDuration, long intervalDuration, Serializable info)
throws IllegalArgumentException, IllegalStateException, EJBException {
assertTimerServiceState();
if (initialDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidInitialDurationTimer();
}
if (intervalDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidIntervalTimer();
}
return this.createTimer(new Date(System.currentTimeMillis() + initialDuration), intervalDuration, info, true);
}
/**
* {@inheritDoc}
*/
@Override
public Timer createTimer(Date initialExpiration, long intervalDuration, Serializable info)
throws IllegalArgumentException, IllegalStateException, EJBException {
assertTimerServiceState();
if (initialExpiration == null) {
throw EJB3_TIMER_LOGGER.initialExpirationDateIsNull();
}
if (initialExpiration.getTime() < 0) {
throw EJB3_TIMER_LOGGER.invalidExpirationTimer();
}
if (intervalDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidIntervalDurationTimer();
}
return this.createTimer(initialExpiration, intervalDuration, info, true);
}
public TimerImpl loadAutoTimer(ScheduleExpression schedule,
TimerConfig timerConfig, Method timeoutMethod) {
return this.createCalendarTimer(schedule, timerConfig.getInfo(), timerConfig.isPersistent(), timeoutMethod);
}
/**
* {@inheritDoc}
*/
@Override
public Collection getTimers() throws IllegalStateException, EJBException {
assertTimerServiceState();
Object pk = currentPrimaryKey();
final Set activeTimers = new HashSet();
// get all active timers for this timerservice
synchronized (this.timers) {
for (final TimerImpl timer : this.timers.values()) {
// Less disruptive way to get WFLY-8457 fixed.
if (timer.isActive() || (!timer.isActive() && timer.getState() == TimerState.ACTIVE)) {
if (timer.getPrimaryKey() == null || timer.getPrimaryKey().equals(pk)) {
activeTimers.add(timer);
}
}
}
}
// get all active timers which are persistent, but haven't yet been
// persisted (waiting for tx to complete) that are in the current transaction
for (final TimerImpl timer : getWaitingOnTxCompletionTimers().values()) {
if (timer.isActive()) {
if (timer.getPrimaryKey() == null || timer.getPrimaryKey().equals(pk)) {
activeTimers.add(timer);
}
}
}
return activeTimers;
}
/**
* {@inheritDoc}
*/
@Override
public Collection getAllTimers() throws IllegalStateException, EJBException {
// query the registry
if (this.timerServiceRegistry != null) {
return this.timerServiceRegistry.getAllActiveTimers();
}
// if we don't have the registry (shouldn't really happen) which stores the timer services applicable for the EJB module to which
// this timer service belongs, then let's at least return the active timers that are applicable only for this timer service
return this.getTimers();
}
/**
* Create a {@link javax.ejb.Timer}
*
* @param initialExpiration The {@link java.util.Date} at which the first timeout should occur.
* If the date is in the past, then the timeout is triggered immediately
* when the timer moves to {@link TimerState#ACTIVE}
* @param intervalDuration The interval (in milliseconds) between consecutive timeouts for the newly created timer.
* Cannot be a negative value. A value of 0 indicates a single timeout action
* @param info {@link java.io.Serializable} info that will be made available through the newly created timer's {@link javax.ejb.Timer#getInfo()} method
* @param persistent True if the newly created timer has to be persistent
* @return Returns the newly created timer
* @throws IllegalArgumentException If initialExpiration is null or intervalDuration is negative
* @throws IllegalStateException If this method was invoked during a lifecycle callback on the EJB
*/
private Timer createTimer(Date initialExpiration, long intervalDuration, Serializable info, boolean persistent) {
if (this.isLifecycleCallbackInvocation() && !this.isSingletonBeanInvocation()) {
throw EJB3_TIMER_LOGGER.failToCreateTimerDoLifecycle();
}
if (initialExpiration == null) {
throw EJB3_TIMER_LOGGER.initialExpirationIsNull();
}
if (intervalDuration < 0) {
throw EJB3_TIMER_LOGGER.invalidIntervalDuration();
}
// create an id for the new timer instance
UUID uuid = UUID.randomUUID();
// create the timer
TimerImpl timer = TimerImpl.builder()
.setNewTimer(true)
.setId(uuid.toString())
.setInitialDate(initialExpiration)
.setRepeatInterval(intervalDuration)
.setInfo(info)
.setPersistent(persistent)
.setPrimaryKey(currentPrimaryKey())
.setTimerState(TimerState.CREATED)
.setTimedObjectId(getInvoker().getTimedObjectId())
.build(this);
// now "start" the timer. This involves, moving the timer to an ACTIVE state
// and scheduling the timer task
this.persistTimer(timer, true);
this.startTimer(timer);
// return the newly created timer
return timer;
}
/**
* @return The primary key of the current EJB, or null if not applicable
*/
private Object currentPrimaryKey() {
return null;
}
/**
* Creates a calendar based {@link javax.ejb.Timer}
*
* @param schedule The {@link javax.ejb.ScheduleExpression} which will be used for creating scheduled timer tasks
* for a calendar based timer
* @param info {@link java.io.Serializable} info that will be made available through the newly created timer's {@link javax.ejb.Timer#getInfo()} method
* @param persistent True if the newly created timer has to be persistent
* @return Returns the newly created timer
* @throws IllegalArgumentException If the passed schedule is null
* @throws IllegalStateException If this method was invoked during a lifecycle callback on the EJB
*/
private TimerImpl createCalendarTimer(ScheduleExpression schedule,
Serializable info, boolean persistent, Method timeoutMethod) {
if (this.isLifecycleCallbackInvocation() && !this.isSingletonBeanInvocation()) {
throw EJB3_TIMER_LOGGER.failToCreateTimerDoLifecycle();
}
if (schedule == null) {
throw EJB3_TIMER_LOGGER.scheduleIsNull();
}
// generate an id for the timer
UUID uuid = UUID.randomUUID();
// create the timer
TimerImpl timer = CalendarTimer.builder()
.setAutoTimer(timeoutMethod != null)
.setScheduleExprSecond(schedule.getSecond())
.setScheduleExprMinute(schedule.getMinute())
.setScheduleExprHour(schedule.getHour())
.setScheduleExprDayOfWeek(schedule.getDayOfWeek())
.setScheduleExprDayOfMonth(schedule.getDayOfMonth())
.setScheduleExprMonth(schedule.getMonth())
.setScheduleExprYear(schedule.getYear())
.setScheduleExprStartDate(schedule.getStart())
.setScheduleExprEndDate(schedule.getEnd())
.setScheduleExprTimezone(schedule.getTimezone())
.setTimeoutMethod(timeoutMethod)
.setTimerState(TimerState.CREATED)
.setId(uuid.toString())
.setPersistent(persistent)
.setPrimaryKey(currentPrimaryKey())
.setTimedObjectId(getInvoker().getTimedObjectId())
.setInfo(info)
.setNewTimer(true)
.build(this);
this.persistTimer(timer, true);
// now "start" the timer. This involves, moving the timer to an ACTIVE state
// and scheduling the timer task
this.startTimer(timer);
// return the timer
return timer;
}
public TimerImpl getTimer(final String timerId) {
return timers.get(timerId);
}
/**
* Returns the {@link TimedObjectInvoker} to which this timer service belongs
*
* @return
*/
public TimedObjectInvoker getInvoker() {
return timedObjectInvoker.getValue();
}
/**
* Returns the {@link javax.ejb.Timer} corresponding to the passed {@link javax.ejb.TimerHandle}
*
* @param handle The {@link javax.ejb.TimerHandle} for which the {@link javax.ejb.Timer} is being looked for
*/
public TimerImpl getTimer(TimerHandle handle) {
TimerHandleImpl timerHandle = (TimerHandleImpl) handle;
TimerImpl timer = timers.get(timerHandle.getId());
if (timer != null) {
return timer;
}
return getWaitingOnTxCompletionTimers().get(timerHandle.getId());
}
/**
* @return Returns the current transaction, if any. Else returns null.
* @throws javax.ejb.EJBException If there is any system level exception
*/
protected Transaction getTransaction() {
return ContextTransactionManager.getInstance().getTransaction();
}
/**
* Persists the passed timer.
*
*
* If the passed timer is null or is non-persistent (i.e. {@link javax.ejb.Timer#isPersistent()} returns false),
* then this method acts as a no-op
*
*
* @param timer
*/
public void persistTimer(final TimerImpl timer, boolean newTimer) {
if (timer == null) {
return;
}
if (timer.isTimerPersistent()) {
try {
if (timerPersistence.getOptionalValue() == null) {
EJB3_TIMER_LOGGER.timerPersistenceNotEnable();
return;
}
if (newTimer) {
timerPersistence.getValue().addTimer(timer);
} else {
timerPersistence.getValue().persistTimer(timer);
}
} catch (Throwable t) {
this.setRollbackOnly();
throw new RuntimeException(t);
}
}
}
public void cancelTimer(final TimerImpl timer) {
timer.lock();
boolean release = true;
try {
// first check whether the timer has expired or has been cancelled
timer.assertTimerState();
boolean startedInTx = getWaitingOnTxCompletionTimers().containsKey(timer.getId());
if (timer.getState() != TimerState.EXPIRED) {
timer.setTimerState(TimerState.CANCELED);
}
if (transactionActive() && !startedInTx) {
registerSynchronization(new TimerRemoveSynchronization(timer));
release = false;
} else {
// cancel any scheduled Future for this timer
this.cancelTimeout(timer);
this.unregisterTimerResource(timer.getId());
this.timers.remove(timer.getId());
}
// persist changes
persistTimer(timer, false);
} finally {
if (release) {
timer.unlock();
}
}
}
public void expireTimer(final TimerImpl timer) {
this.cancelTimeout(timer);
timer.setTimerState(TimerState.EXPIRED);
this.unregisterTimerResource(timer.getId());
this.timers.remove(timer.getId());
}
/**
* Suspends any currently scheduled tasks for {@link javax.ejb.Timer}s
*
* Note that, suspend does not cancel the {@link javax.ejb.Timer}. Instead,
* it just cancels the next scheduled timeout. So once the {@link javax.ejb.Timer}
* is restored (whenever that happens), the {@link javax.ejb.Timer} will continue to
* timeout at appropriate times.
*
*/
public void suspendTimers() {
// get all active timers (persistent/non-persistent inclusive)
Collection timers = this.getTimers();
for (Timer timer : timers) {
if (!(timer instanceof TimerImpl)) {
continue;
}
// suspend the timer
((TimerImpl) timer).suspend();
}
}
/**
* Restores persisted timers, corresponding to this timerservice, which are eligible for any new timeouts.
*
* This includes timers whose {@link TimerState} is neither of the following:
*
* - {@link TimerState#CANCELED}
* - {@link TimerState#EXPIRED}
*
*
*
* All such restored timers will be schedule for their next timeouts.
*
*
* @param autoTimers
*/
public void restoreTimers(final List autoTimers) {
// get the persisted timers which are considered active
List restorableTimers = this.getActivePersistentTimers();
//timers are removed from the list as they are loaded
final List newAutoTimers = new LinkedList(autoTimers);
if (EJB3_TIMER_LOGGER.isDebugEnabled()) {
EJB3_TIMER_LOGGER.debug("Found " + restorableTimers.size() + " active persistentTimers for timedObjectId: "
+ getInvoker().getTimedObjectId());
}
// now "start" each of the restorable timer. This involves, moving the timer to an ACTIVE state
// and scheduling the timer task
for (final TimerImpl activeTimer : restorableTimers) {
if (activeTimer.isAutoTimer()) {
CalendarTimer calendarTimer = (CalendarTimer) activeTimer;
boolean found = false;
//so we know we have an auto timer. We need to try and match it up with the auto timers.
ListIterator it = newAutoTimers.listIterator();
while (it.hasNext()) {
ScheduleTimer timer = it.next();
final String methodName = timer.getMethod().getName();
final String[] params = new String[timer.getMethod().getParameterTypes().length];
for (int i = 0; i < timer.getMethod().getParameterTypes().length; ++i) {
params[i] = timer.getMethod().getParameterTypes()[i].getName();
}
if (doesTimeoutMethodMatch(calendarTimer.getTimeoutMethod(), methodName, params)) {
//the timers have the same method.
//now lets make sure the schedule is the same
// and the timer does not change the persistence
if (this.doesScheduleMatch(calendarTimer.getScheduleExpression(), timer.getScheduleExpression()) && timer.getTimerConfig().isPersistent()) {
it.remove();
found = true;
break;
}
}
}
if (!found) {
activeTimer.setTimerState(TimerState.CANCELED);
} else {
// ensure state switch to active if was TIMEOUT in the DB
// if the persistence is shared it must be ensured to not update
// timers of other nodes in the cluster
activeTimer.setTimerState(TimerState.ACTIVE);
calendarTimer.handleRestorationCalculation();
}
try {
this.persistTimer(activeTimer, false);
} catch (Exception e) {
EJB3_TIMER_LOGGER.failedToPersistTimerOnStartup(activeTimer, e);
}
if (found) {
startTimer(activeTimer);
EJB3_TIMER_LOGGER.debugv("Started existing auto timer: {0}", activeTimer);
}
} else if (!ineligibleTimerStates.contains(activeTimer.getState())) {
startTimer(activeTimer);
}
EJB3_TIMER_LOGGER.debugv("Started timer: {0}", activeTimer);
}
for (ScheduleTimer timer : newAutoTimers) {
this.loadAutoTimer(timer.getScheduleExpression(), timer.getTimerConfig(), timer.getMethod());
}
}
/**
* 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
*/
protected void startTimer(TimerImpl timer) {
// if there's no transaction, then trigger a schedule immediately.
// Else, the timer will be scheduled on tx synchronization callback
if (!transactionActive()) {
this.timers.put(timer.getId(), timer);
// set active if the timer is started if it was read
// from persistence as current running to ensure correct schedule here
timer.setTimerState(TimerState.ACTIVE);
// create and schedule a timer task
this.registerTimerResource(timer.getId());
timer.scheduleTimeout(true);
} else {
addWaitingOnTxCompletionTimer(timer);
registerSynchronization(new TimerCreationTransactionSynchronization(timer));
}
}
private void registerSynchronization(Synchronization synchronization) {
try {
final Transaction tx = this.getTransaction();
// register for lifecycle events of transaction
tx.registerSynchronization(synchronization);
} catch (RollbackException e) {
throw new EJBException(e);
} catch (SystemException e) {
throw new EJBException(e);
}
}
/**
* @return true if the transaction is in a state where synchronizations can be registered
*/
boolean transactionActive() {
final Transaction currentTx = getTransaction();
if (currentTx != null) {
try {
int status = currentTx.getStatus();
if (status == Status.STATUS_MARKED_ROLLBACK || status == Status.STATUS_ROLLEDBACK ||
status == Status.STATUS_ROLLING_BACK || status == Status.STATUS_NO_TRANSACTION ||
status == Status.STATUS_UNKNOWN || status == Status.STATUS_COMMITTED
|| isBeforeCompletion()) {
return false;
} else {
return true;
}
} catch (SystemException e) {
throw new RuntimeException(e);
}
} else {
return false;
}
}
private boolean isBeforeCompletion() {
final CurrentSynchronizationCallback.CallbackType type = CurrentSynchronizationCallback.get();
if (type != null) {
return type == CurrentSynchronizationCallback.CallbackType.BEFORE_COMPLETION;
}
return false;
}
/**
* Returns true if the {@link CurrentInvocationContext} represents a lifecycle
* callback invocation. Else returns false.
*
* This method internally relies on {@link 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 {@link javax.ejb.TimerService} methods
* in the absence of {@link CurrentInvocationContext}
*
*
*
*
* @return
*/
protected boolean isLifecycleCallbackInvocation() {
final InterceptorContext currentInvocationContext = CurrentInvocationContext.get();
if (currentInvocationContext == null) {
return false;
}
// If the method in current invocation context is null,
// then it represents a lifecycle callback invocation
Method invokedMethod = currentInvocationContext.getMethod();
if (invokedMethod == null) {
// it's a lifecycle callback
return true;
}
// not a lifecycle callback
return false;
}
/**
* Creates and schedules a {@link TimerTask} for the next timeout of the passed timer
*/
protected void scheduleTimeout(TimerImpl timer, boolean newTimer) {
synchronized (scheduledTimerFutures) {
if (!newTimer && !scheduledTimerFutures.containsKey(timer.getId())) {
//this timer has been cancelled by another thread. We just return
return;
}
Date nextExpiration = timer.getNextExpiration();
if (nextExpiration == null) {
EJB3_TIMER_LOGGER.nextExpirationIsNull(timer);
return;
}
// create the timer task
final TimerTask timerTask = timer.getTimerTask();
// find out how long is it away from now
long delay = nextExpiration.getTime() - System.currentTimeMillis();
// if in past, then trigger immediately
if (delay < 0) {
delay = 0;
}
long intervalDuration = timer.getInterval();
final Task task = new Task(timerTask, ejbComponentInjectedValue.getValue().getControlPoint());
if (intervalDuration > 0) {
EJB3_TIMER_LOGGER.debugv("Scheduling timer {0} at fixed rate, starting at {1} milliseconds from now with repeated interval={2}",
timer, delay, intervalDuration);
// schedule the task
this.timerInjectedValue.getValue().scheduleAtFixedRate(task, delay, intervalDuration);
// maintain it in timerservice for future use (like cancellation)
this.scheduledTimerFutures.put(timer.getId(), task);
} else {
EJB3_TIMER_LOGGER.debugv("Scheduling a single action timer {0} starting at {1} milliseconds from now", timer, delay);
// schedule the task
this.timerInjectedValue.getValue().schedule(task, delay);
// maintain it in timerservice for future use (like cancellation)
this.scheduledTimerFutures.put(timer.getId(), task);
}
}
}
/**
* Cancels any scheduled {@link java.util.concurrent.Future} corresponding to the passed timer
*
* @param timer
*/
protected void cancelTimeout(final TimerImpl timer) {
synchronized (this.scheduledTimerFutures) {
java.util.TimerTask timerTask = this.scheduledTimerFutures.remove(timer.getId());
if (timerTask != null) {
timerTask.cancel();
}
}
}
public boolean isScheduled(final String tid){
synchronized (this.scheduledTimerFutures) {
return this.scheduledTimerFutures.containsKey(tid);
}
}
/**
* Returns an unmodifiable view of timers in the current transaction that are waiting for the transaction
* to finish
*/
private Map getWaitingOnTxCompletionTimers() {
Map timers = null;
if (getTransaction() != null) {
timers = (Map) ContextTransactionSynchronizationRegistry.getInstance().getResource(waitingOnTxCompletionKey);
}
return timers == null ? Collections.emptyMap() : timers;
}
private void addWaitingOnTxCompletionTimer(final TimerImpl timer) {
Map timers = (Map) ContextTransactionSynchronizationRegistry.getInstance().getResource(waitingOnTxCompletionKey);
if (timers == null) {
ContextTransactionSynchronizationRegistry.getInstance().putResource(waitingOnTxCompletionKey, timers = new HashMap());
}
timers.put(timer.getId(), timer);
}
private boolean isSingletonBeanInvocation() {
return ejbComponentInjectedValue.getValue() instanceof SingletonComponent;
}
private List getActivePersistentTimers() {
// we need only those timers which correspond to the
// timed object invoker to which this timer service belongs. So
// first get hold of the timed object id
final String timedObjectId = this.getInvoker().getTimedObjectId();
// timer states which do *not* represent an active timer
if (timerPersistence.getOptionalValue() == null) {
//if the persistence setting is null then there are no persistent timers
return Collections.emptyList();
}
final List persistedTimers = timerPersistence.getValue().loadActiveTimers(timedObjectId, this);
final List activeTimers = new ArrayList();
for (final TimerImpl persistedTimer : persistedTimers) {
if (ineligibleTimerStates.contains(persistedTimer.getState())) {
continue;
}
// add it to the list of timers which will be restored
activeTimers.add(persistedTimer);
}
return activeTimers;
}
private boolean doesTimeoutMethodMatch(final Method timeoutMethod, final String timeoutMethodName, final String[] methodParams) {
if (timeoutMethod.getName().equals(timeoutMethodName) == false) {
return false;
}
final Class[] timeoutMethodParams = timeoutMethod.getParameterTypes();
return this.methodParamsMatch(timeoutMethodParams, methodParams);
}
private boolean doesScheduleMatch(final ScheduleExpression expression1, final ScheduleExpression expression2) {
if (!same(expression1.getDayOfMonth(), expression2.getDayOfMonth())) {
return false;
}
if (!same(expression1.getDayOfWeek(), expression2.getDayOfWeek())) {
return false;
}
if (!same(expression1.getEnd(), expression2.getEnd())) {
return false;
}
if (!same(expression1.getHour(), expression2.getHour())) {
return false;
}
if (!same(expression1.getMinute(), expression2.getMinute())) {
return false;
}
if (!same(expression1.getMonth(), expression2.getMonth())) {
return false;
}
if (!same(expression1.getSecond(), expression2.getSecond())) {
return false;
}
if (!same(expression1.getStart(), expression2.getStart())) {
return false;
}
if (!same(expression1.getTimezone(), expression2.getTimezone())) {
return false;
}
if (!same(expression1.getYear(), expression2.getYear())) {
return false;
}
return true;
}
private boolean same(Object i1, Object i2) {
if (i1 == null && i2 != null) {
return false;
}
if (i2 == null && i1 != null) {
return false;
}
if (i1 == null && i2 == null) {
return true;
}
return i1.equals(i2);
}
private boolean methodParamsMatch(Class[] methodParams, String[] otherMethodParams) {
if (otherMethodParams == null) {
otherMethodParams = new String[0];
}
if (methodParams.length != otherMethodParams.length) {
return false;
}
for (int i = 0; i < methodParams.length; i++) {
if (!methodParams[i].getName().equals(otherMethodParams[i])) {
return false;
}
}
return true;
}
/**
* Marks the transaction for rollback
* NOTE: This method will soon be removed, once this timer service
* implementation becomes "managed"
*/
private void setRollbackOnly() {
try {
Transaction tx = ContextTransactionManager.getInstance().getTransaction();
if (tx != null) {
tx.setRollbackOnly();
}
} catch (IllegalStateException ise) {
EJB3_TIMER_LOGGER.ignoringException(ise);
} catch (SystemException se) {
EJB3_TIMER_LOGGER.ignoringException(se);
}
}
private void assertTimerServiceState() {
AllowedMethodsInformation.checkAllowed(MethodType.TIMER_SERVICE_METHOD);
if (isLifecycleCallbackInvocation() && !this.isSingletonBeanInvocation()) {
throw EJB3_TIMER_LOGGER.failToInvokeTimerServiceDoLifecycle();
}
}
public InjectedValue getEjbComponentInjectedValue() {
return ejbComponentInjectedValue;
}
public InjectedValue getExecutorServiceInjectedValue() {
return executorServiceInjectedValue;
}
public InjectedValue getTimerInjectedValue() {
return timerInjectedValue;
}
public InjectedValue getTimerPersistence() {
return timerPersistence;
}
public ServiceName getServiceName() {
return serviceName;
}
public boolean isStarted() {
return started;
}
public InjectedValue getTimedObjectInvoker() {
return timedObjectInvoker;
}
public TimerServiceResource getResource() {
return resource;
}
private void registerTimerResource(final String timerId) {
this.resource.timerCreated(timerId);
}
private void unregisterTimerResource(final String timerId) {
this.resource.timerRemoved(timerId);
}
/**
* Check if a persistent timer is already executed from a different instance
* or should be executed.
* For non-persistent timer it always return true.
*
* @param timer the timer which should be checked
* @return true if the timer is not persistent or the persistent timer should start
*/
public boolean shouldRun(TimerImpl timer) {
// check peristent without further check to prevent from Exception (WFLY-6152)
return !timer.isTimerPersistent() || timerPersistence.getValue().shouldRun(timer, ContextTransactionManager.getInstance());
}
private class TimerCreationTransactionSynchronization implements Synchronization {
/**
* The timer being managed in the transaction
*/
private final TimerImpl timer;
public TimerCreationTransactionSynchronization(TimerImpl timer) {
if (timer == null) {
throw EJB3_TIMER_LOGGER.timerIsNull();
}
this.timer = timer;
}
@Override
public void beforeCompletion() {
}
/**
* {@inheritDoc}
*/
@Override
public void afterCompletion(int status) {
if (status == Status.STATUS_COMMITTED) {
EJB3_TIMER_LOGGER.debugv("commit timer creation: {0}", this.timer);
timers.put(timer.getId(), timer);
registerTimerResource(timer.getId());
TimerState timerState = this.timer.getState();
switch (timerState) {
case CREATED:
this.timer.setTimerState(TimerState.ACTIVE);
this.timer.scheduleTimeout(true);
break;
case ACTIVE:
this.timer.scheduleTimeout(true);
break;
}
} else if (status == Status.STATUS_ROLLEDBACK) {
EJB3_TIMER_LOGGER.debugv("Rolling back timer creation: {0}", this.timer);
this.timer.setTimerState(TimerState.CANCELED);
}
}
}
private class TimerRemoveSynchronization implements Synchronization {
private final TimerImpl timer;
private TimerRemoveSynchronization(final TimerImpl timer) {
this.timer = timer;
}
@Override
public void beforeCompletion() {
}
@Override
public void afterCompletion(final int status) {
try {
if (status == Status.STATUS_COMMITTED) {
cancelTimeout(timer);
unregisterTimerResource(timer.getId());
timers.remove(timer.getId());
} else {
timer.setTimerState(TimerState.ACTIVE);
}
} finally {
timer.unlock();
}
}
}
private class Task extends java.util.TimerTask {
private final TimerTask delegate;
private final ControlPoint controlPoint;
/**
* This is true if a task is queued up to be run by the request controller,
* used to stop timer tasks banking up when the container is suspended.
*/
private volatile boolean queued = false;
public Task(final TimerTask delegate, ControlPoint controlPoint) {
this.delegate = delegate;
this.controlPoint = controlPoint;
}
@Override
public void run() {
final ExecutorService executor = executorServiceInjectedValue.getOptionalValue();
if (executor != null) {
if(controlPoint == null) {
executor.submit(delegate);
} else if(!queued) {
queued = true;
controlPoint.queueTask(new Runnable() {
@Override
public void run() {
queued = false;
delegate.run();
}
}, executor, -1, null, false);
} else {
EjbLogger.EJB3_INVOCATION_LOGGER.debug("Skipping timer invocation as existing request is already queued.");
}
}
}
@Override
public boolean cancel() {
delegate.cancel();
return super.cancel();
}
}
private final class TimerRefreshListener implements TimerPersistence.TimerChangeListener {
@Override
public void timerAdded(TimerImpl timer) {
TimerServiceImpl.this.startTimer(timer);
}
@Override
public void timerRemoved(String timerId) {
TimerImpl timer = TimerServiceImpl.this.getTimer(timerId);
if(timer != null) {
TimerServiceImpl.this.cancelTimeout(timer);
}
}
@Override
public TimerServiceImpl getTimerService() {
return TimerServiceImpl.this;
}
}
}