org.cafesip.jiplet
Class JipletTimeout

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

public class JipletTimeout
extends JipletEvent

This class conatins methods that is used by a jiplet to retrieve information about a timeout event. When there is a time-out receiving response from a SIP UAC, the container sends the timeout event notification by calling the jilet's callback method Jiplet.processTimeout(). This object is passed as a parameter to the callback method.

Constructor Summary

protected

JipletTimeout() A constructor for this class.

Method Summary

Jiplet	getJiplet()
JipletSession	getSession(boolean create) Get the session object associated with this event.
SipCommunicator	getSipCommunicator() This method returns a proxy object which can be used to proxy SIP requests, responses, handle proxy timeouts as well as other SIP-related operations.
javax.sip.TimeoutEvent	getTimeoutEvent()
JipletTransaction	getTransaction()
protected void	setJiplet(Jiplet jiplet)
protected void	setTimeoutEvent(javax.sip.TimeoutEvent timeoutEvent)
protected void	setTransaction(JipletTransaction transaction)

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

JipletTimeout

protected JipletTimeout()

A constructor for this class.

Method Detail

getTimeoutEvent

public javax.sip.TimeoutEvent getTimeoutEvent()

Returns:

Returns the timeoutEvent.

setTimeoutEvent

protected void setTimeoutEvent(javax.sip.TimeoutEvent timeoutEvent)

Parameters:

timeoutEvent - The timeoutEvent to set.

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.

getTransaction

public JipletTransaction getTransaction()

Returns:

Returns the transaction.

setTransaction

protected void setTransaction(JipletTransaction transaction)

Parameters:

transaction - The transaction to set.

getJiplet

public Jiplet getJiplet()

Returns:

Returns the jiplet.

setJiplet

protected void setJiplet(Jiplet jiplet)

Parameters:

jiplet - The jiplet to set.

getSipCommunicator

public SipCommunicator getSipCommunicator()

This method returns a proxy object which can be used to proxy SIP requests, responses, handle proxy timeouts as well as other SIP-related operations.

Returns: