Package org.camunda.bpm.webapp.impl.filter

Class AbstractTemplateFilter

  • All Implemented Interfaces:
    javax.servlet.Filter
    Direct Known Subclasses:
    ProcessEnginesFilter
    public abstract class AbstractTemplateFilter
extends java.lang.Object
implements javax.servlet.Filter
    A Filter implementation that can be used to realize basic templating.
    Author:
    nico.rehwaldt

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected abstract void applyFilter​(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain chain)
      Apply the filter to the given request/response.
      void destroy()  
      void doFilter​(javax.servlet.ServletRequest request, javax.servlet.ServletResponse response, javax.servlet.FilterChain chain)  
      protected java.lang.String getWebResourceContents​(java.lang.String name)
      Returns the string contents of a web resource with the given name.
      protected boolean hasWebResource​(java.lang.String name)
      Returns true if the given web resource exists.
      void init​(javax.servlet.FilterConfig filterConfig)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AbstractTemplateFilter

        public AbstractTemplateFilter()

    • Method Detail

      • init

        public void init​(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException
        Specified by:
        init in interface javax.servlet.Filter
        Throws:
        javax.servlet.ServletException

      • destroy

        public void destroy()
        Specified by:
        destroy in interface javax.servlet.Filter

      • doFilter

        public void doFilter​(javax.servlet.ServletRequest request,
                     javax.servlet.ServletResponse response,
                     javax.servlet.FilterChain chain)
              throws java.io.IOException,
                     javax.servlet.ServletException
        Specified by:
        doFilter in interface javax.servlet.Filter
        Throws:
        java.io.IOException
        javax.servlet.ServletException

      • applyFilter

        protected abstract void applyFilter​(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    javax.servlet.FilterChain chain)
                             throws java.io.IOException,
                                    javax.servlet.ServletException
        Apply the filter to the given request/response. This method must be provided by subclasses to perform actual work.
        Parameters:
        request -
        response -
        chain -
        Throws:
        java.io.IOException
        javax.servlet.ServletException

      • hasWebResource

        protected boolean hasWebResource​(java.lang.String name)
        Returns true if the given web resource exists.
        Parameters:
        name -
        Returns:

      • getWebResourceContents

        protected java.lang.String getWebResourceContents​(java.lang.String name)
                                           throws java.io.IOException
        Returns the string contents of a web resource with the given name. The resource must be static and text based.
        Parameters:
        name - the name of the resource
        Returns:
        the resource contents
        Throws:
        java.io.IOException