org.cafesip.jiplet
Class JipletEvent

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

Direct Known Subclasses:

JipletRequest, JipletResponse, JipletSignal, JipletTimeout, JipletTimer

public class JipletEvent
extends ScopedVariables

The JipletEvent is the base class for all the events that a jiplet can receive from the container. The events include receipt of a SIP request message and a response message. It also includes a SIP time-out event and the even generated when a timer started by the application expires. The container passes an event object that extends this class as a parameter to the callback method (example Jiplet.processRequest()).

This class supports the event-scope variables. Event-scope variables remain active during the lifetime of the event and varibales set by one jiplet can be retrieved by another jiplet to which the event was forwarded to (see Jiplet.forward()).

Constructor Summary

protected

JipletEvent() A constructor for this class.

Method Summary

protected java.lang.String	getForward()
JipletContext	getJipletContext()
JipletSession	getSession(javax.sip.message.Message message, boolean create) Returns the session object associated with the message.
protected void	setForward(java.lang.String forward)
void	setJipletContext(JipletContext jipletContext)

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

JipletEvent

protected JipletEvent()

A constructor for this class.

Method Detail

getJipletContext

public JipletContext getJipletContext()

Returns:

Returns the jipletContext.

setJipletContext

public void setJipletContext(JipletContext jipletContext)

Parameters:

jipletContext - The jipletContext to set.

getSession

public JipletSession getSession(javax.sip.message.Message message,
                                boolean create)

Returns the session object associated with the message. The session object identifies a SIP endpoint (the SIP UAC). A jiplet application must not instantiate this class. Instead, it must use the getSession() method provided in the Jiplet class.

Parameters:

message - A JAIN-SIP Message object. This is the base class for handling all SIP messages.

create - true if the container is to be created if it does not exist.

Returns:

the session object. Returns null if the session object does not exist (when create = false).

getForward

protected java.lang.String getForward()

setForward

protected void setForward(java.lang.String forward)