Package org.ops4j.pax.web.service.jetty.internal

Class PaxWebFilterHolder

  • All Implemented Interfaces:
    org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.LifeCycle
    public class PaxWebFilterHolder
extends org.eclipse.jetty.servlet.FilterHolder
    Special FilterHolder to handle OSGi specific lifecycle related to OsgiServletContext.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.FilterHolder

        org.eclipse.jetty.servlet.FilterHolder.Registration, org.eclipse.jetty.servlet.FilterHolder.WrapFunction, org.eclipse.jetty.servlet.FilterHolder.Wrapper

      • Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.Holder

        org.eclipse.jetty.servlet.Holder.HolderConfig, org.eclipse.jetty.servlet.Holder.HolderRegistration

      • Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Dumpable

        org.eclipse.jetty.util.component.Dumpable.DumpableContainer

      • Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

        org.eclipse.jetty.util.component.LifeCycle.Listener

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static org.slf4j.Logger LOG  

      • Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

      • Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

        KEY

    • Constructor Summary

      Constructors 
      Constructor Description
      PaxWebFilterHolder​(org.eclipse.jetty.servlet.FilterHolder holder, org.ops4j.pax.web.service.spi.servlet.OsgiServletContext defaultServletContext)  
      PaxWebFilterHolder​(org.ops4j.pax.web.service.spi.model.elements.FilterModel filterModel, org.ops4j.pax.web.service.spi.servlet.OsgiServletContext osgiServletContext)
      Initialize PaxWebFilterHolder with FilterModel.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroyInstance​(Object o)  
      void doStart()  
      org.ops4j.pax.web.service.spi.model.elements.FilterModel getFilterModel()  
      protected javax.servlet.Filter getInstance()
      Method called by org.eclipse.jetty.servlet.FilterHolder#initialize() - single place where Filter instance can be created.
      List<PaxWebFilterMapping> getMapping()  
      boolean matches​(org.ops4j.pax.web.service.spi.model.OsgiContextModel targetContext)
      Check whether current filter should be used within given OsgiContextModel according to "140.5 Registering Servlet Filters"
      void setMapping​(List<PaxWebFilterMapping> mapping)  
      void setWhiteboardTCCL​(boolean whiteboardTCCL)  

      • Methods inherited from class org.eclipse.jetty.servlet.FilterHolder

        doFilter, doStop, dump, getFilter, getRegistration, initialize, setFilter, toString

      • Methods inherited from class org.eclipse.jetty.servlet.Holder

        dump, getDisplayName, getInitParameter, getInitParameterNames, getInitParameters, getName, isAsyncSupported, setAsyncSupported, setClassName, setDisplayName, setHeldClass, setInitParameter, setInitParameters, setInstance, setName

      • Methods inherited from class org.eclipse.jetty.servlet.BaseHolder

        getClassName, getHeldClass, getServletHandler, getSource, illegalStateIfContextStarted, isInstance, setServletHandler, unwrap, wrap

      • Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

        addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

      • Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

        dumpSelf

    • Field Detail

      • LOG

        public static final org.slf4j.Logger LOG

    • Constructor Detail

      • PaxWebFilterHolder

        public PaxWebFilterHolder​(org.ops4j.pax.web.service.spi.model.elements.FilterModel filterModel,
                          org.ops4j.pax.web.service.spi.servlet.OsgiServletContext osgiServletContext)
        Initialize PaxWebFilterHolder with FilterModel. All its OSGi contexts will determinie when the filter will be used during request processing.
        Parameters:
        filterModel -
        osgiServletContext -

      • PaxWebFilterHolder

        public PaxWebFilterHolder​(org.eclipse.jetty.servlet.FilterHolder holder,
                          org.ops4j.pax.web.service.spi.servlet.OsgiServletContext defaultServletContext)

    • Method Detail

      • doStart

        public void doStart()
             throws Exception
        Overrides:
        doStart in class org.eclipse.jetty.servlet.FilterHolder
        Throws:
        Exception

      • getInstance

        protected javax.servlet.Filter getInstance()
        Method called by org.eclipse.jetty.servlet.FilterHolder#initialize() - single place where Filter instance can be created. This is where we can get the filter from OSGi service registry.
        Overrides:
        getInstance in class org.eclipse.jetty.servlet.BaseHolder<javax.servlet.Filter>
        Returns:

      • destroyInstance

        public void destroyInstance​(Object o)
        Overrides:
        destroyInstance in class org.eclipse.jetty.servlet.FilterHolder

      • matches

        public boolean matches​(org.ops4j.pax.web.service.spi.model.OsgiContextModel targetContext)
        Check whether current filter should be used within given OsgiContextModel according to "140.5 Registering Servlet Filters"
        Parameters:
        targetContext -
        Returns:

      • getFilterModel

        public org.ops4j.pax.web.service.spi.model.elements.FilterModel getFilterModel()

      • setWhiteboardTCCL

        public void setWhiteboardTCCL​(boolean whiteboardTCCL)