在本例中，用于处理传入消息的最重要的方法显然是processRequest()和processResponse()。接下来是存储稍后需要的对象的两个字段：username和messageProcessor，这些与SIP API没有直接关系，但是在本例中需要它们。第一个是前面讨论过的MessageProcessor对象，用于回调方法将消息发回给GUI，username用于随时保留用户名，这两个字段有getter和setter方法。

接下来是构造函数，一种启动JAIN SIP API的经典方法——建立一堆以后会有用的对象（工厂和SIP协议栈实例），TextClient就是采用的这种方法。


SipFactory用于实例化SipStack实现，但由于可能有多个实现，因此必须通过setPathName()方法命名您想要的那个实现。名称“gov.nist”表示您获得的SIP堆栈。


SipStack对象具有许多属性。至少，您必须设置堆栈名称。所有其他属性都是可选的。在这里，我设置了一个由堆栈使用的IP地址，用于一台计算机有多个IP地址的情况。注意，这里有标准属性(所有SIP API实现都必须支持)和非标准属性(依赖于实现)。

下一步是创建一对ListeningPoint和SipProvider对象。这些对象提供了发送和接收消息的通信功能。TCP有一组，UDP有一组。这也是你选择SipLayer作为传入SIP消息的监听器的地方:

构造函数就是这样结束的。您已经使用JAIN SIP API创建了一个SipStack实例、一堆工厂、两个listeningpoint和一个SipProvider。这些对象将在接下来的方法中用于发送和接收消息。

发送SIP请求

现在让我们编写一个使用JAIN SIP API发送SIP消息的方法，在此之前你必须非常了解SIP协议。SIP API是相当低级的抽象，在大多数情况下，不使用默认值或隐藏头、请求uri或SIP消息的内容。这种设计的优点是您可以完全控制SIP消息所包含的内容。

发送一个SIP请求大致分为四个部分：

• 创建主要元素

• 创建消息

• 完整的消息

• 发送消息

使用JAIN SIP API构造消息最少需要以下主要SIP元素：

• 请求URI

• 方法

• 通话身份头

• CSeq头

• 从标题

• Via报头数组

• Max-forwards头

下面的代码片段创建了所有这些元素:

我使用在构造函数HeaderFactory和AddressFactory中创建的工厂来实例化这些元素。接下来让我们实例化实际的SIP消息本身，传入之前创建的所有元素:

注意，这一步使用了MessageFactory。然后，让我们向消息添加其他元素:联系人标头和消息的内容(有效负载)，也可以添加自定义标题。


最后，使用SipProvider实例发送消息:

发送会话消息

你在会话外发送我们的信息，这意味着消息之间没有关联，这对于TextClient这样的简单即时消息传递应用程序来说效果很好。另一种方法是使用INVITE消息创建一个会话，然后在该会话内发送消息。TextClient不使用这种技术，但是是值得学习的东西，本小节描述了如何做到这一点。

在会话中发送消息需要创建Dialog和Transaction对象。在初始消息(即创建会话的消息)上，不使用提供程序发送消息，而是实例化一个Transaction，然后从中获取Dialog。您保留Dialog引用以供以后使用。然后使用事务发送消息:

稍后，当您希望在同一个会话中发送新消息时，您可以使用前面的Dialog对象来创建一个新请求。然后，您可以对请求进行消息处理，最后，使用Transaction发送消息。

从本质上讲，在现有会话中发送消息时，您跳过了“创建主要元素”步骤。当您使用INVITE创建对话框时，不要忘记在对话框结束时发送一个BYE消息来清理它。此技术还用于刷新注册和订阅。

在前面，您已经看到了SipListener接口，其中包含processDialogTerminated()和processTransactionTerminated()方法。它们分别在对话框和事务结束时自动调用。通常，实现这些方法是为了清理(例如，丢弃Dialog和Transaction实例)。您将把这两个方法留空，因为在TextClient中不需要它们。

接收SIP响应

前面，您注册了传入消息的监听器。监听器接口SipListener包含方法processResponse()，当SIP响应消息到达时，由SIP协议栈调用该方法。processResponse()接受一个ResponseEvent类型的参数，它封装了一个Response对象。

在此方法中，您将检查先前MESSAGE消息的响应是否表示成功(2xx范围的状态码)或错误(否则)。然后通过回调接口将此信息转发给用户。


通常，您只读取processResponse()方法中的Response对象。唯一的例外是对INVITE消息的成功响应;在这种情况下，你必须发送一个ACK请求，就像这样:

接收SIP请求

接收SIP请求消息与接收响应一样简单。您只需实现SipListener接口的另一个方法processRequest()， SIP堆栈将自动调用它。该方法的唯一参数是RequestEvent对象，其中包含Request对象。这是你之前见过的相同类型，它有相同的方法。但是，您不应该在传入请求上设置任何字段，因为这没有多大意义。

processRequest()的典型实现就是分析请求，然后创建并发回适当的响应：

在这种情况下，您总是用一个成功响应(200)来回复，但是您也可以发回任何错误响应(通常是4xx范围)。

处理错误

SipListener接口中还有其他尚未实现的方法。当由于特定原因无法发送请求时，由SIP协议调用它们。例如，当接收消息的端点没有及时应答时，将调用processTimeout()。这是一种没有响应的特殊情况，因此没有可用的response对象。TimeoutEvent参数包含超时请求的ClientTransaction，如果需要，可以使用该参数链接回原始请求。在这个实现中，你只需使用回调接口通知用户:

类似地，Input/Output (IO)错误的处理方法如下:

总结

本文概述了JAIN SIP API，并展示了如何编写一个简单的应用程序来使用这项技术。现在，您应该对可用的api有了很好的了解，并且知道如何使用SIP编写自己的IM客户机。

以上内容主要来自ORACLE官网《An Introduction to the JAIN SIP API》文章，TextClient源码下载地址也在文章提供，感兴趣的同学可以阅读原文，文章地址： https://www.oracle.com/technical-resources/articles/enterprise-architecture/introduction-jain-sip-part1.html 。

下面将该API应用到安防领域实现一个能够满足GB28181协议的SIP服务器。