org.cafesip.jiplet
Class JipletTransaction

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

public class JipletTransaction
extends ScopedVariables

This class encapsulates a SIP transaction. The jiplet container supports transaction scope variables. A transaction is created when a jiplet sends a request and registers for a response by calling the Jiplet.registerForResponse() method. The transaction remains active until a terminating response is received, a time-out event is received or if the jiplet application cancels the response by calling the Jiplet.cancelResponse() method. A variable defined in the transaction-scope remains visible to the jiplets during the duration of a transaction. A jiplet can retrieve this object by calling the Jiplet.getTransaction() method. Thereafter, the methods offered by the base class ScopedVariables may be used to create, retrieve and remove transaction-scope variables.

Constructor Summary

protected	JipletTransaction(javax.sip.message.Message message) A constructor for this class.
protected	JipletTransaction(javax.sip.message.Message message, Jiplet jiplet, long timeout) A constructor for this class.

Method Summary

protected boolean	equals(JipletTransaction transaction) Returs true if the transaction provided by the paramater is the same.
protected java.lang.String	getCallId()
protected javax.sip.header.CSeqHeader	getCseq()
protected java.util.Date	getExpiryTime()
protected java.lang.String	getFromTag()
protected javax.sip.address.URI	getFromUri()
protected Jiplet	getJiplet()
protected long	getTimeout()
protected javax.sip.address.URI	getToUri()
int	hashCode()
protected void	resetExpiryTime()
java.lang.String	toString()

Methods inherited from class org.cafesip.jiplet.ScopedVariables

getAttribute, getAttributeNames, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Constructor Detail

JipletTransaction

protected JipletTransaction(javax.sip.message.Message message,
                            Jiplet jiplet,
                            long timeout)
                     throws JipletException

A constructor for this class.

Parameters:

message -

jiplet -

timeout -

Throws:

JipletException

JipletTransaction

protected JipletTransaction(javax.sip.message.Message message)
                     throws JipletException

A constructor for this class.

Parameters:

message -

Throws:

JipletException

Method Detail

getJiplet

protected Jiplet getJiplet()

Returns:

Returns the jiplet.

getToUri

protected javax.sip.address.URI getToUri()

Returns:

Returns the toUri.

getFromTag

protected java.lang.String getFromTag()

getTimeout

protected long getTimeout()

Returns:

Returns the timeout.

equals

protected boolean equals(JipletTransaction transaction)

Returs true if the transaction provided by the paramater is the same.

Parameters:

transaction -

Returns:

getFromUri

protected javax.sip.address.URI getFromUri()

Returns:

Returns the fromUri.

getCallId

protected java.lang.String getCallId()

Returns:

Returns the callId.

getCseq

protected javax.sip.header.CSeqHeader getCseq()

Returns:

Returns the cseq.

getExpiryTime

protected java.util.Date getExpiryTime()

Returns:

Returns the expiryTime.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

resetExpiryTime

protected void resetExpiryTime()