Package jakarta.servlet
Class GenericFilter
java.lang.Object
jakarta.servlet.GenericFilter
- All Implemented Interfaces:
- Filter,- FilterConfig,- Serializable
- Direct Known Subclasses:
- HttpFilter
Provides a base class that implements the Filter and FilterConfig interfaces to reduce boilerplate when writing new
 filters.
- Since:
- Servlet 4.0
- See Also:
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionObtain the FilterConfig used to initialise this Filter instance.Get the name of the filter.getInitParameter(String name) Returns aStringcontaining the value of the named initialization parameter, ornullif the parameter does not exist.Returns the names of the filter's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the filter has no initialization parameters.Returns a reference to theServletContextin which the caller is executing.voidinit()Convenience method for sub-classes to save them having to callsuper.init(config).voidinit(FilterConfig filterConfig) Called by the web container to indicate to a filter that it is being placed into service.
- 
Constructor Details- 
GenericFilterpublic GenericFilter()
 
- 
- 
Method Details- 
getInitParameterDescription copied from interface:FilterConfigReturns aStringcontaining the value of the named initialization parameter, ornullif the parameter does not exist.- Specified by:
- getInitParameterin interface- FilterConfig
- Parameters:
- name-- Stringspecifying the name of the initialization parameter
- Returns:
- Stringcontaining the value of the initialization parameter
 
- 
getInitParameterNamesDescription copied from interface:FilterConfigReturns the names of the filter's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the filter has no initialization parameters.- Specified by:
- getInitParameterNamesin interface- FilterConfig
- Returns:
- Enumerationof- Stringobjects containing the names of the filter's initialization parameters
 
- 
getFilterConfigObtain the FilterConfig used to initialise this Filter instance.- Returns:
- The config previously passed to the init(FilterConfig)method
 
- 
getServletContextDescription copied from interface:FilterConfigReturns a reference to theServletContextin which the caller is executing.- Specified by:
- getServletContextin interface- FilterConfig
- Returns:
- ServletContextobject, used by the caller to interact with its servlet container
- See Also:
 
- 
initDescription copied from interface:FilterCalled by the web container to indicate to a filter that it is being placed into service. The servlet container calls the init method exactly once after instantiating the filter. The init method must complete successfully before the filter is asked to do any filtering work.The web container cannot place the filter into service if the init method either: - Throws a ServletException
- Does not return within a time period defined by the web container
 - Specified by:
- initin interface- Filter
- Parameters:
- filterConfig- The configuration information associated with the filter instance being initialised
- Throws:
- ServletException- if the initialisation fails
 
- 
initConvenience method for sub-classes to save them having to callsuper.init(config). This is a NO-OP by default.- Throws:
- ServletException- If an exception occurs that interrupts the Filter's normal operation
 
- 
getFilterNameDescription copied from interface:FilterConfigGet the name of the filter.- Specified by:
- getFilterNamein interface- FilterConfig
- Returns:
- The filter-name of this filter as defined in the deployment descriptor.
 
 
-