New additions in version 2.0


javax.sip.UserCredentials

The class is used whenever user credentials for a particular realm (site server or service) are necessary

javax.sip.ListeningPoint.createContactHeader()

Create a contact for this listening point.

javax.sip.ListeningPoint.sendHeartbeat(java.lang.String, int)

Send a heartbeat to the specified Ip address and port via this listening point. This method can be used to send out a period CR-LF for NAT keepalive.

javax.sip.ListeningPoint.createViaHeader()

Create a Via header for this listening point.

javax.sip.ListeningPoint.SCTP

Transport constant: SCTP

javax.sip.RequestEvent.setRemoteIpAddress(java.lang.String)

Set the remote IP address. This method is only for use by implementations.

javax.sip.AuthenticationHelper

A helper interface that provides useful functionality for clients that need to authenticate with servers.

javax.sip.Dialog.getSipProvider()

Returns the SipProvider that was used for the first transaction in this Dialog

javax.sip.Dialog.setBackToBackUserAgent()

Sets a flag that indicates that this Dialog is part of a BackToBackUserAgent. If this flag is set, INVITEs are not allowed to interleave and timed out ACK transmission results in a BYE being sent to the other side. Setting this flag instructs the stack to automatically handle dialog errors. Once this flag is set for a dialog, it cannot be changed. This flag can be set on a stack-wide basis, on a per-provider basis or on a per Dialog basis. This flag must only be set at the time of Dialog creation. If the flag is set after the first request or response is seen by the Dialog, the behavior of this flag is undefined.

javax.sip.Dialog.disableSequenceNumberValidation()

Turn off sequence number validation for this dialog. This passes all requests to the application layer including those that arrive out of order. This interface is provided for testing purposes. Validation is delegated to the application and the stack will not attempt to block requests arriving out of sequence from reaching the application. In particular, the validation of CSeq and the ACK retransmission recognition are delegated to the application. Your application will be responsible for error handling of these cases. Sequence number validation is ON by default.

javax.sip.Dialog.isReleaseReferences()

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

javax.sip.Dialog.setReleaseReferences(boolean)

If set to true it will release all references that it no longer needs. This will include the reference to the Request, Transactions, Any unused timers etc. This will significantly reduce memory consumption under high load. This is an optional interface. It is a hint from the application to the JAIN-SIP implementation that allows the implementation to release references safely. An implementation is free to do nothing.

javax.sip.Dialog.setEarlyDialogTimeoutSeconds(int)

Sets the early dialog timeout period. Overrides the value set by the stack configuration property EARLY_DIALOG_TIMEOUT_SECONDS. A dialog may remain in early state indefinitely. UACs may kill a dialog in early state of periodic provisional responses are not seen for 3 minutes. This allows you to override the RFC specified value of 3 minutes hence allowing for fast fail over from unresponsive servers.

javax.sip.SecureAccountManager

Interface that implements the hashed password account manager.

javax.sip.ResponseEvent.setForkedResponse(boolean)

Set true if this is a forked response. This field is only to be set by the implementation (not the application).

javax.sip.ResponseEvent.isForkedResponse()

Return true if this is a forked response. This query function is used by applications to test if a received response is a forked response.

javax.sip.ResponseEvent.setOriginalTransaction(javax.sip.ClientTransaction)

Set the original transaction for a forked response. This is set by the stack implementation and can be retrieved by the application later.

javax.sip.ResponseEvent.getOriginalTransaction()

Get the original transaction for which this is a forked response. Note that this transaction can be in a TERMINATED state. The Original transaction contains the context corresponding to the forked response. This is useful for applications during response processing. If a forked response is received by the stack after the MAX_FORK_TIME setting for the SIP Stack, this field can be set to null when the response is delivered to the application.

javax.sip.ResponseEvent.getListeningPoint()

Get the listening point over which this response was receieved.

javax.sip.ResponseEvent.setRemotePort(int)

Set the remote port from which response was received. Applications should not use this method. This method is reserved for use by applications which may use it to set the remote port.

javax.sip.ResponseEvent.getRemotePort()

Get the remote port from which response was received.

javax.sip.ResponseEvent.getRemoteIpAddress()

Get the remote IP addr. from which request was received.

javax.sip.ResponseEvent.setRemoteIpAddress(java.lang.String)

