org.mobicents.servlet.sip.startup
Class SipProtocolHandler

java.lang.Object
  org.mobicents.servlet.sip.startup.SipProtocolHandler

All Implemented Interfaces:

javax.management.MBeanRegistration, org.apache.coyote.ProtocolHandler

public class SipProtocolHandler
extends java.lang.Object
implements org.apache.coyote.ProtocolHandler, javax.management.MBeanRegistration

This is the sip protocol handler that will get called upon creation of the tomcat connector defined in the server.xml.
To use a sip connector, one need to specify a new connector in server.xml with org.mobicents.servlet.sip.startup.SipProtocolHandler as the value for the protocol attribute.
Some of the fields (representing the sip stack propeties) get populated automatically by the container.

Author:

Jean Deruelle

Field Summary

protected java.lang.String	domain
ExtendedListeningPoint	extendedListeningPoint
static java.lang.String	IS_SIP_CONNECTOR
protected javax.management.MBeanServer	mserver
protected javax.management.ObjectName	oname
protected javax.management.ObjectName	rgOname
protected javax.management.ObjectName	tpOname

Constructor Summary

SipProtocolHandler()

SipProtocolHandler(SipConnector connector)

Method Summary

void	destroy()
org.apache.coyote.Adapter	getAdapter()
java.net.InetAddress	getAddress()
java.lang.Object	getAttribute(java.lang.String attribute)
java.util.Iterator	getAttributeNames()
java.lang.String	getDomain()
java.lang.String	getIpAddress()
java.lang.String	getName()
javax.management.ObjectName	getObjectName()
int	getPort()
static int	getRandomPortNumber(int min, int max) Returns a random local port number, greater than min and lower than max.
java.lang.String	getSignalingTransport()
SipConnector	getSipConnector()
java.util.Properties	getSipStackProperties()
java.lang.String	getStaticServerAddress()
int	getStaticServerPort()
java.lang.String	getStunServerAddress()
int	getStunServerPort()
java.lang.String	getTransport()
void	init()
boolean	isStarted()
boolean	isUseStaticAddress()
boolean	isUseStun()
void	pause()
void	postDeregister()
void	postRegister(java.lang.Boolean registrationDone)
void	preDeregister()
javax.management.ObjectName	preRegister(javax.management.MBeanServer server, javax.management.ObjectName name)
void	resume()
void	setAdapter(org.apache.coyote.Adapter adapter)
void	setAddress(java.net.InetAddress ia)
void	setAttribute(java.lang.String arg0, java.lang.Object arg1)
void	setIpAddress(java.lang.String ipAddress)
void	setPort(int port)
void	setSignalingTransport(java.lang.String transport)
void	setSipConnector(SipConnector sipConnector)
void	setSipStack(javax.sip.SipStack sipStack)
void	setSipStackProperties(java.util.Properties sipStackProperties)
void	setStarted(boolean started)
void	setStaticServerAddress(java.lang.String staticServerAddress)
void	setStaticServerPort(int staticServerPort)
void	setStunServerAddress(java.lang.String stunServerAddress)
void	setStunServerPort(int stunServerPort)
void	setUseStaticAddress(boolean useStaticAddress)
void	setUseStun(boolean useStun)
void	start()

Methods inherited from class java.lang.Object

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

Field Detail

IS_SIP_CONNECTOR

public static final java.lang.String IS_SIP_CONNECTOR

See Also:

Constant Field Values

tpOname

protected javax.management.ObjectName tpOname

rgOname

protected javax.management.ObjectName rgOname

extendedListeningPoint

public ExtendedListeningPoint extendedListeningPoint

domain

protected java.lang.String domain

oname

protected javax.management.ObjectName oname

mserver

protected javax.management.MBeanServer mserver

Constructor Detail

SipProtocolHandler

public SipProtocolHandler()

SipProtocolHandler

public SipProtocolHandler(SipConnector connector)

Method Detail

destroy

public void destroy()
             throws java.lang.Exception

Specified by:

destroy in interface org.apache.coyote.ProtocolHandler

Throws:

java.lang.Exception

getAdapter

public org.apache.coyote.Adapter getAdapter()

Specified by:

getAdapter in interface org.apache.coyote.ProtocolHandler

getAttribute

public java.lang.Object getAttribute(java.lang.String attribute)

