restcomm/sip-servlets

Leading SIP - IMS - WebRTC Application Server

Note

On 29 June 2023, Mobius Software LTD signed an agreement with Mavenir to assume development and support of the RestcommOne on prem products. For more details regarding open source / commercial differentiation, roadmap, licensing and other details please visit the Mobius Website.

RestComm Sip Servlets

RestComm SIP Servlets is a SIP, IMS and WebRTC Application Server. RestComm SIP Servlets facilitates the shift towards Cloud Communications by enabling deployment and autoscaling of real time SIP Servlets applications across all major IaaS (Infrastructure as a Service) providers or on premises. It also brings realtime communications (messaging, voice & video) to your Browser using HTML5 WebRTC and SIP Over WebSockets !

RestComm SIP Servlets enables turnkey SaaS offerings such as RestComm.

Check out the wiki for more information.

WebRTC Demo

The (RestComm HTML5 WebRTC Client)[HTML5WebRTCVideoApplication] allows you to make video calls from/to any Web Browser supporting [http://webrtc.org WebRTC], (only Google Chrome Firefox and Opera supports it so far but some plugins exists to enable it on IE and Safari).

Architecture

RestComm SIP Servlets implements the latest SIP Servlet v1.1 (JSR 289) standard. It can be plugged into any Application Server container (currently 7.X and JBoss 7.X) and also offers High Availability and Failover on its corresponding product from TeleStax, Inc.

sip-servlets's Issues

Not enough information in SipSession passed in SipSessionListener.sessionCreated(..)

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=36&colspec=ID%20Status%20MSS%20Summary

Log Time

Support for REGEX and DIRECTION in SIP Servlets Management console

See https://code.google.com/p/mobicents/issues/detail?id=2577

Log Time

Support for RFC 5627 : GRUU

Support for RFC 5627 : GRUU. https://tools.ietf.org/html/rfc5627 and an earlier version https://tools.ietf.org/html/draft-ietf-sip-gruu-10 to support Lync integration

Log Time

MSS HA on JBoss AS 7.x

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=62&colspec=ID%20Status%20MSS%20Summary

Log Time

SerializationException when Serializing SipSession

java.io.NotSerializableException: org.jboss.web.tomcat.service.session.sip.SessionBasedClusteredSipSession
at java.io.ObjectOutputStream.writeObject0(Unknown Source)
at java.io.ObjectOutputStream.writeObject(Unknown Source)
at java.util.HashMap.writeObject(Unknown Source)
at sun.reflect.GeneratedMethodAccessor258.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.lang.reflect.Method.invoke(Unknown Source)
at java.io.ObjectStreamClass.invokeWriteObject(Unknown Source)
at java.io.ObjectOutputStream.writeSerialData(Unknown Source)
at java.io.ObjectOutputStream.writeOrdinaryObject(Unknown Source)
at java.io.ObjectOutputStream.writeObject0(Unknown Source)
at java.io.ObjectOutputStream.writeObject(Unknown Source)
at java.util.HashMap.writeObject(Unknown Source)
at sun.reflect.GeneratedMethodAccessor258.invoke(Unknown Source)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
at java.lang.reflect.Method.invoke(Unknown Source)
at java.io.ObjectStreamClass.invokeWriteObject(Unknown Source)
at java.io.ObjectOutputStream.writeSerialData(Unknown Source)
at java.io.ObjectOutputStream.writeOrdinaryObject(Unknown Source)
at java.io.ObjectOutputStream.writeObject0(Unknown Source)
at java.io.ObjectOutputStream.writeObject(Unknown Source)
at org.jboss.ha.framework.server.SimpleCachableMarshalledValue.serialize(SimpleCachableMarshalledValue.java:271)
at org.jboss.ha.framework.server.SimpleCachableMarshalledValue.writeExternal(SimpleCachableMarshalledValue.java:252)
at java.io.ObjectOutputStream.writeExternalData(Unknown Source)
at java.io.ObjectOutputStream.writeOrdinaryObject(Unknown Source)
at java.io.ObjectOutputStream.writeObject0(Unknown Source)
at java.io.ObjectOutputStream.writeObject(Unknown Source)
at org.jboss.cache.marshall.CacheMarshaller200.marshallObject(CacheMarshaller200.java:460)
at org.jboss.cache.marshall.CacheMarshaller300.marshallObject(CacheMarshaller300.java:47)
at org.jboss.cache.marshall.CacheMarshaller200.marshallCommand(CacheMarshaller200.java:519)
at org.jboss.cache.marshall.CacheMarshaller200.marshallObject(CacheMarshaller200.java:314)
at org.jboss.cache.marshall.CacheMarshaller300.marshallObject(CacheMarshaller300.java:47)
at org.jboss.cache.marshall.CacheMarshaller200.marshallCollection(CacheMarshaller200.java:555)
at org.jboss.cache.marshall.CacheMarshaller200.marshallObject(CacheMarshaller200.java:365)
at org.jboss.cache.marshall.CacheMarshaller300.marshallObject(CacheMarshaller300.java:47)
at org.jboss.cache.marshall.CacheMarshaller200.marshallCommand(CacheMarshaller200.java:519)
at org.jboss.cache.marshall.CacheMarshaller200.marshallObject(CacheMarshaller200.java:314)
at org.jboss.cache.marshall.CacheMarshaller300.marshallObject(CacheMarshaller300.java:47)
at org.jboss.cache.marshall.CacheMarshaller200.marshallCommand(CacheMarshaller200.java:519)
at org.jboss.cache.marshall.CacheMarshaller200.marshallObject(CacheMarshaller200.java:314)
at org.jboss.cache.marshall.CacheMarshaller300.marshallObject(CacheMarshaller300.java:47)
at org.jboss.cache.marshall.CacheMarshaller200.objectToObjectStream(CacheMarshaller200.java:191)
at org.jboss.cache.marshall.CacheMarshaller200.objectToObjectStream(CacheMarshaller200.java:136)
at org.jboss.cache.marshall.VersionAwareMarshaller.objectToBuffer(VersionAwareMarshaller.java:182)
at org.jboss.cache.marshall.VersionAwareMarshaller.objectToBuffer(VersionAwareMarshaller.java:52)
at org.jboss.cache.marshall.CommandAwareRpcDispatcher$ReplicationTask.call(CommandAwareRpcDispatcher.java:369)
at org.jboss.cache.marshall.CommandAwareRpcDispatcher$ReplicationTask.call(CommandAwareRpcDispatcher.java:341)
at org.jboss.cache.util.concurrent.WithinThreadExecutor.submit(WithinThreadExecutor.java:82)
at org.jboss.cache.marshall.CommandAwareRpcDispatcher.invokeRemoteCommands(CommandAwareRpcDispatcher.java:206)
at org.jboss.cache.RPCManagerImpl.callRemoteMethods(RPCManagerImpl.java:748)
at org.jboss.cache.RPCManagerImpl.callRemoteMethods(RPCManagerImpl.java:716)
at org.jboss.cache.RPCManagerImpl.callRemoteMethods(RPCManagerImpl.java:721)
at org.jboss.cache.interceptors.BaseRpcInterceptor.replicateCall(BaseRpcInterceptor.java:161)
at org.jboss.cache.interceptors.BaseRpcInterceptor.replicateCall(BaseRpcInterceptor.java:135)
at org.jboss.cache.interceptors.BaseRpcInterceptor.replicateCall(BaseRpcInterceptor.java:107)
at org.jboss.cache.interceptors.ReplicationInterceptor.runPreparePhase(ReplicationInterceptor.java:192)
at org.jboss.cache.interceptors.ReplicationInterceptor.visitPrepareCommand(ReplicationInterceptor.java:72)
at org.jboss.cache.commands.tx.PrepareCommand.acceptVisitor(PrepareCommand.java:68)
at org.jboss.cache.interceptors.base.CommandInterceptor.invokeNextInterceptor(CommandInterceptor.java:116)
at org.jboss.cache.interceptors.NotificationInterceptor.visitPrepareCommand(NotificationInterceptor.java:50)
at org.jboss.cache.commands.tx.PrepareCommand.acceptVisitor(PrepareCommand.java:68)
at org.jboss.cache.interceptors.base.CommandInterceptor.invokeNextInterceptor(CommandInterceptor.java:116)
at org.jboss.cache.interceptors.TxInterceptor.handleCommitRollback(TxInterceptor.java:539)
at org.jboss.cache.interceptors.TxInterceptor.runCommitPhase(TxInterceptor.java:572)
at org.jboss.cache.interceptors.TxInterceptor$RemoteSynchronizationHandler.afterCompletion(TxInterceptor.java:969)
at org.jboss.cache.interceptors.TxInterceptor$LocalSynchronizationHandler.afterCompletion(TxInterceptor.java:1156)
at org.jboss.cache.interceptors.OrderedSynchronizationHandler.afterCompletion(OrderedSynchronizationHandler.java:92)
at org.jboss.cache.transaction.DummyTransaction.notifyAfterCompletion(DummyTransaction.java:307)
at org.jboss.cache.transaction.DummyTransaction.commit(DummyTransaction.java:96)
at org.jboss.cache.transaction.DummyBaseTransactionManager.commit(DummyBaseTransactionManager.java:109)
at org.jboss.web.tomcat.service.session.distributedcache.impl.jbc.BatchingManagerImpl.endBatch(BatchingManagerImpl.java:70)
at org.mobicents.servlet.sip.startup.SipStandardContext.endBatchTransaction(SipStandardContext.java:1207)
at org.mobicents.servlet.sip.startup.SipStandardContext.exitSipAppHa(SipStandardContext.java:1167)
at org.mobicents.servlet.sip.core.dispatchers.ResponseDispatcher$1.dispatch(ResponseDispatcher.java:503)
at org.mobicents.servlet.sip.core.dispatchers.DispatchTask.dispatchAndHandleExceptions(DispatchTask.java:61)
at org.mobicents.servlet.sip.core.dispatchers.ResponseDispatcher.dispatchMessage(ResponseDispatcher.java:514)
at org.mobicents.servlet.sip.core.SipApplicationDispatcherImpl.processResponse(SipApplicationDispatcherImpl.java:1021)
at gov.nist.javax.sip.EventScanner.deliverEvent(EventScanner.java:296)
at gov.nist.javax.sip.SipProviderImpl.handleEvent(SipProviderImpl.java:185)
at gov.nist.javax.sip.DialogFilter.processResponse(DialogFilter.java:1511)
at gov.nist.javax.sip.stack.SIPClientTransaction.inviteClientTransaction(SIPClientTransaction.java:922)
at gov.nist.javax.sip.stack.SIPClientTransaction.processResponse(SIPClientTransaction.java:548)
at gov.nist.javax.sip.stack.SIPClientTransaction.processResponse(SIPClientTransaction.java:1599)
at gov.nist.javax.sip.stack.UDPMessageChannel.processMessage(UDPMessageChannel.java:602)
at gov.nist.javax.sip.stack.UDPMessageChannel.processIncomingDataPacket(UDPMessageChannel.java:511)
at gov.nist.javax.sip.stack.UDPMessageChannel.run(UDPMessageChannel.java:316)
at java.lang.Thread.run(Unknown Source)
2015-01-12 11:51:54,874 ERROR org.jboss.cache.marshall.CommandAwareRpcDispatcher java.io.NotSerializableException: org.jboss.web.tomcat.service.session.sip.SessionBasedClusteredSipSession

Log Time

Security domain in ear

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=241&colspec=ID%20Status%20MSS%20Summary

Log Time

HA Independent Layer

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=66&colspec=ID%20Status%20MSS%20Summary

Log Time

Event header is modified by B2buaHelper for NOTIFY requests

See https://code.google.com/p/sipservlets/issues/detail?id=270

Log Time

RFC-3455 Private Header (P-Header) Extensions badly parsed when contain # or " character

See https://code.google.com/p/mobicents/issues/detail?id=2907

Log Time

Support for hot deployment of Application Router

Support for hot deployment of Application Router

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=6&colspec=ID%20Status%20MSS%20Summary

Log Time

Subscription-State header should be parameterable

RFC 3265 states that the "Subscription-State" header SHOULD contain a "reason=timeout" parameter.. so the Subscription-State should be parameterable.

Log Time

URL decoding on Contact header feature parameters

See https://code.google.com/p/sipservlets/issues/detail?id=258

Log Time

Add Tomcat 8 Support

Add Support for Tomcat 8

Log Time

Integrate Screen Sharing to WebRTC example

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=214&colspec=ID%20Status%20MSS%20Summary

Log Time

Impossible to set Multiple Connectors with same Transport on AS7

trying to create first-sip-udp and second-sip-udp on socket-binding doesn't work in AS7

Log Time

Fallback to second DNS Record is not even attempted in event of TCP Connection failure

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=250&colspec=ID%20Status%20MSS%20Summary

Log Time

JAIN SIP does not identifies NAT in some cases

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=30&colspec=ID%20Status%20MSS%20Summary

Log Time

Ability to specify only a package/set of packages to scan for SIP annotations

Find a way to specify the path/package where to scan for SIP annotations. Currently all the classes are scanned which is far from optimal.
Also having a way to disable this completely would be nice.

Log Time

@SipApplicationKey fails on Tomcat if not defined on the servlet class

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=139&colspec=ID%20Status%20MSS%20Summary

Log Time

Proxy implementation not forwarding additional 2xx responses from downstream fork (again)

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=154&colspec=ID%20Status%20MSS%20Summary

Log Time

RFC 5057: 491 Request Pending on sending REFER

See https://code.google.com/p/mobicents/issues/detail?id=1512

Log Time

B2buaHelper.createResponseToOriginalRequest() does not set different To tag to created response.

https://code.google.com/p/mobicents/issues/detail?id=2354

Log Time

RFC 5393 : Addressing and Amplification Vulnerability in Session Initiation Protocol (SIP) Forking Proxies

See https://code.google.com/p/mobicents/issues/detail?id=2348

Log Time

DataGrid Integration

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=67&colspec=ID%20Status%20MSS%20Summary

Log Time

SipURI.setParameter("key", null) results in NPE

Using uri.setParameter("orig", null); in RestComm results in following exception

ERROR RestComm-akka.actor.default-dispatcher-5 akka.event.slf4j.Slf4jEventHandler$$anonfun$receive$1$$anonfun$applyOrElse$1.apply$mcV$sp(Slf4jEventHandler.scala:64) - java.lang.NullPointerException
org.mobicents.servlet.restcomm.fsm.TransitionFailedException: java.lang.NullPointerException
at org.mobicents.servlet.restcomm.fsm.FiniteStateMachine.transition(FiniteStateMachine.java:85)
at org.mobicents.servlet.restcomm.telephony.Call.onReceive(Call.java:568)
at akka.actor.UntypedActor$$anonfun$receive$1.applyOrElse(UntypedActor.scala:159)
at akka.actor.ActorCell.receiveMessage(ActorCell.scala:425)
at akka.actor.ActorCell.invoke(ActorCell.scala:386)
at akka.dispatch.Mailbox.processMailbox(Mailbox.scala:230)
at akka.dispatch.Mailbox.run(Mailbox.scala:212)
at akka.dispatch.ForkJoinExecutorConfigurator$MailboxExecutionTask.exec(AbstractDispatcher.scala:506)
at scala.concurrent.forkjoin.ForkJoinTask.doExec(ForkJoinTask.java:262)
at scala.concurrent.forkjoin.ForkJoinPool$WorkQueue.runTask(ForkJoinPool.java:975)
at scala.concurrent.forkjoin.ForkJoinPool.runWorker(ForkJoinPool.java:1478)
at scala.concurrent.forkjoin.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:104)
Caused by: java.lang.NullPointerException
at org.mobicents.servlet.sip.address.RFC2396UrlDecoder.encode(RFC2396UrlDecoder.java:74)
at org.mobicents.servlet.sip.address.SipURIImpl.setParameter(SipURIImpl.java:410)
at org.mobicents.servlet.restcomm.telephony.Call$Dialing.execute(Call.java:1037)
at org.mobicents.servlet.restcomm.fsm.FiniteStateMachine.transition(FiniteStateMachine.java:83)
... 11 more