Set the remote IP addr. from which request was received. Applications should not use this method. This method is expected to be used by implementations to set the remote IP address.

javax.sip.SipStack.getReplacesDialog(javax.sip.header.ReplacesHeader)

Get the ReferedTo dialog in the Replaces header.

javax.sip.SipStack.getAuthenticationHelper(javax.sip.AccountManager, javax.sip.header.HeaderFactory)

Get the authentication helper.

javax.sip.SipStack.getSecureAuthenticationHelper(javax.sip.SecureAccountManager, javax.sip.header.HeaderFactory)

Get the authentication helper.

javax.sip.SipStack.getJoinDialog(javax.sip.header.JoinHeader)

Get the dialog in the Join header.

javax.sip.SipStack.setEnabledCipherSuites(java.lang.String[])

Set the list of cipher suites supported by the stack. A stack can have only one set of suites. These are not validated against the supported cipher suites of the java runtime, so specifying a cipher here does not guarantee that it will work.
The stack has a default cipher suite of: NOTE: This function must be called before adding a TLS listener

javax.sip.SipStack.getDialogs()

Get the collection of dialogs currently in the Dialog table. Dialogs returned in this method are either in Early or Established state.

javax.sip.Transaction.getSipProvider()

Get the Sip Provider associated with this transaction.

javax.sip.Transaction.getPeerAddress()

Returns the IP address of the peer IP address (upstream/downstream) hop from which this message was initially received. Will be null when the client transaction is first created.

javax.sip.Transaction.getPeerPort()

Returns the port of the peer port (upstream/downstream hop) from which this message was initially received. Will be undefined when the client transaction is first created.

javax.sip.Transaction.getTransport()

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

javax.sip.Transaction.getHost()

return the ip address on which this message was initially received

javax.sip.Transaction.getPort()

return the port on which this message was initially received

javax.sip.Transaction.getCipherSuite()

Return the Cipher Suite that was used for the SSL handshake.

javax.sip.Transaction.getLocalCertificates()

Get the certificate(s) that were sent to the peer during handshaking.

javax.sip.Transaction.getPeerCertificates()


javax.sip.Transaction.extractCertIdentities()

Extract identities from certificates exchanged over TLS, based on IETF guidelines

javax.sip.Transaction.setReleaseReferences(boolean)

Provide a hint to the stack to release all references that it no longer needs. After this method is called, the stack may release references that it no longer needs. This will include the reference to the Response, Dialogs, any unused timers etc. This will significantly reduce memory consumption under high load. This is an optimization. An implementation of this specification is free to do nothing when this method is called by the application.

javax.sip.Transaction.getTimerT2()

Retrieve the value of Timer T2 (in ms)

javax.sip.Transaction.setTimerT2(int)

Sets the value of Timer T2 (in ms)

javax.sip.Transaction.getTimerT4()

Retrieve the value of Timer T4 (in ms)

javax.sip.Transaction.setTimerT4(int)

Sets the value of Timer T4 (in ms)

javax.sip.Transaction.getTimerD()

gets the value of Timer D (in ms)

javax.sip.Transaction.setTimerD(int)

Sets the value of Timer D (in ms)

javax.sip.ClientTransaction.setNotifyOnRetransmit(boolean)

Notify on retransmission from the client transaction side. The listener will get a notification on retransmission when this flag is set. When set the client transaction listener will get a Timeout.RETRANSMIT event on each retransmission.

javax.sip.ClientTransaction.alertIfStillInCallingStateBy(int)

Send a transaction timeout event to the application if Tx is still in Calling state in the given time period ( in base timer interval count ) after sending request. The stack will start a timer and alert the application if the client transaction does not transition out of the Trying state by the given interval. This is a "one shot" alert.

javax.sip.ClientTransaction.getNextHop()

Get the next hop that was computed by the routing layer. when it sent out the request. This allows you to route requests to the SAME destination if required ( for example if you get an authentication challenge ).

javax.sip.ClientTransaction.isSecure()

Return true if this Client Transaction is a secure transport.

javax.sip.ClientTransaction.getDefaultDialog()

Get the default dialog that was originally assigned to the client transaction. This will differ from the dialog that is assigned to the transaction when a forked response comes in. This method is useful for UACs that have to deal with forked responses.

javax.sip.UserCredentialHash

Interface for those accounts that only supply hash(user:domain:password). This is more secure than simply supplying password because the password cannot be extracted from MD5Hash(user:domain:password). In general, passwords should never be stored in the clear. Applications prefer to store information in user accounts using such a password hash rather than plain text passwords because it offers better security. This class is implemented by the application and is used by the sip stack when dealing with challenge responses. The JAIN-SIP implementation provides the SecureAuthenticationHelper implementation. The application provides the implementation of SecureAccountManager. The secure AccountManager is called back when dealing with authentication challenges and is expected to provide UserCredentialHash corresponding to the user account for the challenged transaction.

javax.sip.TlsSecurityPolicy

An implementation of this interface can be registered with the sip stack using the configuration property javax.sip.TLS_SECURITY_POLICY. This intervenes in the TLS handshake and is responsible for certificate checking. An implementation shall provide a trivial policy which always accepts the certificate.

javax.sip.AccountManager

Account Manager helper class for the AuthenticationHelper.

javax.sip.SipProvider.setDialogErrorsAutomaticallyHandled()

Sets a flag that indicates that automatic error handling is enabled for this dialog (the default when automatic dialog support is enabled). This flag is set by default to TRUE when the Dialog is automatically created by the provider ( automatic dialog support is true) and set to FALSE by default when the Dialog is created under program control ( automatic dialog support is false). When this flag is set to true, the stack will automatically send the following errors : If this flag is set to false, the stack will not drop out of sequence ACKs but will pass these up to the application for handling. This flag is automatically set to true if any of the the following conditions is true: This flag should only be set at the time of Dialog creation ( before the Dialog has seen its first request or response). If set subsequently, the behavior of the flag is undefined.

javax.sip.ServerTransaction.getCanceledInviteTransaction()

Return the canceled Invite transaction corresponding to an incoming CANCEL server transaction.

javax.sip.SipListener.processDialogTimeout(javax.sip.DialogTimeoutEvent)

Processes an expiration Timeout of an underlying {@link Dialog} handled by this SipListener. This Event notifies the application that a dialog Timer expired in the Dialog's state machine. Such a condition can occur when the application fails to send an ACK after receiving an OK response or if an ACK is not received after an OK is sent. The DialogTimeoutEvent encapsulates the specific timeout type and the dialog identifier. The type of Timeout can by determined by: timeoutType = timeoutEvent.getTimeout().getValue(); This interface extends the {@link SipListener} interface and adds the following events to it : Applications implementing this method should take care of sending the BYE or terminating the dialog to avoid any dialog leaks.

javax.sip.DialogTimeoutEvent

DialogTimeoutEvent is delivered to the Listener when the dialog does not receive or send an ACK.

javax.sip.address.SipURI.removeHeaders()

Strip the headers that are tacked to the URI.

javax.sip.address.SipURI.removeHeader(java.lang.String)

Strip a specific header tacked to the URI.

javax.sip.address.SipURI.hasGrParam()

Returns whether the gr parameter is set.

javax.sip.address.SipURI.setGrParam(java.lang.String)

Sets the gr parameter.

javax.sip.header.Header.getValue()

Gets the header value (i.e. what follows the name:) as a string

javax.sip.header.PathHeader

SIP Path Header. The Path extension header field allows accumulating and transmitting the list of proxies between UA1 and REGISTRAR. This mechanism is in many ways similar to the operation of Record-Route in dialog-initiating requests. See RFC 3327 for details

javax.sip.header.SessionExpiresHeader

Header interface for the Sesison-Expires SIP header as defined in RFF 4028. The Session-Expires header field establishes the upper bound for the session refresh interval; i.e., the time period after processing a request for which any session-stateful proxy must retain its state for this session. Any proxy servicing this request can lower this value, but it is not allowed to decrease it below the value specified in the Min-SE header field.

javax.sip.header.HeaderFactory.createRequestLine(java.lang.String)

Create a RequestLine from a String

javax.sip.header.HeaderFactory.createStatusLine(java.lang.String)

Create a StatusLine from a String

javax.sip.header.HeaderFactory.createReferredByHeader(javax.sip.address.Address)

Create a ReferredBy Header

javax.sip.header.HeaderFactory.createReplacesHeader(java.lang.String, java.lang.String, java.lang.String)

Create a Replaces header with a call Id, to and from tag

