[jboss-cvs] JBossAS SVN: r105802 - projects/ejb3/trunk/timerservice-spi/src/main/java/org/jboss/ejb3/timerservice/spi.

[jboss-cvs-commits at lists.jboss.org]

Author: jaikiran
Date: 2010-06-08 09:24:20 -0400 (Tue, 08 Jun 2010)
New Revision: 105802

Added:
   projects/ejb3/trunk/timerservice-spi/src/main/java/org/jboss/ejb3/timerservice/spi/MultiTimeoutMethodTimedObjectInvoker.java
Log:
EJBTHREE-2108 Introduced MultiTimeoutMethodTimedObjectInvoker which can pass the timeout method name and params through the timeout callback method

Added: projects/ejb3/trunk/timerservice-spi/src/main/java/org/jboss/ejb3/timerservice/spi/MultiTimeoutMethodTimedObjectInvoker.java
===================================================================
--- projects/ejb3/trunk/timerservice-spi/src/main/java/org/jboss/ejb3/timerservice/spi/MultiTimeoutMethodTimedObjectInvoker.java	                        (rev 0)
+++ projects/ejb3/trunk/timerservice-spi/src/main/java/org/jboss/ejb3/timerservice/spi/MultiTimeoutMethodTimedObjectInvoker.java	2010-06-08 13:24:20 UTC (rev 105802)
@@ -0,0 +1,56 @@
+/*
+ * JBoss, Home of Professional Open Source.
+ * Copyright 2009, Red Hat Middleware LLC, 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.ejb3.timerservice.spi;
+
+import javax.ejb.Timer;
+
+/**
+ * A {@link MultiTimeoutMethodTimedObjectInvoker} can handle multiple timeout methods. 
+ * <p>
+ * This is unlike the {@link TimedObjectInvoker} which knows that there exists just one timeout method
+ * on the target timed object
+ * </p>
+ * <p>
+ * The timer service implementation is responsible for passing the correct method name and method parameters of the timeout method
+ * to the {@link #callTimeout(Timer, String, String[])}. The method name and method parameters of the timeout method
+ * depend on {@link Timer} for which the timeout occurred. 
+ * </p>
+ * @author Jaikiran Pai
+ * @version $Revision: $
+ */
+public interface MultiTimeoutMethodTimedObjectInvoker extends TimedObjectInvoker
+{
+
+   /**
+    * Responsible for invoking the timeout method represented by the passed <code>timeoutMethodName</code>
+    * and <code>timeoutMethodParams</code>, on the target object. 
+    * 
+    * <p>
+    *   The timerservice implementation invokes this method as a callback when a timeout occurs for the passed
+    *   <code>timer</code>. The timerservice implementation will be responsible for passing the correct 
+    *   timeout method name and method params corresponding to the <code>timer</code> on which the timeout has occurred.
+    * </p>
+    *
+    * @param timer the Timer that is passed to ejbTimeout
+    */
+   void callTimeout(Timer timer, String timeoutMethodName, String[] timeoutMethodParams) throws Exception;
+}