Annotations SIP 1.1

A partir de SIP 1.1, vous pouvez utiliser des annotations dans les applications de servlet SIP. Les annotations permettent d'intégrer des données directement dans une application au lieu d'utiliser le descripteur de déploiement.

Annotations disponibles dans SIP 1.1

Les annotations suivantes sont disponibles dans SIP 1.1 :
  • @SipApplication
  • @SipServlet
  • @SipListener
  • @SipApplicationKey
Conseil : Vous pouvez néanmoins choisir d'utiliser des descripteurs de déploiement à la place d'annotations. Les descripteurs de déploiement remplacent les paramètres décrits dans les annotations.

Annotation @SipApplication

L'annotation @SipApplication définit les informations de configuration courantes relatives à une application. Il s'agit d'une annotation au niveau du package et elle doit résider dans un fichier intitulé package-info.java. Tous les servlets du package font partie de la même application.
Important : Une seule application SIP peut être enregistrée auprès du conteneur pour chaque fichier .war ou .sar, que vous utilisiez un descripteur de déploiement ou des annotations.

Tableau 1. Propriétés pour @SipApplication et mappage vers des éléments de descripteur de déploiement correspondants
Propriété d'annotation Elément de descripteur de déploiement Description Valeur d'annotation par défaut
name <app-name> Nom de l'application SIP Zone obligatoire
displayName <display-name> Nom affiché de l'application Nom de l'application
description <description> Décrit l'application Chaîne vide
smallicon <small-icon> Chemin contenant l'emplacement de la petite icône Chaîne vide
largeicon <large-icon> Chemin contenant l'emplacement de la grande icône Chaîne vide
distributable <destributable> Indique si l'application peut fonctionner dans un environnement réparti False (valeur booléenne)
proxyTimeout <proxy-timeout> Délai d'attente par défaut pour toutes les opérations proxy Trois minutes, en secondes
sessionTimeout <session-timeout> Délai d'attente par défaut pour toutes les opérations de session d'application Trois minutes, en minutes
mainServlet <main-servlet> Indique le servlet SIP qui est conçu comme servlet principal Chaîne vide

Annotation @SipServlet

L'annotation @SipServlet indique qu'une classe est un servlet SIP.

Tableau 2. Propriétés pour @SipServlet et mappage vers des éléments de descripteur de déploiement correspondants
Propriété d'annotation Elément de descripteur de déploiement Description Valeur d'annotation par défaut
@SipServletServlet <servlet-class> Indique que la classe est un servlet SIP L'annotation est déclarée sur la classe.
name <servlet-name> Nom du servlet. Nom abrégé de la classe annotée
applicationName <app-name> Nom de l'application Facultative ; elle peut également être définie soit dans le descripteur de déploiement, soit à l'aide de @SipApplication
loadOnStartup <load-on-startup> Définit l'ordre de démarrage de l'application de servlet Nombre négatif (permet au conteneur de choisir quand démarrer ce servlet).

Annotation @SipListener

L'annotation @SipListener fournit une alternative à l'élément de descripteur de déploiement <listener>.

L'annotation @SipListener ne comporte aucune zone obligatoire mais peut utiliser un nom et une description d'application facultatifs. La classe qui est annotée par @SipListener doit implémenter au moins une interface de module d'écoute.

Annotation @SipApplicationKey

L'annotation @SipApplicationKey marque la méthode qui associe une demande entrante et SipSession à une SipApplicationSession spécifique. Vous pouvez utiliser cette annotation avec le ciblage basé sur des clés de session.

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

File name: SIP_dd_mappingtoservlet.html