javax.sip.header.HeaderFactory.createPAccessNetworkInfoHeader()

creates a P-Access-Network-Info header

javax.sip.header.HeaderFactory.createPAssertedIdentityHeader(javax.sip.address.Address)

Create a P-Asserted-Identity header

javax.sip.header.HeaderFactory.createPAssociatedURIHeader(javax.sip.address.Address)

Create a P-Associated-URI header based on the supplied address

javax.sip.header.HeaderFactory.createPCalledPartyIDHeader(javax.sip.address.Address)

Create a P-Called-Party-ID header.

javax.sip.header.HeaderFactory.createPChargingFunctionAddressesHeader()

Create empty P-Charging-Function-Addresses header.

javax.sip.header.HeaderFactory.createChargingVectorHeader(java.lang.String)

P-Charging-Vector header

javax.sip.header.HeaderFactory.createPMediaAuthorizationHeader(java.lang.String)

Create P-Media-Authorization header

javax.sip.header.HeaderFactory.createPPreferredIdentityHeader(javax.sip.address.Address)

Create P-Preferred-Identity header.

javax.sip.header.HeaderFactory.createPVisitedNetworkIDHeader()

Create empty P-Visited-Network-ID header.

javax.sip.header.HeaderFactory.createPathHeader(javax.sip.address.Address)

Create Path header.

javax.sip.header.HeaderFactory.createPrivacyHeader(java.lang.String)

Create Privacy header.

javax.sip.header.HeaderFactory.createServiceRouteHeader(javax.sip.address.Address)

Create Service-Route header.

javax.sip.header.HeaderFactory.createSecurityServerHeader()

Create a Security-Server header

javax.sip.header.HeaderFactory.createSecurityClientHeader()

Security-Client IMS header

javax.sip.header.HeaderFactory.createSecurityVerifyHeader()

Create a Security-Verify header

javax.sip.header.HeaderFactory.createSessionExpiresHeader(int)

Creates a new SessionExpiresHeader based on the newly supplied expires value.

javax.sip.header.HeaderFactory.createJoinHeader(java.lang.String, java.lang.String, java.lang.String)

Create a Join header with a call Id, to and from tag.

javax.sip.header.HeaderFactory.createPUserDatabaseHeader(java.lang.String)

Create a P-User-Database IMS header.

javax.sip.header.HeaderFactory.createPServedUserHeader(javax.sip.address.Address)

Create a P-Served-User header.

javax.sip.header.HeaderFactory.createHeader(java.lang.String)

Create a header from a string. The string is assumed to be in the name:value format. The trailing CRLF (if any ) will be stripped before parsing this. The header should be a singleton.

javax.sip.header.JoinHeader

Interface for the Join Header. See RFC 3911 for further details.

javax.sip.header.ReplacesHeader

Defines an interface for the SIP Replaces Header as defined in RFC 3891. The Replaces header is used to logically replace an existing SIP dialog with a new SIP dialog. This primitive can be used to enable a variety of features, for example: "Attended Transfer" and "Call Pickup".

javax.sip.header.ReferredByHeader

This interface represents the ReferredBy SIP header, as defined by RFC3892, this header is not part of RFC3261.

A ReferredByHeader only appears in a REFER request. It provides a URL to reference. The ReferredByHeader field MAY be encrypted as part of end-to-end encryption. The resource identified by the Refer-To URI is contacted using the normal mechanisms for that URI type.


javax.sip.header.MinSEHeader

Session timer Min-SE header as defined in RFC 4028 Min-SE conveys the minimum allowed value for the session expiration.

javax.sip.header.ims.SecurityServerHeader

Security-Server header See RFC 3329 + 3GPP TS33.203 (Annex H).


javax.sip.header.ims.SecurityAgreeHeader

"Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).

Headers: Security-Server + Security-Client + Security-Verify


javax.sip.header.ims.PServedUserHeader

P-Served-User 3-GPP Header definition See RFC 5502 . The ABNF of the P-Served-User Header is as follows:
 P-Served-User              = "P-Served-User" HCOLON PServedUser-value
                              *(SEMI served-user-param)
 served-user-param          = sessioncase-param
                              / registration-state-param
                              / generic-param
 PServedUser-value          = name-addr / addr-spec
 sessioncase-param          = "sescase" EQUAL "orig" / "term"
 registration-state-param   = "regstate" EQUAL "unreg" / "reg"
 
