• Java
    • JAXB Tutorial
      • What is JAXB
      • JAXB Marshalling Example
      • JAXB UnMarshalling Example
  • Spring Tutorial
    • Spring Core Tutorial
    • Spring MVC Tutorial
      • Quick Start
        • Flow Diagram
        • Hello World Example
        • Form Handling Example
      • Handler Mapping
        • BeanNameUrlHandlerMapping
        • ControllerClassNameHandlerMapping
        • SimpleUrlHandlerMapping
      • Validation & Exception Handling
        • Validation+Annotations
        • Validation+ResourceBundle
        • @ExceptionHandler
        • @ControllerAdvice
        • Custom Exception Handling
      • Form Tag Library
        • Textbox Example
        • TextArea Example
        • Password Example
        • Dropdown Box Example
        • Checkboxes Example
        • Radiobuttons Example
        • HiddenValue Example
      • Misc
        • Change Config file name
    • Spring Boot Tutorial
  • Hibernate Tutorial
  • REST Tutorial
    • JAX-RS REST @PathParam Example
    • JAX-RS REST @QueryParam Example
    • JAX-RS REST @DefaultValue Example
    • JAX-RS REST @Context Example
    • JAX-RS REST @MatrixParam Example
    • JAX-RS REST @FormParam Example
    • JAX-RS REST @Produces Example
    • JAX-RS REST @Consumes Example
    • JAX-RS REST @Produces both XML and JSON Example
    • JAX-RS REST @Consumes both XML and JSON Example
  • Miscellaneous
    • JSON Parser
      • Read a JSON file
      • Write JSON object to File
      • Read / Write JSON using GSON
      • Java Object to JSON using JAXB
    • CSV Parser
      • Read / Write CSV file
      • Read/Parse/Write CSV File – OpenCSV
      • Export data into a CSV File
      • CsvToBean and BeanToCsv – OpenCSV

JavaInterviewPoint

Java Development Tutorials

ServletContext Interface in Servlets

June 9, 2015 by javainterviewpoint Leave a Comment

ServletContext is one of the predefined interface available in javax.servlet.* package, The object of the ServletContext is created by the web container at the time of deploying the application(which will be available one per application) . This object is used to get configuration information from web.xml file. If we need to share any common information between servlets, it is better to provide it from the web.xml file using the <context-param> element. Suppose if you have a web application which has more than one servlet and you need to share some common informations such as JDBC connection details etc.. Then ServletContext works better for you rather than ServletConfig which can accessed by only one particular servlet.

Important methods of ServletContext Interface

  • public String getInitParameter(String name): This method returns the value for the specified parameter name or NULL if the parameter name doesn’t exist
  • public Enumeration getInitParameterNames(): This method returns the names of the context’s initialization parameters as Enumeration.
  • public void setAttribute(String name,Object object): This method sets the object with a  name and stores the name/value pair as an attribute in the application scope.
  • public Object getAttribute(String name): This method returns the attribute for the specified name.
  • public void removeAttribute(String name): This method removes the attribute with the specified name from the application context.

Getting the ServletContext Object

We can get the ServletContext object to a servlet in the below ways

1.Using HttpServletRequest

HttpServletRequest has a direct method getServletContext() using which you can use to get the context object.

public class ServletContextExample extends HttpServlet
{
    public void doGet(HttpServletRequest request,HttpServletResponse response) throws IOException
    {
        PrintWriter out = response.getWriter();
        ServletContext servletContext = request.getServletContext();
        out.println(servletContext.getInitParameter("driverName"));
    }
}

2. getServletContext() method of Generic Servlet

Calling the getServletContext() method of the GenericServlet, Here we will be extending HttpServlet class but we know HttpSevlet is a sub class of GenericServlet.

public class ServletContextExample extends HttpServlet
{
   
    public void doGet(HttpServletRequest request,HttpServletResponse response) throws IOException
    {
        PrintWriter out = response.getWriter();
        ServletContext ctx =getServletContext();
        out.println(ctx.getInitParameter("driverName"));
    }
    
}

3. Through ServletConfig Interface

ServletConfig object has the direct method to get the context object.

public class ServletContextExample extends HttpServlet
{
   
    public void doGet(HttpServletRequest request,HttpServletResponse response) throws IOException
    {
        PrintWriter out = response.getWriter();
        ServletContext ctx = getServletConfig().getServletContext();
        out.println(ctx.getInitParameter("driverName"));
    }
}

getServletConfig() method gets you the config object, using that we can get the context object by calling the getServletContext() method.

Example of ServletContext

ServletContextExample.java

package com.javainterviewpoint;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextExample extends HttpServlet
{
   
    public void doGet(HttpServletRequest request,HttpServletResponse response) throws IOException
    {
        PrintWriter out = response.getWriter();
        //Getting the context object using getServletConfig() method
        ServletContext ctx = getServletConfig().getServletContext();
        
        //Getting context object using request
        //ServletContext ctx = request.getServletContext();
        
        //Getting context object of the GenericServlet directly
        //ServletContext ctx = getServletContext();
        out.println(ctx.getInitParameter("driverName"));
    }
}

web.xml

 <?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee"	xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee	
	http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
 <display-name>ServletsTutorial</display-name>
 <servlet>
     <servlet-name>ServletContextExample</servlet-name>
     <servlet-class>com.javainterviewpoint.ServletContextExample</servlet-class>
 </servlet>
 <servlet-mapping>
     <servlet-name>ServletContextExample</servlet-name>
     <url-pattern>/ServletContextExample</url-pattern>
 </servlet-mapping>
 <context-param>
     <param-name>driverName</param-name>
     <param-value>sun.jdbc.JdbcOdbcDriver</param-value>
 </context-param>
</web-app>

When we run the above code we will get the below output

