001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.test.timer.interfaces;
023:
024: import java.io.Serializable;
025:
026: /**
027: * Remote interface for test/timer/TimerSLSB.
028: * @author Thomas Diesler
029: * @author Scott.Stark@jboss.org
030: * @version $Revision: 57211 $
031: */
032: public interface TimerSLSB extends javax.ejb.EJBObject {
033:
034: /**
035: * Used in the unit tests. This is a key in a Map that can be used as the timer's
036: * info (timer.getInfo()). If this key maps to an Integer value in the Map,it will cause the
037: * ejbTimeout method to rollback the transaction that many times.
038: */
039: String INFO_EXEC_FAIL_COUNT = "ExecFailCount";
040:
041: /**
042: * Used in the unit tests. This is a key in a Map that can be used as the timer's
043: * info (timer.getInfo()). If this key maps to an Integer value in the Map,it will cause the
044: * ejbTimeout method to sleep for number of milliseconds specified in the Integer.
045: * This is used to simulate a long running task, and helps to test JBAS-1926.
046: */
047: String INFO_TASK_RUNTIME = "TaskRuntime";
048:
049: /**
050: * Start a single timer (if not already set) with the start date plus the period
051: * This method uses an implementation defined default value for the timer info.
052: * @param pPeriod Time that will elapse between now and the timed event in milliseconds
053: */
054: public byte[] startSingleTimer(long pPeriod)
055: throws java.rmi.RemoteException;
056:
057: /**
058: * Start a single timer (if not already set) with the start date plus the period and specified info.
059: *
060: * @param pPeriod Time that will elapse between now and the timed event in milliseconds
061: * @param info an object to be used as the info for the timer.
062: **/
063: public byte[] startSingleTimer(long pPeriod, Serializable info)
064: throws java.rmi.RemoteException;
065:
066: /**
067: * Start a timer (if not already set) with the start date plus the period and an interval of the given period.
068: * This method uses an implementation defined default value for the timer info.
069: * @param pPeriod Time that will elapse between two events in milliseconds
070: */
071: public byte[] startTimer(long pPeriod)
072: throws java.rmi.RemoteException;
073:
074: /**
075: * Start a timer (if not already set) with the start date plus the period and an interval of the given
076: * period and the specified timer info
077: * @param pPeriod Time that will elapse between two events in milliseconds
078: * @param info an object to be used as the info for the timer.
079: */
080: public byte[] startTimer(long pPeriod, Serializable info)
081: throws java.rmi.RemoteException;
082:
083: public void stopTimer(byte[] handle)
084: throws java.rmi.RemoteException;
085:
086: public int getTimeoutCount(byte[] handle)
087: throws java.rmi.RemoteException;
088:
089: public java.util.Date getNextTimeout(byte[] handle)
090: throws java.rmi.RemoteException;
091:
092: public long getTimeRemaining(byte[] handle)
093: throws java.rmi.RemoteException;
094:
095: public Object getInfo(byte[] handle)
096: throws java.rmi.RemoteException;
097:
098: /**
099: * Returns the value from the RetryPolicyMBean. This is used by unit tests to help determine timing
100: * for some of the tests, specifically, those that test the fix for JBAS-1926.
101: */
102:
103: public long getRetryTimeoutPeriod() throws java.rmi.RemoteException;
104:
105: }
|