Eg: P-Served-User: ; sescase=orig; regstate=reg

javax.sip.header.ims.SecurityClientHeader

Security-Client header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).


javax.sip.header.ims.PChargingFunctionAddressesHeader

P-Charging-Function-Addresses header. See RFC 3455 There is a need to inform each SIP proxy involved in a transaction about the common charging functional entities to receive the generated charging records or charging events. Only one instance of the header MUST be present in a particular request or response.
 P-Charging-Addr = "P-Charging-Function-Addresses" HCOLON
          charge-addr-params
          *(SEMI charge-addr-params)
 charge-addr-params   = ccf / ecf / generic-param
 ccf              = "ccf" EQUAL gen-value
 ecf              = "ecf" EQUAL gen-value

 gen-value    = token / host / quoted-string

 host             =  hostname / IPv4address / IPv6reference
 hostname         =  *( domainlabel "." ) toplabel [ "." ]
 domainlabel      =  alphanum / alphanum *( alphanum / "-" ) alphanum
 toplabel         =  ALPHA / ALPHA *( alphanum / "-" ) alphanum


 example:
  P-Charging-Function-Addresses: ccf=192.1.1.1; ccf=192.1.1.2;
  ecf=192.1.1.3; ecf=192.1.1.4
 

javax.sip.header.ims.ServiceRouteHeader

SERVICE-ROUTE header SIP param: RFC 3608.

javax.sip.header.ims.PUserDatabaseHeader

P-User-Database 3GPP header.See RFC 4457 for details. We only have one major value for this header, as per RFC 4457. This value is the Database name. The DB here refers to the IMS HSS. The DB name is encoded as a URI, delimited by the "<" and ">" signs. There may be generic parameters for this header encoded as URI parameters. They also lie between the "<" and ">" delimiters. However, this URI is neither a SIP URI nor a TEL URI. It is a DIAMETER AAA URI.The value of this AAA URI is consumed by the S-CSCF. The S-CSCF can cache the value of the HSS received in this header,thus optimizing the IMS registration process.

javax.sip.header.ims.PVisitedNetworkIDHeader

P-Visited-Network-ID SIP Private Header: See RFC 3455.

syntax:

 P-Visited-Network-ID = "P-Visited-Network-ID" HCOLON
                         vnetwork-spec
                         *(COMMA vnetwork-spec)
 vnetwork-spec        = (token / quoted-string)
                         *(SEMI vnetwork-param)
 vnetwork-param       = generic-param


 eg: P-Visited-Network-ID: other.net, "Visited network number 1"
 

javax.sip.header.ims.SecurityVerifyHeader

Security-Verify header - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).


javax.sip.header.ims.PCalledPartyIDHeader

P-Called-Party-ID header - Private Header: See RFC 3455 .

A proxy server inserts a P-Called-Party-ID header, typically in an INVITE request, en-route to its destination. The header is populated with the Request-URI received by the proxy in the request.

Both the business SIP URI and the personal SIP URI are registered in the SIP registrar, so both URIs can receive invitations to new sessions. When the user receives an invitation to join a session, he/she should be aware of which of the several registered SIP URIs this session was sent to.

 P-Called-Party-ID    = "P-Called-Party-ID" HCOLON
                        called-pty-id-spec
 called-pty-id-spec   = name-addr *(SEMI cpid-param)
 cpid-param           = generic-param
 

javax.sip.header.ims.WWWAuthenticateHeaderIms

Extension to WWW-authenticate header (3GPP TS 24229-5d0).

Defines a new authentication parameter (auth-param) for the WWW-Authenticate header used in a 401 (Unauthorized) response to the REGISTER request. For more information, see RFC 2617 [21] subclause 3.2.1.

  auth-param = 1#( integrity-key / cipher-key )
  integrity-key = "ik" EQUAL ik-value
  cipher-key = "ck" EQUAL ck-value
  ik-value = LDQUOT *(HEXDIG) RDQUOT
  ck-value = LDQUOT *(HEXDIG) RDQUOT
 

javax.sip.header.ims.PrivacyHeader

