ServletContextListener Example

SHARE & COMMENT :

This tips explains the how to use ServletContextListener. There will be only one ServletContext for each web application. ServletContext will be created while deploying the application. Once the ServletContext is created, it will be used by all the servlets and jsp files in the same application. ServletContext is also called as the application scope variables in the web application scenario.

also read:

ServletContextListener has the following two methods:

  • public void contextInitialized(ServletContextEvent event)
  • public void contextDestroyed(ServletContextEvent event)

Look into the following example for how to implement the ServletContextListener methods:

ServletContextExample.java

package example;

import javax.servlet.ServletContext;
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class ServletContextExample implements ServletContextListener{
	ServletContext context;
	public void contextInitialized(ServletContextEvent contextEvent) {
		System.out.println("Context Created");
		context = contextEvent.getServletContext();
		// set variable to servlet context
		context.setAttribute("TEST", "TEST_VALUE");
	}
	public void contextDestroyed(ServletContextEvent contextEvent) {
		context = contextEvent.getServletContext();
		System.out.println("Context Destroyed");
	}
}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
	xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

  <listener>
  	<listener-class>
  		example.ServletContextExample
  	</listener-class>
  </listener>
</web-app>

In the above example ServletContextExample implements ServletContextListener. It has two methods contextInitialized which is called when the ServletContext is created. Another one is contextDestroyed which is called while context is destroyed, this happens normally when web server is shut down or crash.

Comments

comments

About Krishna Srinivasan

He is Founder and Chief Editor of JavaBeat. He has more than 8+ years of experience on developing Web applications. He writes about Spring, DOJO, JSF, Hibernate and many other emerging technologies in this blog.

Trackbacks

  1. [...] AM as a reply to string printf. Hi,I'd create a ServletContextListener for this purpose – here's a very brief example : Google is your friend if you need more [...]

  2. [...] 12:52 PM as a reply to eric dumond. For instance using a ServletContextListener: take a look at this example. You can then store the file in a static variable, but remember to handle concurrent [...]

  3. [...] to one per user/session) you'll probably want to setup/destroy the ScheduledExecutor with a ServletContextListener. If you're using Spring or Guice you can use a Singleton [...]

Speak Your Mind

*

Close
Please support the site
By clicking any of these buttons you help our site to get better