Extension point filterConfig

In component org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService

Documentation

Define a new filterConfig.

-filterConfig - name: name of the Filter. - transactional: use transaction. - synchonize: is synchronized - cached: if true, add cache-control to header - cacheTime: cache duration. - private: if true, cache is private, public if false.

-pattern: url pattern to match

Example of a filterConfig Registration:

    <filterConfig cached="true" cachetime="3600" name="filterName"
        private="true" synchonize="true" transactional="true">
        <pattern>/nuxeo/urlPattern/.*</pattern>
    </filterConfig>

Contribution Descriptors

Class: org.nuxeo.ecm.platform.web.common.requestcontroller.service.FilterConfigDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">
    <filterConfig name="cmis-atom" transactional="true">
      <pattern>/nuxeo/atom/cmis(/.*)?(\?.*)?</pattern>
    </filterConfig>
    <filterConfig name="cmis10-atom" transactional="true">
      <pattern>/nuxeo/atom/cmis10(/.*)?(\?.*)?</pattern>
    </filterConfig>
  </extension>

(0) nuxeo-opencmis-bindings-2023.10.13.jar/OSGI-INF/atom-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">
    <filterConfig name="cmis-json" transactional="true">
      <pattern>/nuxeo/json/cmis(/.*)?(\?.*)?</pattern>
    </filterConfig>
  </extension>

(1) nuxeo-opencmis-bindings-2023.10.13.jar/OSGI-INF/json-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">

    <filterConfig name="SeamRemoting" synchonize="false" transactional="true">
      <pattern>/nuxeo/seam/resource/remoting/execute.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="SeamRemotingInterface">
     <pattern>/nuxeo/seam/resource/remoting/interface.js.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="tinymce">
      <pattern>/nuxeo/tinymce.*</pattern>
    </filterConfig>

  </extension>

(2) nuxeo-platform-ui-web-2023.10.13.jar/OSGI-INF/request-controler-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">

    <filterConfig cacheTime="31536000" cached="true" name="cachednxfile" private="true" synchonize="false" transactional="false">
      <!-- if url contains doc changeToken: approximately one year -->
      <!-- transaction is manually handled in DownloadServlet -->
      <pattern>/nuxeo/nxfile/.*\\?.*changeToken=.+</pattern>
    </filterConfig>
    <filterConfig cacheTime="0" cached="true" name="nxfile" private="true" synchonize="false" transactional="false">
      <!-- transaction is manually handled in DownloadServlet -->
      <pattern>/nuxeo/nxfile/.*</pattern>
    </filterConfig>
    <filterConfig cached="true" name="BigFileDownloaderRequest" private="true" synchonize="false" transactional="false">
      <!-- transaction is manually handled in DownloadServlet -->
      <pattern>/nuxeo/nxbigfile/.*</pattern>
    </filterConfig>

    <filterConfig cached="true" name="BigZipFileDownloaderRequest" private="true" synchonize="true" transactional="true">
      <pattern>/nuxeo/nxbigzipfile/.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="img">
      <pattern>/nuxeo/img.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="icons">
      <pattern>/nuxeo/icons.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="js">
      <pattern>/nuxeo/js.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="scripts">
      <pattern>/nuxeo/scripts.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="waitdialog">
      <pattern>/nuxeo/waitdialog.*</pattern>
    </filterConfig>

    <filterConfig cacheTime="31536000" cached="true" name="cachedBPR" private="true" transactional="true">
      <!-- if url contains doc changeToken: approximately one year -->
      <pattern>/nuxeo/.*/@(blob|preview|rendition).*\\?.*changeToken=.+</pattern>
    </filterConfig>

    <filterConfig cacheTime="0" cached="true" name="BPR" private="true" transactional="true">
      <pattern>/nuxeo/.*/@(blob|preview|rendition).*</pattern>
    </filterConfig>

    <filterConfig cached="false" name="nxadmin" private="true">
      <pattern>/nuxeo/nxadmin/.*</pattern>
    </filterConfig>

  </extension>

(3) nuxeo-platform-web-common-2023.10.13.jar/OSGI-INF/web-request-controller-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">

    <filterConfig cacheTime="3600" cached="true" name="cachednxfile" private="true" synchonize="false" transactional="false">
      <pattern>/nuxeo/nxfile/.*\\?.*changeToken=.+</pattern>
    </filterConfig>

    <filterConfig cacheTime="3600" cached="true" name="cachedBPR" private="true" transactional="true">
      <pattern>/nuxeo/.*/@(blob|preview|rendition).*\\?.*changeToken=.+</pattern>
    </filterConfig>

  </extension>

(4) nuxeo-core-binarymanager-s3-2023.10.13.jar/OSGI-INF/s3web-request-controller-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">
    <filterConfig cacheTime="31536000" cached="true" name="cached_ui_static">
      <!-- if url contains a timestamp param: approximately one year -->
      <pattern>/nuxeo/ui/.*\\?.*ts=.+</pattern>
    </filterConfig>
    <filterConfig cacheTime="86400" cached="true" name="ui_static">
      <!-- For other web ui resources: trade off between agressive caching and HF applying within 24 hours -->
      <!-- Exclude JS and HTML files due to: https://jira.nuxeo.com/browse/NXP-25595 -->
      <pattern>/nuxeo/ui/.*\.(?!(html|js|jsp)$).*</pattern>
    </filterConfig>
  </extension>

(5) nuxeo-web-ui-3.1.7.jar/OSGI-INF/browser-cache-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">

    <filterConfig name="WebDAV" synchonize="false" transactional="true">
      <pattern>/nuxeo/site/dav.*</pattern>
    </filterConfig>

  </extension>

(6) nuxeo-webdav-2023.10.13.jar/OSGI-INF/request-controller-contrib.xml Override

<extension point="filterConfig" target="org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService">
    <filterConfig name="webengine" synchonize="false" transactional="true">
      <pattern>/nuxeo/site.*</pattern>
    </filterConfig>
  </extension>

(7) nuxeo-webengine-core-2023.10.13.jar/OSGI-INF/webengine-framework.xml Override