Privacy Header. See RFC 3323 for more details.
 Privacy-hdr  = "Privacy" HCOLON priv-value *(";" priv-value)
 priv-value   = "header" / "session" / "user" /
                "id" / "none" / "critical" / token
 example:
           Privacy: id
 

javax.sip.header.ims.AuthorizationHeaderIms

Extension to Authorization header (3GPP TS 24299-5d0). This extension defines a new auth-param for the Authorization header used in REGISTER requests. For more information, see RFC 2617 [21] subclause 3.2.2.

javax.sip.header.ims.PAssertedIdentityHeader

P-Asserted-Identity header. See RFC 3455 Contains a URI (commonly a SIP URI) and an optional display-name enable a network of trusted SIP servers to assert the identity of authenticated users, and the application of existing privacy mechanisms to the identity problem. The use of this extension is only applicable inside an administrative domain with previously agreed-upon policies for generation, transport and usage of such information.

javax.sip.message.Message.setApplicationData(java.lang.Object)

This method allows applications to associate application context with the message. This specification does not define the format of this data, this the responsibility of the application and is dependent on the application. this application data is un-interpreted by the stack. Warning : when you clone a message, the deepcopy does not apply to the application data (instead, we would just make a copy of the pointer).

javax.sip.message.Message.getApplicationData()

Returns the application data associated with the message.This specification does not define the format of this application specific data. This is the responsibility of the application.

javax.sip.message.Message.getMultipartMimeContent()

Get the multipart mime content from a message. Builds a wrapper around the content and breaks it into multiple sections. Returns these sections as a multipart mime content list. If the content type is not multipart mime then the list will have a single element in it.

javax.sip.message.Message.getTopmostViaHeader()

Get the topmost Via header.

javax.sip.message.Message.getFrom()

Get the From header or null if none present.

javax.sip.message.Message.getTo()

Get the To header or null if none present.

javax.sip.message.Message.getCallId()

Get the callId header or null if none present.

javax.sip.message.Message.getCSeq()

Get the CSeq header or null if none present.

javax.sip.message.Message.getContentType()

Get the content type header or null if none present.

javax.sip.message.Message.getFirstLine()

Get the first line of the request or response.

javax.sip.message.MessageFactory.setDefaultServerHeader(javax.sip.header.ServerHeader)

Set the common Server header for all Responses created from this message factory. This header is applied to all Messages created from this Factory object except those that take String for an argument and create Message from the given String.

javax.sip.message.MessageFactory.setDefaultContentEncodingCharset(java.lang.String)

Set default charset used for encoding String content. Note that this will be applied to all content that is encoded. The default is UTF-8.

javax.sip.message.MessageFactory.createMultipartMimeContent(javax.sip.header.ContentTypeHeader, java.lang.String[], java.lang.String[], java.lang.String[])

Create a MultipartMime attachment from a list of content type, subtype and content.

javax.sip.message.SipRequestLine

An interface for the SIP Request Line.

javax.sip.message.Content

Content fragment for a Multipart-Mime content.

javax.sip.message.SipStatusLine

An interface for the SIP Status Line.

Deprecated in version 2.0


javax.sip.Transaction.getSipProvider()

Get the Sip Provider associated with this transaction.

javax.sip.Transaction.getPeerAddress()

Returns the IP address of the peer IP address (upstream/downstream) hop from which this message was initially received. Will be null when the client transaction is first created.

javax.sip.Transaction.getPeerPort()

Returns the port of the peer port (upstream/downstream hop) from which this message was initially received. Will be undefined when the client transaction is first created.

javax.sip.Transaction.getTransport()

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

javax.sip.Transaction.getHost()

return the ip address on which this message was initially received

javax.sip.Transaction.getPort()

return the port on which this message was initially received

javax.sip.Transaction.getCipherSuite()

Return the Cipher Suite that was used for the SSL handshake.

javax.sip.Transaction.getLocalCertificates()

Get the certificate(s) that were sent to the peer during handshaking.

javax.sip.Transaction.getPeerCertificates()


javax.sip.Transaction.extractCertIdentities()

Extract identities from certificates exchanged over TLS, based on IETF guidelines

javax.sip.Transaction.setReleaseReferences(boolean)

Provide a hint to the stack to release all references that it no longer needs. After this method is called, the stack may release references that it no longer needs. This will include the reference to the Response, Dialogs, any unused timers etc. This will significantly reduce memory consumption under high load. This is an optimization. An implementation of this specification is free to do nothing when this method is called by the application.

