Servlet and JavaServer Pages API Documentation: Interface ServletConfig

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.servlet
Interface ServletConfig

All Known Implementing Classes:
  GenericServlet

public interface ServletConfig

A servlet configuration object used by a servlet container used to pass information to a servlet during initialization.

The configuration information contains initialization parameters, which are a set of name/value pairs, and a `ServletContext` object, which gives the servlet information about the server.

Version:
  $Version$
Author:
  Various
See Also:
  `ServletContext`

Method Summary
`java.lang.String` | `getInitParameter(java.lang.String name)` Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
`java.util.Enumeration` | `getInitParameterNames()` Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters.
`ServletContext` | `getServletContext()` Returns a reference to the `ServletContext` in which the servlet is executing.
`java.lang.String` | `getServletName()` Returns the name of this servlet instance.

Method Detail

### getServletContext

    public ServletContext getServletContext()

  Returns a reference to the `ServletContext` in which the servlet is executing.
  Returns:
    a `ServletContext` object, used by the servlet to interact with its servlet container
  See Also:
    `ServletContext`

### getInitParameter

    public java.lang.String getInitParameter(java.lang.String name)

  Returns a `String` containing the value of the named initialization parameter, or `null` if the parameter does not exist.
  Parameters:
    `name` - a `String` specifying the name of the initialization parameter
  Returns:
    a `String` containing the value of the initialization parameter

### getInitParameterNames

    public java.util.Enumeration getInitParameterNames()

  Returns the names of the servlet's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the servlet has no initialization parameters.
  Returns:
    an `Enumeration` of `String` objects containing the names of the servlet's initialization parameters

### getServletName

    public java.lang.String getServletName()

  Returns the name of this servlet instance. The name may be provided via server administration, assigned in the web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the servlet's class name.
  Returns:
    the name of the servlet instance

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 1999-2000 The Apache Software Foundation. All Rights Reserved.