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> 所有 Proxy 作業的預設逾時值 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