javax.sip.Transaction.getTimerT2()

Retrieve the value of Timer T2 (in ms)

javax.sip.Transaction.setTimerT2(int)

Sets the value of Timer T2 (in ms)

javax.sip.Transaction.getTimerT4()

Retrieve the value of Timer T4 (in ms)

javax.sip.Transaction.setTimerT4(int)

Sets the value of Timer T4 (in ms)

javax.sip.Transaction.getTimerD()

gets the value of Timer D (in ms)

javax.sip.Transaction.setTimerD(int)

Sets the value of Timer D (in ms)

javax.sip.ServerTransaction.enableRetransmissionAlerts()

Enable the timeout retransmit notifications for the ServerTransaction. This method is invoked by UAs that do want to be alerted by the stack to retransmit 2XX responses but that do NOT want to associate a Dialog. The Default operation is to disable retransmission alerts for the Server Transaction when no Dialog is associated with the Server Transaction, as is common for a Proxy server. When this method is called, the stack will continue to generate {@link Timeout#RETRANSMIT} until the application calls {@link Transaction#terminate()} or a the listener receives a {@link SipListener#processTransactionTerminated(TransactionTerminatedEvent) } callback. Note that the stack calls {@link SipListener#processTransactionTerminated(TransactionTerminatedEvent)}asynchronously after it removes the transaction some time after the Transaction state is set to {@link TransactionState#TERMINATED } ; after which, it maintains no record of the Transaction.

javax.sip.header.Header.getValue()

Gets the header value (i.e. what follows the name:) as a string

javax.sip.header.ims.SecurityAgreeHeader

"Security Mechanism Agreemet for SIP Sessions" - sec-agree: RFC 3329 + 3GPP TS33.203 (Annex H).

Headers: Security-Server + Security-Client + Security-Verify


javax.sip.message.Message.setApplicationData(java.lang.Object)

This method allows applications to associate application context with the message. This specification does not define the format of this data, this the responsibility of the application and is dependent on the application. this application data is un-interpreted by the stack. Warning : when you clone a message, the deepcopy does not apply to the application data (instead, we would just make a copy of the pointer).

javax.sip.message.Message.getApplicationData()

Returns the application data associated with the message.This specification does not define the format of this application specific data. This is the responsibility of the application.

javax.sip.message.Message.getMultipartMimeContent()

Get the multipart mime content from a message. Builds a wrapper around the content and breaks it into multiple sections. Returns these sections as a multipart mime content list. If the content type is not multipart mime then the list will have a single element in it.

javax.sip.message.Message.getTopmostViaHeader()

Get the topmost Via header.

javax.sip.message.Message.getFrom()

Get the From header or null if none present.

javax.sip.message.Message.getTo()

Get the To header or null if none present.

javax.sip.message.Message.getCallId()

Get the callId header or null if none present.

javax.sip.message.Message.getCSeq()

Get the CSeq header or null if none present.

javax.sip.message.Message.getContentType()

Get the content type header or null if none present.

javax.sip.message.Message.getFirstLine()

Get the first line of the request or response.

javax.sip.message.MessageFactory.createResponse(int, javax.sip.header.CallIdHeader, javax.sip.header.CSeqHeader, javax.sip.header.FromHeader, javax.sip.header.ToHeader, java.util.List, javax.sip.header.MaxForwardsHeader, javax.sip.header.ContentTypeHeader, java.lang.Object)

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message with a body in the form of a Java object and the body content type.

javax.sip.message.MessageFactory.createResponse(int, javax.sip.header.CallIdHeader, javax.sip.header.CSeqHeader, javax.sip.header.FromHeader, javax.sip.header.ToHeader, java.util.List, javax.sip.header.MaxForwardsHeader, javax.sip.header.ContentTypeHeader, byte[])

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message with a body in the form of a byte array and the body content type.

javax.sip.message.MessageFactory.createResponse(int, javax.sip.header.CallIdHeader, javax.sip.header.CSeqHeader, javax.sip.header.FromHeader, javax.sip.header.ToHeader, java.util.List, javax.sip.header.MaxForwardsHeader)

Creates a new Response message of type specified by the statusCode paramater, containing the mandatory headers of the message. This new Response does not contain a body.