Anotações do SIP 1.1

A partir do SIP 1.1, é possível usar anotações nos aplicativos de servlet SIP. É possível usar anotações para integrar os dados diretamente em um aplicativo, em vez de usar o descritor de implementação.

Anotações disponíveis no SIP 1.1

As seguintes anotações estão disponíveis no SIP 1.1:
  • @SipApplication
  • @SipServlet
  • @SipListener
  • @SipApplicationKey
Dica: Ainda é possível optar por usar descritores de implementação, em vez de anotações. Os descritores de implementação substituem as configurações descritas nas anotações.

Anotação @SipApplication

A anotação @SipApplication define informações de configuração comuns sobre um aplicativo. Ela é uma anotação no nível do pacote e deve estar em um arquivo chamado package-info.java. Todos os servlets dentro do pacote pertencem ao mesmo aplicativo.
Importante: Apenas um aplicativo SIP pode ser registrado com o contêiner para cada arquivo .war ou .sar, independentemente do uso de um descritor de implementação ou de anotações.

Tabela 1. Propriedades para @SipApplication e mapeamento para os elementos correspondentes do descritor de implementação
Propriedade de anotação Elemento do descritor de implementação Descrição Valor de anotação padrão
name <app-name> O nome do aplicativo SIP Campo requerido
displayName <display-name> Nome exibido do aplicativo Nome do aplicativo
Descrição <description> Descreve o aplicativo Sequência vazia
smallicon <small-icon> Caminho com o local do ícone pequeno Sequência vazia
largeicon <large-icon> Caminho com o local do ícone grande Sequência vazia
distributable <destributable> Indica se o aplicativo pode funcionar em um ambiente distribuído False (booleano)
proxyTimeout <proxy-timeout> Tempo limite padrão para todas as operações de proxy Três minutos, em segundos
sessionTimeout <session-timeout> Tempo limite padrão para todas as operações da sessão de aplicativo Três minutos, em minutos
mainServlet <main-servlet> Indica o servlet SIP que é projetado como o Servlet Principal Sequência vazia

Anotação @SipServlet

A anotação @SipServlet indica que uma classe é um servlet SIP.

Tabela 2. Propriedades para @SipServlet e mapeamento para os elementos correspondentes do descritor de implementação
Propriedade de anotação Elemento do descritor de implementação Descrição Valor de anotação padrão
@SipServletServlet <servlet-class> Indica que a classe é um servlet SIP A anotação é declarada na classe.
name <servlet-name> Nome do servlet Nome abreviado da classe anotada
applicationName <app-name> O nome do aplicativo Opcional; também pode ser definido no descritor de implementação ou usando a anotação @SipApplication
loadOnStartup <load-on-startup> Define a ordem de início do aplicativo de servlet Um número negativo (faz com que o contêiner escolha quando iniciar esse servlet)

Anotação @SipListener

A anotação @SipListener fornece uma alternativa para o elemento descritor de implementação <listener>.

A anotação @SipListener não possui campos obrigatórios, mas pode usar um nome de aplicativo e uma descrição opcionais. A classe anotada por @SipListener deve implementar pelo menos uma interface do listener.

Anotação @SipApplicationKey

A anotação @SipApplicationKey marca o método que associa uma solicitação recebida e a SipSession com uma SipApplicationSession específica. Utilize essa anotação com a destinação baseada em chave de sessão.

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

File name: SIP_dd_mappingtoservlet.html