org.jboss.test.timer.ejb
Class TimerEntityBean

java.lang.Object
  extended byorg.jboss.test.timer.ejb.TimerEntityBean
All Implemented Interfaces:
EnterpriseBean (src) , EntityBean (src) , java.io.Serializable, TimedObject (src)

public class TimerEntityBean
extends java.lang.Object
implements EntityBean (src) , TimedObject (src)

Entity Bean Timer Test

See Also:
Serialized Form

Constructor Summary
TimerEntityBean()
           
 
Method Summary
 void ejbActivate()
          A container invokes this method when the instance is taken out of the pool of available instances to become associated with a specific EJB object.
 java.lang.Integer ejbCreate(java.lang.Integer pk)
           
 java.lang.Integer ejbFindByPrimaryKey(java.lang.Integer pk)
           
 void ejbLoad()
          A container invokes this method to instruct the instance to synchronize its state by loading it state from the underlying database.
 void ejbPassivate()
          A container invokes this method on an instance before the instance becomes disassociated with a specific EJB object.
 void ejbPostCreate(java.lang.Integer pk)
           
 void ejbRemove()
          A container invokes this method before it removes the EJB object that is currently associated with the instance.
 void ejbStore()
          A container invokes this method to instruct the instance to synchronize its state by storing it to the underlying database.
 void ejbTimeout(Timer (src)  pTimer)
          Invoked by the EJB container upon timer expiration.
 java.lang.Object getInfo()
           
 java.util.Date getNextTimeout()
           
 int getTimeoutCount()
           
 long getTimeRemaining()
           
 TimerHandle (src) getTimerHandle()
           
 void setEntityContext(EntityContext (src)  ctx)
          Set the associated entity context.
 void startSingleTimer(long pPeriod)
          Start a single timer (if not already set) with the start date plus the period
 void startTimer(long pPeriod)
          Start a timer (if not already set) with the start date plus the period and an interval of the given period
 void stopTimer()
           
 java.lang.String toString()
          Describes the instance and its content for debugging purpose
 void unsetEntityContext()
          Unset the associated entity context.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TimerEntityBean

public TimerEntityBean()
Method Detail

startSingleTimer

public void startSingleTimer(long pPeriod)
Start a single timer (if not already set) with the start date plus the period

Parameters:
pPeriod - Time that will elapse between now and the timed event in milliseconds

startTimer

public void startTimer(long pPeriod)
Start a timer (if not already set) with the start date plus the period and an interval of the given period

Parameters:
pPeriod - Time that will elapse between two events in milliseconds

stopTimer

public void stopTimer()

getTimeoutCount

public int getTimeoutCount()

getNextTimeout

public java.util.Date getNextTimeout()
Returns:
Date of the next timed event

getTimeRemaining

public long getTimeRemaining()
Returns:
Time remaining until next timed event in milliseconds

getInfo

public java.lang.Object getInfo()
Returns:
User object of the timer

getTimerHandle

public TimerHandle (src)  getTimerHandle()
Returns:
Date of the next timed event

ejbTimeout

public void ejbTimeout(Timer (src)  pTimer)
Description copied from interface: TimedObject (src)
Invoked by the EJB container upon timer expiration.

Specified by:
ejbTimeout in interface TimedObject (src)
Parameters:
pTimer - Timer whose expiration caused this notification

toString

public java.lang.String toString()
Describes the instance and its content for debugging purpose

Returns:
Debugging information about the instance and its content

ejbCreate

public java.lang.Integer ejbCreate(java.lang.Integer pk)

ejbPostCreate

public void ejbPostCreate(java.lang.Integer pk)

ejbFindByPrimaryKey

public java.lang.Integer ejbFindByPrimaryKey(java.lang.Integer pk)

ejbActivate

public void ejbActivate()
Description copied from interface: EntityBean (src)

A container invokes this method when the instance is taken out of the pool of available instances to become associated with a specific EJB object. This method transitions the instance to the ready state.

This method executes in an unspecified transaction context.

Specified by:
ejbActivate in interface EntityBean (src)

ejbLoad

public void ejbLoad()
Description copied from interface: EntityBean (src)

A container invokes this method to instruct the instance to synchronize its state by loading it state from the underlying database.

This method always executes in the transaction context determined by the value of the transaction attribute in the deployment descriptor.

Specified by:
ejbLoad in interface EntityBean (src)

ejbPassivate

public void ejbPassivate()
Description copied from interface: EntityBean (src)

A container invokes this method on an instance before the instance becomes disassociated with a specific EJB object. After this method completes, the container will place the instance into the pool of available instances.

This method executes in an unspecified transaction context.

Specified by:
ejbPassivate in interface EntityBean (src)

ejbRemove

public void ejbRemove()
Description copied from interface: EntityBean (src)

A container invokes this method before it removes the EJB object that is currently associated with the instance. This method is invoked when a client invokes a remove operation on the enterprise Bean's home interface or the EJB object's remote interface. This method transitions the instance from the ready state to the pool of available instances.

This method is called in the transaction context of the remove operation.

Specified by:
ejbRemove in interface EntityBean (src)

ejbStore

public void ejbStore()
Description copied from interface: EntityBean (src)

A container invokes this method to instruct the instance to synchronize its state by storing it to the underlying database.

This method always executes in the transaction context determined by the value of the transaction attribute in the deployment descriptor.

Specified by:
ejbStore in interface EntityBean (src)

setEntityContext

public void setEntityContext(EntityContext (src)  ctx)
Description copied from interface: EntityBean (src)

Set the associated entity context. The container invokes this method on an instance after the instance has been created.

This method is called in an unspecified transaction context.

Specified by:
setEntityContext in interface EntityBean (src)
Parameters:
ctx - - An EntityContext interface for the instance. The instance should store the reference to the context in an instance variable.

unsetEntityContext

public void unsetEntityContext()
Description copied from interface: EntityBean (src)

Unset the associated entity context. The container calls this method before removing the instance.

This is the last method that the container invokes on the instance. The Java garbage collector will eventually invoke the finalize() method on the instance.

This method is called in an unspecified transaction context.

Specified by:
unsetEntityContext in interface EntityBean (src)