Log Time

Application Composition broken for REGISTER

The SIP container seems to treat REGISTER requests differently after a B2BUA application sends a request on the outgoing leg, not invoking the AR as it should and does for other methods.
Based on the Mobicents code (which presumably is identical) there seems to be a conscious decision to not continue the application chain for REGISTER. Would be interesting to know the reason for this?
In SipServletRequestImpl.send(Hop):
//Added for initial requests only (that are not REGISTER) not for subsequent requests
if(isInitial() && !Request.REGISTER.equalsIgnoreCase(requestMethod)) {
final SipApplicationRouterInfo routerInfo = sipFactoryImpl.getNextInterestedApplication(this);

The result of this is that application composition using the AR becomes impossible for REGISTER.

See https://telestax.atlassian.net/browse/MSS-124

Log Time

EJBAccessException

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=240&colspec=ID%20Status%20MSS%20Summary

Log Time

Contact Header for SIP MESSAGE requests

We know that this is against the SIP MESSAGE RFC (3428):

1. UAC Processing

...
MESSAGE requests do not initiate dialogs. User Agents MUST NOT
insert Contact header fields into MESSAGE requests.
...

However, we need to do it for RCS implementation. They force you to insert the +sip.instance parameter in all outcoming requests and responses.

Log Time

NullPointerException if the approuter returns a subscriberUri is null

It is legal for an app router to return a null subscriberURI when the region is neither orig nor term. The InitialRequestDispatcher.java fails in these cases.

See https://telestax.atlassian.net/browse/MSS-135

Log Time

SIP Servlets 2.0 - JSR 359 Implementation

Create issues based on the lecture of the new spec

Log Time

One BYE kill several sip sessions

See https://code.google.com/p/mobicents/issues/detail?id=2968

Log Time

RFC 5658 : Implement Double Record Routing in Proxy

See https://code.google.com/p/sipservlets/issues/detail?id=17

Log Time

RFC 6357 : SIP Overload Control

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=53&colspec=ID%20Status%20MSS%20Summary

Log Time

Integrate Olympus WebRTC app by default

Integrate https://github.com/Mobicents/olympus/

Log Time

Integrate new jDiameter release

Integrate the new 1.6.0.FINAL release out of the box

Log Time

RFC 6026 Correct Transaction Handling for 2xx Responses to INVITE Requests

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=64&colspec=ID%20Status%20MSS%20Summary

Log Time

SipMessage.getInitialRemoteAddress() was not returning null on outgoing re-REGISTER transactions

SipMessage.getInitialRemoteAddress() was not returning null on outgoing re-REGISTER transactions. JSR 289 15.7 specifies that it must be null on all outbound requests. In the attached changes, I was a bit chicken and just fixed this for REGISTER requests, but this may be more general an true for other "//case where other requests are sent with the same session like REGISTER or for challenge requests"

Log Time

RFC 4320 Issues with the Non-INVITE Transaction

Original issue URL from Google Code:
https://code.google.com/p/sipservlets/issues/detail?id=63&colspec=ID%20Status%20MSS%20Summary

Log Time

JBoss AS/WildFly 8 Support

Add Support for JBoss AS/WildFly 8

Log Time

Memory leaks in Mobicents Sip stack

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=271&colspec=ID%20Status%20MSS%20Summary

Log Time

Improve TLSMessageChannel Extensibility

https://code.google.com/p/mobicents/issues/detail?id=2637

Log Time

Interfacing to Lync Edge Servers fails because combination from tag, to tag, and call id is too long

Lync Edge Servers reject requests from Mobicents because Lync concatenates the from tag, to tag and call id into a session_id and the session_id is limited in length. Lync's limits are 32 characters for the call id and 10 characters for the tags.

https://telestax.atlassian.net/browse/MSS-137

Log Time

Mobicents does not handle doAck properly when security is enabled

See https://code.google.com/p/sipservlets/issues/detail?id=247

Log Time

Have a new REGEX option in DAR for a specific header only

https://code.google.com/p/mobicents/issues/detail?id=2357

Log Time

Don't require registration for establishing SIP Over WebSockets Flow

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=173&colspec=ID%20Status%20MSS%20Summary

Log Time

BYE sent to derived sip session unlink all sessions

See https://code.google.com/p/mobicents/issues/detail?id=2971

Log Time

SIP application does not get deployed if a <Context> tag is defined in server.xml

In a converged application, SIP application does not get deployed if a <Context> tag is defined in server.xml (Tomcat 7).

This is pretty important for development, as Eclipse automatically includes that tag.

Log Time

Derived Sessions not available in the list of Sessions from SipApplicationSession

Mutliple problems are occuring here :

1. It seems for some reason the id of the session is changed before it's passed on to the application, I suspect there is a bug in the HA case with proxy forking on the id or loading of the session
2. After creation of this derived session, I still only have the 2 first sipSessions in the SipApplicationSession (the sipSession for the received INVITE and the sipSession created for the forwarded INVITE)
3. When the BYE for the 2nd 200OK is send, it looks like other derived sipsession are invalidated...
   IE: When the established call is ended (by the caller), I receive the BYE (coresponding to the 1st 200 OK), but when I list the sipsession still present in the SipApplicationSession, I only have the sipSession of the caller. Other sipsessions are not more present, even the one for the callee.

Log Time

When using 0.0.0.0 as an IP Address for the SIP Connectors, websockets-sip-servlets with firefox cannot complete the call

Original issue URL from Google Code:

https://code.google.com/p/sipservlets/issues/detail?id=228&colspec=ID%20Status%20MSS%20Summary

Log Time

SipServletMessage.addHeader handles transport badly

See https://code.google.com/p/sipservlets/issues/detail?id=268

Log Time