Servlet Filters e Event Listeners: Introdução

Natal DevMedia: Assine hoje e ganhe 3 meses gr�tis

Ultimamente tornou-se muito importante sabermos como podemos manipular os Servlet Filters e Event Listeners para aplica��es mais complexas e que precisam de tais funcionalidades. Ambos s�o muito utilizados nas aplica��es comerciais e suportam diversas funcionalidades vitais para aplica��es conforme veremos no restante do artigo.

Nas pr�ximas se��es veremos o que s�o e como podemos utilizar os Servlet Filter e Event Listeners. Tamb�m veremos como podemos defini-los, as novidades incorporadas nas duas funcionalidades e c�digos de exemplo para demonstrar como podemos utiliz�-los.

Servlet Filters

Um Servlet Filter pode ser utilizado para diversas situa��es. Com Servlet Filter podemos atualizar a solicita��o (request) e a resposta (response) dos objetos, al�m manipular informa��es como do cabe�alho de e para o Servlet. Vale ressaltar que os filtros n�o criam a resposta, eles apenas modificam ou adaptam as solicita��es e as respostas. Outras tarefas t�picas dos filtros s�o: autentica��o, logging, compress�o de dados, encripta��o de dados, entre outras.

Os filtros s�o empacotados juntamente com um Servlet e agem sobre o conte�do din�mico ou est�tico.

Para definirmos um filtro usamos a anota��o @WebFilter conforme exemplo da Listagem 1.

Listagem 1. Exemplo como podemos definir um filtro atrav�s de uma anota��o WebFilter.


  @WebFilter("/*")
  public class LoggingFiltro implements javax.servlet.Filter {
   
           public void doFilter(HttpServletRequest request, HttpServletResponse response) {
                     //. . .
           }
  }

No c�digo acima, o �LoggingFiltro� � um filtro aplicado a todos os Servlets e p�gina de conte�dos est�ticos na aplica��o web. Ou seja, para toda requisi��o teremos esse filtro sendo processado. Como podemos ver esse filtro tem acesso � solicita��o e a resposta proveniente dessa solicita��o.

A anota��o @WebInitParam pode ser utilizada para especificar par�metros de inicializa��o para os filtros.

Um filtro e o Servlet destino sempre executam no mesmo segmento de chamada. V�rios filtros podem ser organizados em uma cadeia de filtros.

Podemos tamb�m definir um filtro usando os elementos e no deployment descriptor web.xml. Segue na Listagem 2 um exemplo.

