SIP 1.1 注释

从 SIP 1.1 开始,您可以在 SIP Servlet 应用程序中使用注释。可以使用注释将数据直接嵌入在应用程序中,而不是使用部署描述符。

SIP 1.1 中可用的注释

下列注释在 SIP 1.1 中可用:
  • @SipApplication
  • @SipServlet
  • @SipListener
  • @SipApplicationKey
提示: 您仍然可以选择使用部署描述符而不是注释。部署描述符将覆盖注释中描述的设置。

@SipApplication 注释

@SipApplication 注释定义有关应用程序的公共配置信息。它是一个包级别注释,并且必须位于名为 package-info.java 的文件中。包中的所有 Servlet 都属于同一个应用程序。
要点: 对于每个 .war 或 .sar 文件,无论您使用的是部署描述符还是注释,都只能有一个 SIP 应用程序向容器进行注册。

表 1. @SipApplication 的属性以及到相应部署描述符元素的映射
注释属性 部署描述符元素 描述 缺省注释值
name <app-name> SIP 应用程序的名称 必需字段
displayName <display-name> 所显示的应用程序名称 应用程序名称
description <description> 描述应用程序 空字符串
smallicon <small-icon> 包含小图标的位置的路径 空字符串
largeicon <large-icon> 包含大图标的位置的路径 空字符串
distributable <destributable> 指示应用程序在分布式环境中是否可以运行 False(布尔值)
proxyTimeout <proxy-timeout> 所有代理操作的缺省超时 3 分钟(以秒计)
sessionTimeout <session-timeout> 所有应用程序会话操作的缺省超时 3 分钟(以分钟计)
mainServlet <main-servlet> 指示设计为主要 Servlet 的 SIP Servlet 空字符串

@SipServlet 注释

@SipServlet 注释指示类是 SIP Servlet。

表 2. @SipServlet 的属性以及到相应部署描述符元素的映射
注释属性 部署描述符元素 描述 缺省注释值
@SipServletServlet <servlet-class> 指示类是 SIP Servlet 注释是在类中声明的。
name <servlet-name> Servlet 的名称 已注释的类的短名称
applicationName <app-name> 应用程序的名称 可选;此属性也可以在部署描述符中定义或使用 @SipApplication 来定义
loadOnStartup <load-on-startup> 定义 Servlet 应用程序的启动顺序 一个负数(导致容器选择何时启动此 Servlet)

@SipListener 注释

@SipListener 注释提供 <listener> 部署描述符元素的替代项。

@SipListener 注释没有任何必需字段,但可以接受可选的应用程序名称和描述。通过 @SipListener 注释的类至少必须在一个侦听器接口实现。

@SipApplicationKey 注释

@SipApplicationKey 注释标记用于将传入请求和 SipSession 与特定 SipApplicationSession 相关联的方法。您可以将此注释与基于会话密钥的目标确定配合使用。

Icon that indicates the type of topic Reference topic
Timestamp icon Last updated: last_date

File name: SIP_dd_mappingtoservlet.html