URL : http://localhost:8080/ServletsTutorial/ServletContextExample

Output

sun.jdbc.JdbcOdbcDriver

Getting All Initial Parameters of ServletContext

package com.javainterviewpoint;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.Enumeration;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextExample extends HttpServlet
{
   
    public void doGet(HttpServletRequest request,HttpServletResponse response) throws IOException
    {
        PrintWriter out = response.getWriter();
        //Getting the context object using getServletConfig() method
        ServletContext ctx = getServletConfig().getServletContext();
        
        //Getting context object using request
        //ServletContext ctx = request.getServletContext();
        
        //Getting context object of the GenericServlet directly
        //ServletContext ctx = getServletContext();
        Enumeration enumeration = ctx.getInitParameterNames();
        while(enumeration.hasMoreElements())
        {
            String name = (String)enumeration.nextElement();
            String value = ctx.getInitParameter(name);
            
            out.print("Parameter Name : "+name+"<<<>>>> Parameter Value : "+value);
            out.println();
        }
    }
}

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee%20http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
 <display-name>ServletsTutorial</display-name>
 <servlet>
     <servlet-name>ServletContextExample</servlet-name>
     <servlet-class>com.javainterviewpoint.ServletContextExample</servlet-class>
 </servlet>
 <servlet-mapping>
     <servlet-name>ServletContextExample</servlet-name>
     <url-pattern>/ServletContextExample</url-pattern>
 </servlet-mapping>
 <context-param>
     <param-name>driverName</param-name>
     <param-value>sun.jdbc.JdbcOdbcDriver</param-value>
 </context-param>
<context-param>
     <param-name>username</param-name>
     <param-value>root</param-value>
 </context-param>
<context-param>
     <param-name>password</param-name>
     <param-value>root</param-value>
 </context-param>
</web-app>

Hit on the below url
http://localhost:8080/ServletsTutorial/ServletContextExample

Output

Parameter Name : username<<<>>>> Parameter Value : root Parameter Name : password<<<>>>> Parameter Value : root Parameter Name : driverName<<<>>>> Parameter Value : sun.jdbc.JdbcOdbcDriver

Other interesting articles which you may like …

  • Difference between ServletConfig and ServletContext
  • How to change Tomcat default port from 8080 to Some Other?
  • Life Cycle of a Servlet
  • JSP Custom tags
  • Access body of Custom Tag in JSP
  • Attributes In Jsp Custom Tag
  • Running Your First Servlet Application
  • Servlet Interface
  • Difference Between GenericServlet and HttpServlet
  • welcome-file-list in web.xml of Servlets
  • Obtaining HTTP Request Headers from HttpServletRequest
  • ServletRequest Interface – Servlets
  • ServletResponse Interface – Servlets
  • Get Query String from Servlet Request

Filed Under: J2EE, Java, Servlets Tagged With: Attributes, Cookies, Filters, HttpSession, Listeners, Servlet Config, Servlet Context, Servlet Events, Servlet Life cycle, Servlet request, Servlet response, Servlet tutotials, Session

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.

Java Basics

  • JVM Architecture
  • Object in Java
  • Class in Java
  • How to Set Classpath for Java in Windows
  • Components of JDK
  • Decompiling a class file
  • Use of Class.forName in java
  • Use Class.forName in SQL JDBC

Oops Concepts

  • Inheritance in Java
  • Types of Inheritance in Java
  • Single Inheritance in Java
  • Multiple Inheritance in Java
  • Multilevel Inheritance in Java
  • Hierarchical Inheritance in Java
  • Hybrid Inheritance in Java
  • Polymorphism in Java – Method Overloading and Overriding
  • Types of Polymorphism in java
  • Method Overriding in Java
  • Can we Overload static methods in Java
  • Can we Override static methods in Java
  • Java Constructor Overloading
  • Java Method Overloading Example
  • Encapsulation in Java with Example
  • Constructor in Java
  • Constructor in an Interface?
  • Parameterized Constructor in Java
  • Constructor Chaining with example
  • What is the use of a Private Constructors in Java
  • Interface in Java
  • What is Marker Interface
  • Abstract Class in Java

Java Keywords

  • Java this keyword
  • Java super keyword
  • Final Keyword in Java
  • static Keyword in Java
  • Static Import
  • Transient Keyword

Miscellaneous

  • newInstance() method
  • How does Hashmap works internally in Java
  • Java Ternary operator
  • How System.out.println() really work?
  • Autoboxing and Unboxing Examples
  • Serialization and Deserialization in Java with Example
  • Generate SerialVersionUID in Java
  • How to make a class Immutable in Java
  • Differences betwen HashMap and Hashtable
  • Difference between Enumeration and Iterator ?
  • Difference between fail-fast and fail-safe Iterator
  • Difference Between Interface and Abstract Class in Java
  • Difference between equals() and ==
  • Sort Objects in a ArrayList using Java Comparable Interface
  • Sort Objects in a ArrayList using Java Comparator

Follow

  • Coding Utils

Useful Links

  • Spring 4.1.x Documentation
  • Spring 3.2.x Documentation
  • Spring 2.5.x Documentation
  • Java 6 API
  • Java 7 API
  • Java 8 API
  • Java EE 5 Tutorial
  • Java EE 6 Tutorial
  • Java EE 7 Tutorial
  • Maven Repository
  • Hibernate ORM

About JavaInterviewPoint

javainterviewpoint.com is a tech blog dedicated to all Java/J2EE developers and Web Developers. We publish useful tutorials on Java, J2EE and all latest frameworks.

All examples and tutorials posted here are very well tested in our development environment.

Connect with us on Facebook | Privacy Policy | Sitemap

Copyright ©2023 · Java Interview Point - All Rights Are Reserved ·