Listagem 2. Exemplo de como podemos definir um filtro da maneira antiga utilizando um arquivo web.xml.


  <filter>
           <filter-name>LoggingFilter</filter-name>
           <filter-class>org.sample.LoggingFilter</filter-class>
  </filter>
   
  . . .
   
  <filter-mapping>
           <filter-name>LoggingFilter</filter-name>
           <url-pattern>/*</url-pattern>
  </filter-mapping>

Al�m de declararmos os filtros usando @WebFilter e web.xml, podemos defini-los programaticamente usando m�todos �ServletContext.addFilter�. Podemos fazer isto atrav�s do m�todo �ServletContainerInitializer.onStartup� ou do m�todo �ServletContextListener.contextInitialized�.

O m�todo �addFilter� retorna um �ServletRegistration.Dynamic�, que pode ent�o ser utilizado para adicionar o mapeamento para padr�es de URL, configurar par�metros de inicializa��o, e lidar com outros itens de configura��o.

Segue na Listagem 3 um exemplo de como poder�amos definir um filtro programaticamente.

Listagem 3. Exemplo de como podemos definir um filtro programaticamente.


  public class MeuInicializador implements ServletContainerInitializer {
           public void onStartup (Set<Class<?>> clazz, ServletContext context) {
                     FilterRegistration.Dynamic reg =
                              context.addFilter("LoggingFiltro", "com.exemplo.LoggingFiltro");
                     reg.addMappingForUrlPatterns(null, false, "/");
           }
  }

Event Listeners

Os Event Listeners fornecem eventos de retorno de chamada do ciclo de vida para objetos �ServletContext�, �HttpSession�, e �ServletRequest�. Esses listeners s�o classes que implementam uma interface que suporta notifica��es de evento para altera��es de estado nesses objetos.

Cada classe � anotada com @WebListener, declarado no web.xml, ou registrado via um dos m�todos �ServletContext.addListener�.

Pode haver m�ltiplas classes listener "monitorando" cada tipo de evento, e eles podem ser especificados na ordem em que o container invoca os listeners para cada tipo de evento. Os listeners s�o notificados na ordem inversa durante o encerramento do aplicativo. Listeners em contexto de Servlets monitoram eventos a partir de recursos nesse contexto. Veja a Listagem 4.

Listagem 4. Exemplo de implementa��o de um listener.


  @WebListener
  public class MeuContextListener implements ServletContextListener {
           @Override
           public void contextInitialized(ServletContextEvent sce) {
                     ServletContext context = sce.getServletContext();
   
                     //. . .
   
           }
   
           @Override
           public void contextDestroyed(ServletContextEvent sce) {
                     //. . .
           }
  }

O ServletContextAttributeListener � usado para monitorar altera��es de atributos no contexto.

Segue o c�digo de exemplo na Listagem 5.

Listagem 5. Exemplo de um listener para monitorar altera��es de atributos no contexto.


  public class MeuServletContextAttributeListener implements ServletContextAttributeListener {
           @Override
           public void attributeAdded(ServletContextAttributeEvent event) {
                     //. . . event.getName();
                     //. . . event.getValue();
           }
   
           @Override
           public void attributeRemoved(ServletContextAttributeEvent event) {
                     //. . .
           }
   
           @Override
           public void attributeReplaced(ServletContextAttributeEvent event) {
                     //. . .
           }
  }

O HttpSessionListener monitora eventos a partir de recursos nessa sess�o (Listagem 6).

Listagem 6. Exemplo de um listener para monitorar eventos na sess�o.


  @WebListener
  public class MeuSessionListener implements HttpSessionListener {
           @Override
           public void sessionCreated(HttpSessionEvent hse) {
                     HttpSession session = hse.getSession();
                     
                     //. . .
   
           }
   
           @Override
           public void sessionDestroyed(HttpSessionEvent hse) {
   
                     //. . .
   
           }
  }

O HttpSessionActivationListener � usado para monitorar por eventos quando a sess�o � passivada (serializa��o da sess�o) ou ativada. Veja a Listagem 7.

Listagem 7. Exemplo de listener para monitorar quando a sess�o � passivada ou ativada.


  public class MeuHttpSessionActivationListener implements HttpSessionActivationListener {
   
           @Override
           public void sessionWillPassivate(HttpSessionEvent hse) {
                     // ... hse.getSession();
           }
   
           @Override
           public void sessionDidActivate(HttpSessionEvent hse) {
                     // ...
           }
  }

O HttpSessionAttributeListener � utilizado para monitorar altera��es de atributos na sess�o, conforme a Listagem 8.

Listagem 8. Exemplo de listener para monitorar altera��es de atributos na sess�o.


  public class MeuHttpSessionAttributeListener implements HttpSessionAttributeListener {
           @Override
           public void attributeAdded(HttpSessionBindingEvent event) {
                     HttpSession session = event.getSession();
                     //. . . event.getName();
                     //. . . event.getValue();
           }
   
           @Override
           public void attributeRemoved(HttpSessionBindingEvent event) {
                     //. . .
           }
   
           @Override
           public void attributeReplaced(HttpSessionBindingEvent event) {
                     //. . .
           }
  }

O HttpSessionBindingListener � utilizado para monitorar eventos quando um objeto � ligado ou desligado de uma sess�o. Veja um exemplo na Listagem 9.

Listagem 9. Exemplo utilizando listener para monitorar quando um objeto � ligado ou desligado de uma sess�o.


  public class MeuHttpSessionBindingListener implements HttpSessionBindingListener {
           @Override
           public void valueBound(HttpSessionBindingEvent event) {
                     HttpSession session = event.getSession();
                     //. . . event.getName();
                     //. . . event.getValue();
           }
   
           @Override
           public void valueUnbound(HttpSessionBindingEvent event) {
                     //. . .
           }
  }

O ServletRequestListener monitora eventos de recursos nessa solicita��o (request), conforme a Listagem 10.

Listagem 10. Exemplo de listener para monitorar eventos de recursos na solicita��o.


  @WebListener
  public class MeuRequestListener implements ServletRequestListener {
           @Override
           public void requestDestroyed(ServletRequestEvent sre) {
                     ServletRequest request = sre.getServletRequest();
                     //. . .
           }
   
           @Override
           public void requestInitialized(ServletRequestEvent sre) {
                     //. . .
           }
  }

O ServletRequestAttributeListener � utilizado para monitorar altera��es de atributos na solicita��o (request).

Temos tamb�m o �AsyncListener�, que � utilizado para gerenciar eventos ass�ncronos tais como conclu�do, tempo limite excedido, ou um erro.

Al�m de declarar listeners usando @WebListener e web.xml, podemos defini-los programaticamente usando m�todos �ServletContext.addListener�. Podemos definir isto atrav�s do m�todo �ServletContainerInitializer.onStartup� ou �ServletContextListener.contextInitialized� conforme j� foi falado anteriormente no artigo.

O m�todo ServletContainerInitializer.onStartup � invocado quando a aplica��o est� iniciando para um dado ServletContext. Segue um exemplo na Listagem 11.

Listagem 11. Exemplo de como definir um listener programaticamente.


  public class MeuInicializador implements ServletContainerInitializer {
           public void onStartup(Set<Class<?>> clazz, ServletContext context) {
                     context.addListener("com.exemplo.MeuContextListener");
           }
  }

Bibliografia