Class DefaultIoFilterChainBuilderFactoryBean

  • All Implemented Interfaces:
    org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean, org.springframework.beans.factory.InitializingBean

    public class DefaultIoFilterChainBuilderFactoryBean
    extends org.springframework.beans.factory.config.AbstractFactoryBean
    Spring FactoryBean which creates DefaultIoFilterChainBuilder instances. This factory bean makes it possible to configure the filters to be added to all the sessions created by an IoAcceptor or IoConnector using Spring.

    The filters may be set up in two ways. By creating IoFilterMapping objects which associate a name with an IoFilter instance and set them using #setFilterMappings(IoFilterMapping[]) or by using #setFilters(IoFilter[]) directly which assigns automatically generated names to each IoFilter. Use the setFilterNamePrefix(String) method to set the prefix used for auto generated names.

    • Field Summary

      • Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

        logger
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected java.lang.Object createInstance()  
      java.lang.Class getObjectType()  
      void setFilterNamePrefix​(java.lang.String prefix)
      Sets the prefix used to create the names for automatically named filters added using #setFilters(IoFilter[]).
      void setFilters​(java.util.List filters)
      Sets a number of filters which will be added to the filter chain created by this factory bean.
      • Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean

        afterPropertiesSet, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DefaultIoFilterChainBuilderFactoryBean

        public DefaultIoFilterChainBuilderFactoryBean()
    • Method Detail

      • createInstance

        protected java.lang.Object createInstance()
                                           throws java.lang.Exception
        Specified by:
        createInstance in class org.springframework.beans.factory.config.AbstractFactoryBean
        Throws:
        java.lang.Exception
      • getObjectType

        public java.lang.Class getObjectType()
        Specified by:
        getObjectType in interface org.springframework.beans.factory.FactoryBean
        Specified by:
        getObjectType in class org.springframework.beans.factory.config.AbstractFactoryBean
      • setFilterNamePrefix

        public void setFilterNamePrefix​(java.lang.String prefix)
        Sets the prefix used to create the names for automatically named filters added using #setFilters(IoFilter[]). The default prefix is filter.
        Parameters:
        prefix - the prefix.
        Throws:
        java.lang.IllegalArgumentException - if the specified value is null.
      • setFilters

        public void setFilters​(java.util.List filters)
        Sets a number of filters which will be added to the filter chain created by this factory bean. The specified list must contain either IoFilter or IoFilterMapping objects. Filters which haven't been wrapped in IoFilterMapping objects will be assigned automatically generated names (<filterNamePrefix>0, <filterNamePrefix>1, etc).
        Parameters:
        filters - the list of IoFilter and/or IoFilterMapping objects.
        Throws:
        java.lang.IllegalArgumentException - if the specified value is null or contains objects of the wrong type.
        See Also:
        setFilterNamePrefix(String)