Java Servlet Programming, 2nd Edition

Name

ServletConfig

Synopsis

Interface Name: javax.servlet.ServletConfig

Superinterface: None

Immediate Subinterfaces: None

Implemented By: javax.servlet.GenericServlet

Availability: Servlet API 1.0 and later

Description

Servlet containers use ServletConfig objects to pass initialization and context information to servlets. The initialization information generally consists of a series of initialization parameters (init parameters) and a ServletContext object, which provides information about the server environment. A servlet can implement ServletConfig to allow easy access to init parameters and context information, as GenericServlet does.

Interface Declaration

public interface ServletConfig {
  // Methods
  public abstract String getInitParameter(String name);
  public abstract Enumeration getInitParameterNames();
  public abstract ServletContext getServletContext();
  public abstract String getServletName();                   // New in 2.2
}

Methods

getInitParameter()

public abstract String getInitParameter(String name)

Description

Returns the value of the named servlet initialization parameter or null if no matching parameter is found.

getInitParameterNames()

public abstract Enumeration getInitParameterNames()

Description

Returns the names of all the servlet’s initialization parameters as an Enumeration of String objects or an empty Enumeration if no parameters exist.

getServletContext()

public abstract ServletContext getServletContext()

Description

Returns the ServletContext object for this servlet, allowing interaction with ...