gov.nist.javax.sip

Class ListeningPointImpl

java.lang.Object

gov.nist.javax.sip.ListeningPointImpl

All Implemented Interfaces:

ListeningPointExt, Serializable, Cloneable, ListeningPoint

public class ListeningPointImpl
extends Object
implements ListeningPoint, ListeningPointExt

Implementation of the ListeningPoint interface

Version:

1.2 $Revision: 1.18 $ $Date: 2010-12-02 22:04:18 $

Author:

M. Ranganathan

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected MessageProcessor	messageProcessor Pointer to the imbedded mesage processor.
protected SipProviderImpl	sipProvider Provider back pointer
protected SipStackImpl	sipStack Our stack
protected String	transport

Fields inherited from interface gov.nist.javax.sip.ListeningPointExt

WS, WSS

Fields inherited from interface javax.sip.ListeningPoint

PORT_5060, PORT_5061, SCTP, TCP, TLS, UDP

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ListeningPointImpl(SipStack sipStack, int port, String transport) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone() Clone this listening point.
ContactHeader	createContactHeader() Create a contact for this listening point.
ViaHeader	createViaHeader() Create a Via header for this listening point.
String	getIPAddress() Gets the IP of the ListeningPoint.
protected String	getKey() Get the key for this strucut
MessageProcessor	getMessageProcessor()
int	getPort() Gets the port of the ListeningPoint.
SipProviderImpl	getProvider() Get the provider.
String	getSentBy() Gets the sentBy attribute of the ListeningPoint.
String	getTransport() Gets transport of the ListeningPoint.
Via	getViaHeader()
boolean	isSentBySet()
static String	makeKey(String host, int port, String transport) Construct a key to refer to this structure from the SIP stack
void	removeSipProvider() Remove the sip provider from this listening point.
void	sendHeartbeat(String ipAddress, int port) Send a heartbeat to the specified Ip address and port via this listening point.
void	setSentBy(String sentBy) Sets the sentBy string for this ListeningPoint.
void	setSipProvider(SipProviderImpl sipProviderImpl) Set the sip provider for this structure.

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sip.ListeningPoint

equals

Field Detail

transport

protected String transport

messageProcessor

protected MessageProcessor messageProcessor

Pointer to the imbedded mesage processor.

sipProvider

protected SipProviderImpl sipProvider

Provider back pointer

sipStack

protected SipStackImpl sipStack

Our stack

Constructor Detail

ListeningPointImpl

protected ListeningPointImpl(SipStack sipStack,
                  int port,
                  String transport)

Constructor

Parameters:

sipStack - Our sip stack

Method Detail

makeKey

public static String makeKey(String host,
             int port,
             String transport)

Construct a key to refer to this structure from the SIP stack

Parameters:

host - host string

port - port

transport - transport

Returns:

a string that is used as a key

getKey

protected String getKey()

Get the key for this strucut

Returns:

get the host

setSipProvider

public void setSipProvider(SipProviderImpl sipProviderImpl)

Set the sip provider for this structure.

Parameters:

sipProvider - provider to set

removeSipProvider

public void removeSipProvider()

Remove the sip provider from this listening point.

clone

public Object clone()

Clone this listening point. Note that a message Processor is not started. The transport is set to null.

Overrides:

clone in class Object

Returns:

cloned listening point.

getPort

public int getPort()

Gets the port of the ListeningPoint. The default port of a ListeningPoint is dependent on the scheme and transport. For example:

• The default port is 5060 if the transport UDP the scheme is sip:.
• The default port is 5060 if the transport is TCP the scheme is sip:.
• The default port is 5060 if the transport is SCTP the scheme is sip:.
• The default port is 5061 if the transport is TLS over TCP the scheme is sip:.
• The default port is 5061 if the transport is TCP the scheme is sips:.

Specified by:

getPort in interface ListeningPoint

Returns:

port of ListeningPoint

getTransport

public String getTransport()

Gets transport of the ListeningPoint.

Specified by:

getTransport in interface ListeningPoint

Returns:

transport of ListeningPoint

getProvider

public SipProviderImpl getProvider()

Get the provider.

Returns:

the provider.

getIPAddress

public String getIPAddress()

Description copied from interface: ListeningPoint

Gets the IP of the ListeningPoint.

Specified by:

getIPAddress in interface ListeningPoint

Returns:

the string value of the IP address.

setSentBy

public void setSentBy(String sentBy)
               throws ParseException

Description copied from interface: ListeningPoint

Sets the sentBy string for this ListeningPoint. The sentBy String is placed in the top most Via header of outgoing requests. This parameter is optional and if it is not set, the top most Via header will use the IP address and port assigned to the listening point for the sentBy field.

Specified by:

setSentBy in interface ListeningPoint

Parameters:

sentBy - the sentBy string to be set in requests top most Via headers.

Throws:

ParseException - which signals that an error has been reached unexpectedly while parsing the sentBy value.

getSentBy

public String getSentBy()

Description copied from interface: ListeningPoint

Gets the sentBy attribute of the ListeningPoint.

Specified by:

getSentBy in interface ListeningPoint

Returns:

the string value of the sentBy attribute.

isSentBySet

public boolean isSentBySet()

getViaHeader

public Via getViaHeader()

getMessageProcessor

public MessageProcessor getMessageProcessor()

createContactHeader

public ContactHeader createContactHeader()

Description copied from interface: ListeningPointExt

Create a contact for this listening point.

Specified by:

createContactHeader in interface ListeningPointExt

Returns:

a contact header corresponding to this listening point.

sendHeartbeat

public void sendHeartbeat(String ipAddress,
                 int port)
                   throws IOException

Description copied from interface: ListeningPointExt

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.

Specified by:

sendHeartbeat in interface ListeningPointExt

Throws:

IOException

createViaHeader

public ViaHeader createViaHeader()

Description copied from interface: ListeningPointExt

Create a Via header for this listening point.

Specified by:

createViaHeader in interface ListeningPointExt

Returns:

a via header corresponding to this listening point. Branch ID is set to NULL.