Specified by:

getAttribute in interface org.apache.coyote.ProtocolHandler

getAttributeNames

public java.util.Iterator getAttributeNames()

Specified by:

getAttributeNames in interface org.apache.coyote.ProtocolHandler

init

public void init()
          throws java.lang.Exception

Specified by:

init in interface org.apache.coyote.ProtocolHandler

Throws:

java.lang.Exception

pause

public void pause()
           throws java.lang.Exception

Specified by:

pause in interface org.apache.coyote.ProtocolHandler

Throws:

java.lang.Exception

resume

public void resume()
            throws java.lang.Exception

Specified by:

resume in interface org.apache.coyote.ProtocolHandler

Throws:

java.lang.Exception

setAdapter

public void setAdapter(org.apache.coyote.Adapter adapter)

Specified by:

setAdapter in interface org.apache.coyote.ProtocolHandler

setAttribute

public void setAttribute(java.lang.String arg0,
                         java.lang.Object arg1)

Specified by:

setAttribute in interface org.apache.coyote.ProtocolHandler

start

public void start()
           throws java.lang.Exception

Specified by:

start in interface org.apache.coyote.ProtocolHandler

Throws:

java.lang.Exception

getRandomPortNumber

public static int getRandomPortNumber(int min,
                                      int max)

Returns a random local port number, greater than min and lower than max.

Parameters:

min - the minimum allowed value for the returned port number.

max - the maximum allowed value for the returned port number.

Returns:

a random int located between greater than min and lower than max.

getSignalingTransport

public java.lang.String getSignalingTransport()

Returns:

the signalingTransport

setSignalingTransport

public void setSignalingTransport(java.lang.String transport)
                           throws java.lang.Exception

Parameters:

signalingTransport - the signalingTransport to set

Throws:

java.lang.Exception

getPort

public int getPort()

Returns:

the port

setPort

public void setPort(int port)
             throws java.lang.Exception

Parameters:

port - the port to set

Throws:

java.lang.Exception

setIpAddress

public void setIpAddress(java.lang.String ipAddress)
                  throws java.lang.Exception

Throws:

java.lang.Exception

getIpAddress

public java.lang.String getIpAddress()

getStunServerAddress

public java.lang.String getStunServerAddress()

Returns:

the stunServerAddress

setStunServerAddress

public void setStunServerAddress(java.lang.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 java.lang.String getStaticServerAddress()

setStaticServerAddress

public void setStaticServerAddress(java.lang.String staticServerAddress)

getStaticServerPort

public int getStaticServerPort()

setStaticServerPort

public void setStaticServerPort(int staticServerPort)

isUseStaticAddress

public boolean isUseStaticAddress()

setUseStaticAddress

public void setUseStaticAddress(boolean useStaticAddress)

getAddress

public java.net.InetAddress getAddress()

setAddress

public void setAddress(java.net.InetAddress ia)

getTransport

public java.lang.String getTransport()

getSipStackProperties

public java.util.Properties getSipStackProperties()

Returns:

the sipStackProperties

setSipStackProperties

public void setSipStackProperties(java.util.Properties sipStackProperties)

Parameters:

sipStackProperties - the sipStackProperties to set

setSipConnector

public void setSipConnector(SipConnector sipConnector)

Parameters:

sipConnector - the sipConnector to set

getSipConnector

public SipConnector getSipConnector()

Returns:

the sipConnector

getName

public java.lang.String getName()

getObjectName

public javax.management.ObjectName getObjectName()

getDomain

public java.lang.String getDomain()

preRegister

public javax.management.ObjectName preRegister(javax.management.MBeanServer server,
                                               javax.management.ObjectName name)
                                        throws java.lang.Exception

Specified by:

preRegister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postRegister

public void postRegister(java.lang.Boolean registrationDone)

Specified by:

postRegister in interface javax.management.MBeanRegistration

preDeregister

public void preDeregister()
                   throws java.lang.Exception

Specified by:

preDeregister in interface javax.management.MBeanRegistration

Throws:

java.lang.Exception

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface javax.management.MBeanRegistration

setStarted

public void setStarted(boolean started)

Parameters:

started - the started to set

isStarted

public boolean isStarted()

Returns:

the started

setSipStack

public void setSipStack(javax.sip.SipStack sipStack)