org.cafesip.jiplet
Class JipletResponse

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

public class JipletResponse
extends JipletEvent

This class conatins methods that is used by a jiplet to retrieve information about a response event. When a SIP response message is received, the container passes on the event to the jiplet that sent the SIP request message. The callback method Jiplet.processResponse() is called by the container. This object is passed as a parameter.

Constructor Summary

protected

JipletResponse() A constructor for this class.

Method Summary

Jiplet	getJiplet()
javax.sip.ResponseEvent	getResponseEvent()
JipletSession	getSession(boolean create) Get the session object associated with this response.
SipCommunicator	getSipCommunicator() This method returns a proxy object which can be used to proxy SIP requests, responses, handle proxy timeouts and other SIP-related operations.
JipletTransaction	getTransaction()
protected void	setJiplet(Jiplet jiplet)
protected void	setResponseEvent(javax.sip.ResponseEvent responseEvent)
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

JipletResponse

protected JipletResponse()

A constructor for this class.

Method Detail

getResponseEvent

public javax.sip.ResponseEvent getResponseEvent()

Returns:

Returns the responseEvent.

setResponseEvent

protected void setResponseEvent(javax.sip.ResponseEvent responseEvent)

Parameters:

responseEvent - The responseEvent to set.

getSession

public JipletSession getSession(boolean create)

Get the session object associated with this response. 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 and other SIP-related operations.

Returns: