org.mobicents.servlet.sip.core

Class ExtendedListeningPoint

java.lang.Object

org.mobicents.servlet.sip.core.ExtendedListeningPoint

All Implemented Interfaces:

MobicentsExtendedListeningPoint

public class ExtendedListeningPoint
extends Object
implements MobicentsExtendedListeningPoint

Author:

Jean Deruelle

Constructor Summary

Constructors

Constructor and Description
ExtendedListeningPoint(javax.sip.SipProvider sipProvider, gov.nist.javax.sip.ListeningPointExt listeningPoint, SipConnector sipConnector)

Method Summary

Methods

Modifier and Type	Method and Description
javax.sip.header.ContactHeader	createContactHeader(String displayName, String userName, boolean usePublicAddress) Create a Contact Header based on the host, port and transport of this listening point
javax.sip.header.ContactHeader	createContactHeader(String displayName, String userName, boolean usePublicAddress, String outboundInterface) Create a Contact Header based on the host, port and transport of this listening point
javax.sip.address.SipURI	createRecordRouteURI(boolean usePublicAddress) Create a Record Route URI based on the host, port and transport of this listening point
javax.sip.header.ViaHeader	createViaHeader(String branch, boolean usePublicAddress) Create a Via Header based on the host, port and transport of this listening point
String	getGlobalIpAddress() Retrieve the global ip address of this listening point (found through STUN), null if no global ip address is asccoiated to it
int	getGlobalPort() Retrieve the global port of this listening point (found through STUN), -1 if no global port is asccoiated to it
String	getHost(boolean usePublicAddress) Retrieve either the global ip address found by STUN or the local network interface one depending on the boolean value in parameter
String	getIpAddress(boolean usePublicAddress)
List<String>	getIpAddresses() Return the list of real ip address represented by this listening point.
gov.nist.javax.sip.ListeningPointExt	getListeningPoint() Retrieve the jain sip listening point being extended by this class
int	getPort() Retrieve the port associated with this listening point
SipConnector	getSipConnector()
javax.sip.SipProvider	getSipProvider() Retrieve the sip provider associated to the jain sip listening point being extended by this class
String	getTransport() Retrieve the transport associated with this listening point
boolean	isAnyLocalAddress() return true if the ip address maps to 0.0.0.0.
boolean	isUseLoadBalancer()
boolean	isUseStaticAddress() If we are using a statically assigned IP address instead of our local address (for example when IP LB is used)
void	setGlobalIpAddress(String globalIpAddress) Set the global ip address (found through STUN) of this extended listening point
void	setGlobalPort(int globalPort) Set the global port (found through STUN) of this extended listening point
void	setPort(int port)
void	setSipConnector(SipConnector sipConnector)
void	setUseLoadBalancer(boolean useLoadBalancer)
void	setUseStaticAddress(boolean useStaticAddress) If we are using a statically assigned IP address instead of our local address (for example when IP LB is used)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedListeningPoint

public ExtendedListeningPoint(javax.sip.SipProvider sipProvider,
                      gov.nist.javax.sip.ListeningPointExt listeningPoint,
                      SipConnector sipConnector)

Method Detail

getIpAddress

public String getIpAddress(boolean usePublicAddress)

Specified by:

getIpAddress in interface MobicentsExtendedListeningPoint

createContactHeader

public javax.sip.header.ContactHeader createContactHeader(String displayName,
                                                 String userName,
                                                 boolean usePublicAddress)

Create a Contact Header based on the host, port and transport of this listening point

Specified by:

createContactHeader in interface MobicentsExtendedListeningPoint

Parameters:

usePublicAddress - if true, the host will be the global ip address found by STUN otherwise it will be the local network interface ipaddress

displayName - the display name to use

Returns:

the Contact header

createContactHeader

public javax.sip.header.ContactHeader createContactHeader(String displayName,
                                                 String userName,
                                                 boolean usePublicAddress,
                                                 String outboundInterface)

Create a Contact Header based on the host, port and transport of this listening point

Specified by:

createContactHeader in interface MobicentsExtendedListeningPoint

Parameters:

usePublicAddress - if true, the host will be the global ip address found by STUN otherwise it will be the local network interface ipaddress

displayName - the display name to use

outboundInterface - the outbound interface ip address to be used for the host part of the Contact header

Returns:

the Contact header

createViaHeader

public javax.sip.header.ViaHeader createViaHeader(String branch,
                                         boolean usePublicAddress)

Create a Via Header based on the host, port and transport of this listening point

Specified by:

createViaHeader in interface MobicentsExtendedListeningPoint

Parameters:

usePublicAddress - if true, the host will be the global ip address found by STUN otherwise it will be the local network interface ipaddress

branch - the branch id to use

Returns:

the via header

createRecordRouteURI

public javax.sip.address.SipURI createRecordRouteURI(boolean usePublicAddress)

Create a Record Route URI based on the host, port and transport of this listening point

Specified by:

createRecordRouteURI in interface MobicentsExtendedListeningPoint

Parameters:

usePublicAddress - if true, the host will be the global ip address found by STUN otherwise it will be the local network interface ipaddress

Returns:

the record route uri

getListeningPoint

public gov.nist.javax.sip.ListeningPointExt getListeningPoint()

Retrieve the jain sip listening point being extended by this class

Specified by:

getListeningPoint in interface MobicentsExtendedListeningPoint

Returns:

the jain sip listening point being extended by this class

getSipProvider

public javax.sip.SipProvider getSipProvider()

Retrieve the sip provider associated to the jain sip listening point being extended by this class

Specified by:

getSipProvider in interface MobicentsExtendedListeningPoint

Returns:

the sip provider associated to the jain sip listening point being extended by this class

getGlobalIpAddress

public String getGlobalIpAddress()

Retrieve the global ip address of this listening point (found through STUN), null if no global ip address is asccoiated to it

Specified by:

getGlobalIpAddress in interface MobicentsExtendedListeningPoint

Returns:

the global ip address of this listening point, null if no global ip address is asccoiated to it

getGlobalPort

public int getGlobalPort()

Retrieve the global port of this listening point (found through STUN), -1 if no global port is asccoiated to it

Specified by:

getGlobalPort in interface MobicentsExtendedListeningPoint

Returns:

the global port of this listening point, -1 if no global port is asccoiated to it

setGlobalIpAddress

public void setGlobalIpAddress(String globalIpAddress)

Set the global ip address (found through STUN) of this extended listening point

Parameters:

globalIpAddress - the global ip address of this listening point

setGlobalPort

public void setGlobalPort(int globalPort)

Set the global port (found through STUN) of this extended listening point

Parameters:

globalPort - the global port of this listening point

isUseStaticAddress

public boolean isUseStaticAddress()

If we are using a statically assigned IP address instead of our local address (for example when IP LB is used)

Specified by:

isUseStaticAddress in interface MobicentsExtendedListeningPoint

Returns:

setUseStaticAddress

public void setUseStaticAddress(boolean useStaticAddress)

If we are using a statically assigned IP address instead of our local address (for example when IP LB is used)

Parameters:

useStaticAddress -

toString

public String toString()

Overrides:

toString in class Object

getIpAddresses

public List<String> getIpAddresses()

Return the list of real ip address represented by this listening point. This can be many ip address because the listening point IP address could be 0.0.0.0

Specified by:

getIpAddresses in interface MobicentsExtendedListeningPoint

Returns:

the list of real ip address represented by this listening point.

getHost

public String getHost(boolean usePublicAddress)

Retrieve either the global ip address found by STUN or the local network interface one depending on the boolean value in parameter

Specified by:

getHost in interface MobicentsExtendedListeningPoint

Parameters:

true - means we want to retrieve the global ip address found by STUN

Returns:

Retrieve either the global ip address found by STUN or the local network interface one depending on the boolean value in parameter

getPort

public int getPort()

Retrieve the port associated with this listening point

Specified by:

getPort in interface MobicentsExtendedListeningPoint

Returns:

port associated with this listening point

setPort

public void setPort(int port)

getTransport

public String getTransport()

Retrieve the transport associated with this listening point

Specified by:

getTransport in interface MobicentsExtendedListeningPoint

Returns:

the transport associated with this listening point

isAnyLocalAddress

public boolean isAnyLocalAddress()

return true if the ip address maps to 0.0.0.0. If it's true call getIpAddresses ti get the real list of ip addresses it maps too

Specified by:

isAnyLocalAddress in interface MobicentsExtendedListeningPoint

Returns:

true if the ip adress is a any local address

setSipConnector

public void setSipConnector(SipConnector sipConnector)

Parameters:

sipConnector - the sipConnector to set

getSipConnector

public SipConnector getSipConnector()

Specified by:

getSipConnector in interface MobicentsExtendedListeningPoint

Returns:

the sipConnector

isUseLoadBalancer

public boolean isUseLoadBalancer()

Specified by:

isUseLoadBalancer in interface MobicentsExtendedListeningPoint

setUseLoadBalancer

public void setUseLoadBalancer(boolean useLoadBalancer)

Specified by:

setUseLoadBalancer in interface MobicentsExtendedListeningPoint