org.cafesip.jiplet
Class JipletTimer

java.lang.Object
  org.cafesip.jiplet.ScopedVariables
      org.cafesip.jiplet.JipletEvent
          org.cafesip.jiplet.JipletTimer

public class JipletTimer
extends JipletEvent

This class conatins methods that is used by a jiplet to retrieve information about a timer event. Jiplets can start timers by calling the method Jiplet.startTimer(). These timers may be used by the jiplet application for any purposes. When a timer expires, the jiplet generates an event for the jiplet that started the timer by calling the method Jiplet.processTimer(). An object of the type JipletTimer is passed to the callback method.

Constructor Summary

protected

JipletTimer()

Method Summary

Jiplet	getJiplet()
JipletSession	getSession(boolean create) Get the session object associated with this event.
TimerEvent	getTimerEvent()
protected void	setJiplet(Jiplet jiplet)
protected void	setTimerEvent(TimerEvent timerEvent)

Methods inherited from class org.cafesip.jiplet.JipletEvent

getForward, getJipletContext, getSession, setForward, setJipletContext

Methods inherited from class org.cafesip.jiplet.ScopedVariables

getAttribute, getAttributeNames, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JipletTimer

protected JipletTimer()

Method Detail

getSession

public JipletSession getSession(boolean create)

Get the session object associated with this event. A session identifies the SIP endpoint (UAC). Session-scope variables are supported similar to servlets and this object is used for storing session-scope variables.

Parameters:

create - create the session object if it does not exist.

Returns:

the session object. Null if the create parameter is false and the session object does not exist.

getTimerEvent

public TimerEvent getTimerEvent()

Returns:

Returns the timerEvent.

setTimerEvent

protected void setTimerEvent(TimerEvent timerEvent)

Parameters:

timerEvent - The timerEvent to set.

getJiplet

public Jiplet getJiplet()

Returns:

Returns the jiplet.

setJiplet

protected void setJiplet(Jiplet jiplet)

Parameters:

jiplet - The jiplet to set.