gov.nist.javax.sip

Interface SipStackExt

All Superinterfaces:

SipStack

All Known Implementing Classes:

SipStackImpl

public interface SipStackExt
extends SipStack

SIP Stack extensions to be added to the next spec revision. Only these may be safely used in the interim between now and the next release. SipStackImpl implements this interface. The following new stack initialization flags are defined (not the gov.nist prefix will be dropped when the spec is updated):

• gov.nist.javax.sip.AUTOMATIC_DIALOG_ERROR_HANDLING
• gov.nist.javax.sip.IS_BACK_TO_BACK_USER_AGENT
• gov.nist.javax.sip.DELIVER_TERMINATED_EVENT_FOR_NULL_DIALOG
• gov.nist.javax.sip.MAX_FORK_TIME_SECONDS

Author:

M. Ranganathan

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationHelper	getAuthenticationHelper(AccountManager accountManager, HeaderFactory headerFactory) Get the authentication helper.
Collection<Dialog>	getDialogs() Get the collection of dialogs currently in the Dialog table.
Dialog	getJoinDialog(JoinHeader joinHeader) Get the dialog in the Join header.
SocketAddress	getLocalAddressForTcpDst(InetAddress dst, int dstPort, InetAddress localAddress, int localPort) Creates and binds, if necessary, a TCP socket connected to the specified destination address and port and then returns its local address.
SocketAddress	getLocalAddressForTlsDst(InetAddress dst, int dstPort, InetAddress localAddress) Creates and binds, if necessary, a TLS socket connected to the specified destination address and port and then returns its local address.
Dialog	getReplacesDialog(ReplacesHeader replacesHeader) Get the ReferedTo dialog in the Replaces header.
AuthenticationHelper	getSecureAuthenticationHelper(SecureAccountManager accountManager, HeaderFactory headerFactory) Get the authentication helper.
void	setAddressResolver(AddressResolver addressResolver) Set the address resolution interface.
void	setEnabledCipherSuites(String[] newCipherSuites) Set the list of cipher suites supported by the stack.

Methods inherited from interface javax.sip.SipStack

createListeningPoint, createListeningPoint, createSipProvider, deleteListeningPoint, deleteSipProvider, getIPAddress, getListeningPoints, getRouter, getSipProviders, getStackName, isRetransmissionFilterActive, start, stop

Method Detail

getDialogs

Collection<Dialog> getDialogs()

Get the collection of dialogs currently in the Dialog table. This is useful for debugging purposes.

getReplacesDialog

Dialog getReplacesDialog(ReplacesHeader replacesHeader)

Get the ReferedTo dialog in the Replaces header.

Returns:

Dialog object matching the Replaces header, provided it is in an appropriate state to be replaced, null otherwise

Since:

2.0

getAuthenticationHelper

AuthenticationHelper getAuthenticationHelper(AccountManager accountManager,
                                           HeaderFactory headerFactory)

Get the authentication helper.

Parameters:

accountManager - -- account manager (for fetching credentials).

headerFactory - -- header factory.

Returns:

- the authentication helper which can be used for generating the appropriate headers for handling authentication challenges for user agents.

Since:

2.0

getSecureAuthenticationHelper

AuthenticationHelper getSecureAuthenticationHelper(SecureAccountManager accountManager,
                                                 HeaderFactory headerFactory)

Get the authentication helper.

Parameters:

accountManager - -- account manager (for fetching credentials).

headerFactory - -- header factory.

Returns:

- the authentication helper which can be used for generating the appropriate headers for handling authentication challenges for user agents.

Since:

2.0

setAddressResolver

void setAddressResolver(AddressResolver addressResolver)

Set the address resolution interface. The address resolver allows you to register custom lookup schemes ( for example DNS SRV lookup ) that are not directly supported by the JDK.

Parameters:

addressResolver - -- the address resolver to set.

Since:

2.0

getJoinDialog

Dialog getJoinDialog(JoinHeader joinHeader)

Get the dialog in the Join header.

Returns:

Dialog object matching the Join header, provided it is in an appropriate state to be replaced, null otherwise

Since:

2.0

setEnabledCipherSuites

void setEnabledCipherSuites(String[] newCipherSuites)

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:

• TLS_RSA_WITH_AES_128_CBC_SHA
• SSL_RSA_WITH_3DES_EDE_CBC_SHA
• TLS_DH_anon_WITH_AES_128_CBC_SHA
• SSL_DH_anon_WITH_3DES_EDE_CBC_SHA

NOTE: This function must be called before adding a TLS listener

Parameters:

newCipherSuites - -- The new set of ciphers to support.

Since:

2.0

getLocalAddressForTcpDst

SocketAddress getLocalAddressForTcpDst(InetAddress dst,
                                     int dstPort,
                                     InetAddress localAddress,
                                     int localPort)
                                       throws IOException

Creates and binds, if necessary, a TCP socket connected to the specified destination address and port and then returns its local address.

Parameters:

dst - the destination address that the socket would need to connect to.

dstPort - the port number that the connection would be established with.

localAddress - the address that we would like to bind on (null for the "any" address).

localPort - the port that we'd like our socket to bind to (0 for a random port).

Returns:

the local SocketAddress that this handler would use when connecting to the specified destination address and port.

Throws:

IOException - if we fail binding the socket

Since:

2.0

getLocalAddressForTlsDst

SocketAddress getLocalAddressForTlsDst(InetAddress dst,
                                     int dstPort,
                                     InetAddress localAddress)
                                       throws IOException

Creates and binds, if necessary, a TLS socket connected to the specified destination address and port and then returns its local address.

Parameters:

dst - the destination address that the socket would need to connect to.

dstPort - the port number that the connection would be established with.

localAddress - the address that we would like to bind on (null for the "any" address).

Returns:

the local SocketAddress that this handler would use when connecting to the specified destination address and port.

Throws:

IOException - if we fail binding the socket

Since:

2.0