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

Class AbstractTemplateFilter

java.lang.Object
org.camunda.bpm.webapp.impl.filter.AbstractTemplateFilter
All Implemented Interfaces:
jakarta.servlet.Filter
Direct Known Subclasses:
ProcessEnginesFilter
public abstract class AbstractTemplateFilter extends Object implements jakarta.servlet.Filter
A Filter implementation that can be used to realize basic templating.
Author:
nico.rehwaldt

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractTemplateFilter()
     

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • AbstractTemplateFilter

      public AbstractTemplateFilter()

  • Method Details

    • init

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

    • destroy

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

    • doFilter

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

    • applyFilter

      protected abstract void applyFilter(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain chain) throws IOException, jakarta.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:
      IOException
      jakarta.servlet.ServletException

    • hasWebResource

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

    • getWebResourceContents

      protected String getWebResourceContents(String name) throws 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:
      IOException