Class SimpleServletPostProcessor

java.lang.Object
org.springframework.web.servlet.handler.SimpleServletPostProcessor
All Implemented Interfaces:
Aware, BeanPostProcessor, DestructionAwareBeanPostProcessor, ServletConfigAware, ServletContextAware
public class SimpleServletPostProcessor extends Object implements DestructionAwareBeanPostProcessor, ServletContextAware, ServletConfigAware
BeanPostProcessor that applies initialization and destruction callbacks to beans that implement the Servlet interface.

After initialization of the bean instance, the Servlet init method will be called with a ServletConfig that contains the bean name of the Servlet and the ServletContext that it is running in.

Before destruction of the bean instance, the Servlet destroy will be called.

Note that this post-processor does not support Servlet initialization parameters. Bean instances that implement the Servlet interface are supposed to be configured like any other Spring bean, that is, through constructor arguments or bean properties.

For reuse of a Servlet implementation in a plain Servlet container and as a bean in a Spring context, consider deriving from Spring's HttpServletBean base class that applies Servlet initialization parameters as bean properties, supporting both the standard Servlet and the Spring bean initialization style.

Alternatively, consider wrapping a Servlet with Spring's ServletWrappingController. This is particularly appropriate for existing Servlet classes, allowing to specify Servlet initialization parameters etc.

Since:
1.1.5
Author:
Juergen Hoeller
See Also:

  • Constructor Details

    • SimpleServletPostProcessor

      public SimpleServletPostProcessor()

  • Method Details

    • setUseSharedServletConfig

      public void setUseSharedServletConfig(boolean useSharedServletConfig)
      Set whether to use the shared ServletConfig object passed in through setServletConfig, if available.

      Default is "true". Turn this setting to "false" to pass in a mock ServletConfig object with the bean name as servlet name, holding the current ServletContext.

      See Also:

    • setServletContext

      public void setServletContext(jakarta.servlet.ServletContext servletContext)
      Description copied from interface: ServletContextAware
      Set the ServletContext that this object runs in.

      Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

      Specified by:
      setServletContext in interface ServletContextAware
      Parameters:
      servletContext - the ServletContext object to be used by this object
      See Also:

    • setServletConfig

      public void setServletConfig(jakarta.servlet.ServletConfig servletConfig)
      Description copied from interface: ServletConfigAware
      Set the ServletConfig that this object runs in.

      Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

      Specified by:
      setServletConfig in interface ServletConfigAware
      Parameters:
      servletConfig - the ServletConfig to be used by this object
      See Also:

    • postProcessBeforeInitialization

      public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException
      Description copied from interface: BeanPostProcessor
      Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

      The default implementation returns the given bean as-is.

      Specified by:
      postProcessBeforeInitialization in interface BeanPostProcessor
      Parameters:
      bean - the new bean instance
      beanName - the name of the bean
      Returns:
      the bean instance to use, either the original or a wrapped one; if null, no subsequent BeanPostProcessors will be invoked
      Throws:
      BeansException - in case of errors
      See Also:

    • postProcessAfterInitialization

      public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException
      Description copied from interface: BeanPostProcessor
      Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

      In case of a FactoryBean, this callback will be invoked for both the FactoryBean instance and the objects created by the FactoryBean (as of Spring 2.0). The post-processor can decide whether to apply to either the FactoryBean or created objects or both through corresponding bean instanceof FactoryBean checks.

      This callback will also be invoked after a short-circuiting triggered by a InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(Class, String) method, in contrast to all other BeanPostProcessor callbacks.

      The default implementation returns the given bean as-is.

      Specified by:
      postProcessAfterInitialization in interface BeanPostProcessor
      Parameters:
      bean - the new bean instance
      beanName - the name of the bean
      Returns:
      the bean instance to use, either the original or a wrapped one; if null, no subsequent BeanPostProcessors will be invoked
      Throws:
      BeansException - in case of errors
      See Also:

    • postProcessBeforeDestruction

      public void postProcessBeforeDestruction(Object bean, String beanName) throws BeansException
      Description copied from interface: DestructionAwareBeanPostProcessor
      Apply this BeanPostProcessor to the given bean instance before its destruction, for example, invoking custom destruction callbacks.

      Like DisposableBean's destroy and a custom destroy method, this callback will only apply to beans which the container fully manages the lifecycle for. This is usually the case for singletons and scoped beans.

      Specified by:
      postProcessBeforeDestruction in interface DestructionAwareBeanPostProcessor
      Parameters:
      bean - the bean instance to be destroyed
      beanName - the name of the bean
      Throws:
      BeansException - in case of errors
      See Also:

    • requiresDestruction

      public boolean requiresDestruction(Object bean)
      Description copied from interface: DestructionAwareBeanPostProcessor
      Determine whether the given bean instance requires destruction by this post-processor.

      The default implementation returns true. If a pre-5 implementation of DestructionAwareBeanPostProcessor does not provide a concrete implementation of this method, Spring silently assumes true as well.

      Specified by:
      requiresDestruction in interface DestructionAwareBeanPostProcessor
      Parameters:
      bean - the bean instance to check
      Returns:
      true if DestructionAwareBeanPostProcessor.postProcessBeforeDestruction(Object, String) is supposed to be called for this bean instance eventually, or false if not needed