org.mobicents.servlet.sip

Class SipConnector

java.lang.Object

org.mobicents.servlet.sip.SipConnector

All Implemented Interfaces:

Serializable

public class SipConnector
extends Object
implements Serializable

Represents a Restcomm Sip Servlets SIP connector and its various attributes

Author:

jean.deruelle@gmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SipConnector()

Method Summary

Methods

Modifier and Type	Method and Description
void	closeAllSockets() Cleans up all cached TCP/TLS/SCTP sockets in case they are stalled.
boolean	closeReliableConnection(String ipAddress, int port) Allow to close a given TCP/TLS/SCTP connection
boolean	equals(Object obj)
String	getHostNames()
String	getIpAddress()
String	getLoadBalancerAddress()
Properties	getLoadBalancerCustomInformation()
int	getLoadBalancerRmiPort()
int	getLoadBalancerSipPort()
int	getPort()
String	getStaticServerAddress()
int	getStaticServerPort()
String	getStunServerAddress()
int	getStunServerPort()
String	getTransport()
int	hashCode()
boolean	isReplaceStaticServerAddressForInternalRoutingRequest()
boolean	isUseLoadBalancer()
boolean	isUseStaticAddress()
boolean	isUseStun()
void	sendHeartBeat(String ipAddress, int port) Send a heartbeat to the specified Ip address and port via this listening point.
void	setHostNames(String hostNames)
void	setIpAddress(String ipAddress)
boolean	setKeepAliveTimeout(String ipAddress, int port, long timeout) Allow to reset the RFC5626 Section 4.4.1 keeplive on a given TCP/TLS/SCTP connection
void	setLoadBalancerAddress(String loadBalancerAddress)
void	setLoadBalancerCustomInformation(Properties loadBalancerCustomInformation)
void	setLoadBalancerRmiPort(int loadBalancerRmiPort)
void	setLoadBalancerSipPort(int loadBalancerSipPort)
void	setPort(int port)
void	setReplaceStaticServerAddressForInternalRoutingRequest(boolean value)
void	setStaticServerAddress(String staticServerAddress)
void	setStaticServerPort(int staticServerPort)
void	setStunServerAddress(String stunServerAddress)
void	setStunServerPort(int stunServerPort)
void	setTransport(String transport)
void	setUseLoadBalancer(boolean useLoadBalancer)
void	setUseStaticAddress(boolean useStaticAddress)
void	setUseStun(boolean useStun)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SipConnector

public SipConnector()

Method Detail

getTransport

public String getTransport()

Returns:

the Transport

setTransport

public void setTransport(String transport)

Parameters:

transport - the transport to set

getPort

public int getPort()

Returns:

the port

setPort

public void setPort(int port)

Parameters:

port - the port to set

Throws:

Exception

setIpAddress

public void setIpAddress(String ipAddress)

getIpAddress

public String getIpAddress()

getStunServerAddress

public String getStunServerAddress()

Returns:

the stunServerAddress

setStunServerAddress

public void setStunServerAddress(String stunServerAddress)

Parameters:

stunServerAddress - the stunServerAddress to set

getStunServerPort

public int getStunServerPort()

Returns:

the stunServerPort

setStunServerPort

public void setStunServerPort(int stunServerPort)

Parameters:

stunServerPort - the stunServerPort to set

isUseStun

public boolean isUseStun()

Returns:

the useStun

setUseStun

public void setUseStun(boolean useStun)

Parameters:

useStun - the useStun to set

getStaticServerAddress

public String getStaticServerAddress()

setStaticServerAddress

public void setStaticServerAddress(String staticServerAddress)

getStaticServerPort

public int getStaticServerPort()

setStaticServerPort

public void setStaticServerPort(int staticServerPort)

isUseStaticAddress

public boolean isUseStaticAddress()

setUseStaticAddress

public void setUseStaticAddress(boolean useStaticAddress)

isUseLoadBalancer

public boolean isUseLoadBalancer()

setUseLoadBalancer

public void setUseLoadBalancer(boolean useLoadBalancer)

isReplaceStaticServerAddressForInternalRoutingRequest

public boolean isReplaceStaticServerAddressForInternalRoutingRequest()

setReplaceStaticServerAddressForInternalRoutingRequest

public void setReplaceStaticServerAddressForInternalRoutingRequest(boolean value)

closeAllSockets

public void closeAllSockets()

Cleans up all cached TCP/TLS/SCTP sockets in case they are stalled. You should not call this method on UDP connector, it has no effect. After closing the sockets when needed new sockets will be created for the same dialog or transaction as required by the SIP specification.

sendHeartBeat

public void sendHeartBeat(String ipAddress,
                 int port)
                   throws Exception

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

Parameters:

ipAddress -

port -

Throws:

Exception

Since:

1.7

setKeepAliveTimeout

public boolean setKeepAliveTimeout(String ipAddress,
                          int port,
                          long timeout)
                            throws Exception

Allow to reset the RFC5626 Section 4.4.1 keeplive on a given TCP/TLS/SCTP connection

Parameters:

ipAddress -

port -

timeout -

Returns:

Throws:

Exception

Since:

1.7

closeReliableConnection

public boolean closeReliableConnection(String ipAddress,
                              int port)
                                throws Exception

Allow to close a given TCP/TLS/SCTP connection

Parameters:

ipAddress -

port -

Returns:

Throws:

Exception

Since:

1.7

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getHostNames

public String getHostNames()

Returns:

the hostNames

setHostNames

public void setHostNames(String hostNames)

Parameters:

hostNames - the hostNames to set

getLoadBalancerAddress

public String getLoadBalancerAddress()

Returns:

the loadBalancerAddress

setLoadBalancerAddress

public void setLoadBalancerAddress(String loadBalancerAddress)

Parameters:

loadBalancerAddress - the loadBalancerAddress to set

getLoadBalancerRmiPort

public int getLoadBalancerRmiPort()

Returns:

the loadBalancerRmiPort

setLoadBalancerRmiPort

public void setLoadBalancerRmiPort(int loadBalancerRmiPort)

Parameters:

loadBalancerRmiPort - the loadBalancerRmiPort to set

getLoadBalancerSipPort

public int getLoadBalancerSipPort()

Returns:

the loadBalancerSipPort

setLoadBalancerSipPort

public void setLoadBalancerSipPort(int loadBalancerSipPort)

Parameters:

loadBalancerSipPort - the loadBalancerSipPort to set

getLoadBalancerCustomInformation

public Properties getLoadBalancerCustomInformation()

Returns:

the loadBalancerCustomInformation

setLoadBalancerCustomInformation

public void setLoadBalancerCustomInformation(Properties loadBalancerCustomInformation)

Parameters:

loadBalancerCustomInformation - the loadBalancerCustomInformation to set