NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

gov.nist.javax.sip
Interface TransactionExt

All Superinterfaces:
Serializable, Transaction
All Known Subinterfaces:
ClientTransactionExt, ServerTransactionExt
All Known Implementing Classes:
SIPClientTransaction, SIPServerTransaction, SIPTransaction

public interface TransactionExt
extends Transaction


Method Summary
 List<String> extractCertIdentities()
          Extract identities from certificates exchanged over TLS, based on guidelines from draft-ietf-sip-domain-certs-04.
 String getCipherSuite()
          Return the Cipher Suite that was used for the SSL handshake.
 String getHost()
          return the ip address on which this message was initially received
 Certificate[] getLocalCertificates()
          Get the certificate(s) that were sent to the peer during handshaking.
 String getPeerAddress()
          Returns the IP address of the upstream/downstream hop from which this message was initially received
 Certificate[] getPeerCertificates()
           
 int getPeerPort()
          Returns the port of the upstream/downstream hop from which this message was initially received
 int getPort()
          return the port on which this message was initially received
 SipProvider getSipProvider()
          Get the Sip Provider associated with this transaction
 int getTimerD()
          Sets the value of Timer D (in ms)
 int getTimerT2()
          Retrieve the value of Timer T2 (in ms)
 int getTimerT4()
          Retrieve the value of Timer T4 (in ms)
 String getTransport()
          Returns the name of the protocol with which this message was initially received
 boolean isReleaseReferences()
          retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory
 void setReleaseReferences(boolean releaseReferences)
          If set to true it will release all references that it no longer needs.
 void setTimerD(int interval)
          Sets the value of Timer D (in ms)
 void setTimerT2(int interval)
          Sets the value of Timer T2 (in ms)
 void setTimerT4(int interval)
          Sets the value of Timer T4 (in ms)
 
Methods inherited from interface javax.sip.Transaction
getApplicationData, getBranchId, getDialog, getRequest, getRetransmitTimer, getState, setApplicationData, setRetransmitTimer, terminate
 

Method Detail

getSipProvider

SipProvider getSipProvider()
Get the Sip Provider associated with this transaction


getPeerAddress

String getPeerAddress()
Returns the IP address of the upstream/downstream hop from which this message was initially received

Returns:
the IP address of the upstream/downstream hop from which this message was initially received
Since:
2.0

getPeerPort

int getPeerPort()
Returns the port of the upstream/downstream hop from which this message was initially received

Returns:
the port of the upstream/downstream hop from which this message was initially received
Since:
2.0

getTransport

String getTransport()
Returns the name of the protocol with which this message was initially received

Returns:
the name of the protocol with which this message was initially received
Since:
2.0

getHost

String getHost()
return the ip address on which this message was initially received

Returns:
the ip address on which this message was initially received

getPort

int getPort()
return the port on which this message was initially received

Returns:
the port on which this message was initially received

getCipherSuite

String getCipherSuite()
                      throws UnsupportedOperationException
Return the Cipher Suite that was used for the SSL handshake.

Returns:
Returns the cipher suite in use by the session which was produced by the handshake.
Throws:
UnsupportedOperationException

getLocalCertificates

Certificate[] getLocalCertificates()
                                   throws UnsupportedOperationException
Get the certificate(s) that were sent to the peer during handshaking.

Returns:
the certificate(s) that were sent to the peer during handshaking.
Throws:
UnsupportedOperationException

getPeerCertificates

Certificate[] getPeerCertificates()
                                  throws SSLPeerUnverifiedException
Returns:
the identity of the peer which was identified as part of defining the session.
Throws:
SSLPeerUnverifiedException

extractCertIdentities

List<String> extractCertIdentities()
                                   throws SSLPeerUnverifiedException
Extract identities from certificates exchanged over TLS, based on guidelines from draft-ietf-sip-domain-certs-04.

Returns:
list of authenticated identities
Throws:
SSLPeerUnverifiedException

isReleaseReferences

boolean isReleaseReferences()
retrieve the value of release references to know if the stack performs optimizations on cleanup to save on memory

Returns:
release references value
Since:
2.0

setReleaseReferences

void setReleaseReferences(boolean releaseReferences)
If set to true it will release all references that it no longer needs. This will include the reference to the Request, Response, Dialogs, Any unused timers etc. This will significantly reduce memory consumption under high load

Parameters:
releaseReferences -
Since:
2.0

getTimerT2

int getTimerT2()
Retrieve the value of Timer T2 (in ms)

Returns:
T2 value (in ms)
Since:
2.0

setTimerT2

void setTimerT2(int interval)
Sets the value of Timer T2 (in ms)

Parameters:
interval - value of Timer T2 (in ms)
Since:
2.0

getTimerT4

int getTimerT4()
Retrieve the value of Timer T4 (in ms)

Returns:
T4 value (in ms)
Since:
2.0

setTimerT4

void setTimerT4(int interval)
Sets the value of Timer T4 (in ms)

Parameters:
interval - value of Timer T4 (in ms)
Since:
2.0

getTimerD

int getTimerD()
Sets the value of Timer D (in ms)

Parameters:
interval - value of Timer D (in ms)
Since:
2.0

setTimerD

void setTimerD(int interval)
Sets the value of Timer D (in ms)

Parameters:
interval - value of Timer D (in ms)
Since:
2.0

NIST-SIP: The Reference Implementation for JAIN-SIP 1.2

A product of the NIST/ITL Advanced Networking Technologies Division.
See conditions of use.
Submit a bug report or feature request.