Platform Explorer / CMF 1.8

Extension point urlpatterns

Documentation

URL patterns are used on the web layer to perform actions when a url is entered, and to rewrite urls after a post.

They are designed to use a given codec.

Contribution Descriptors

  • Class: org.nuxeo.ecm.platform.ui.web.rest.descriptors.URLPatternDescriptor

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.

  • nuxeo-platform-webapp-core-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
        <documentation>
          Basic pattern for download: it resolve the file on given property of given
          document and makes its available for download.
        </documentation>
    
        <urlPattern enabled="true" name="downloadFile">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>false</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>downloadFile</codecName>
          <actionBinding>#{documentActions.download}</actionBinding>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>#{restHelper.newDocumentView}</newDocumentViewBinding>
        </urlPattern>
    
        <!-- TODO: add patterns for pdf + edit online links -->
    
      </extension>
  • nuxeo-case-management-web-1.8.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
    
        <documentation>
          Override default document view to provide currentEmail info
        </documentation>
    
        <!-- override: component does not implement merging -->
        <urlPattern enabled="false" name="default"/>
    
        <urlPattern enabled="true" name="cm">
          <defaultURLPolicy>true</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>docpath</codecName>
          <actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.newDocumentView}
          </newDocumentViewBinding>
          <bindings>
            <binding name="tabId">#{webActions.currentTabId}</binding>
            <binding name="subTabId">#{webActions.currentSubTabId}</binding>
            <binding name="currentCaseItemId">#{cmContextActions.currentCaseItemId}</binding>
            <binding name="tabIds">#{webActions.currentTabIds}</binding>
          </bindings>
        </urlPattern>
    
      </extension>
  • nuxeo-platform-imaging-dm-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
        <urlPattern enabled="true" name="downloadPicture">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>false</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>downloadPicture</codecName>
          <actionBinding>#{pictureManager.download}</actionBinding>
          <documentViewBinding>
            #{restHelper.documentView}
          </documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.newDocumentView}
          </newDocumentViewBinding>
        </urlPattern>
      </extension>
  • nuxeo-user-center-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
    
        <urlPattern enabled="true" name="home">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>docpathhome</codecName>
          <actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
          <documentViewBindingApplies>
            #{mainTabsActions.isOnMainTab('home')}
          </documentViewBindingApplies>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.getNewDocumentView(null)}
          </newDocumentViewBinding>
          <bindings>
            <binding callGetter="false" name="tabId">
              #{webActions.currentTabId}
            </binding>
            <binding callGetter="false" name="subTabId">
              #{webActions.currentSubTabId}
            </binding>
            <binding name="tabIds">#{webActions.currentTabIds}</binding>
            <binding callGetter="false" name="language">
              #{restHelper.localeString}
            </binding>
          </bindings>
        </urlPattern>
    
      </extension>
  • nuxeo-platform-ui-web-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
    
        <documentation>
          Basic url pattern using the doc id codec: it places the application in the
          document context described by the url and sets current tabs.
    
          Additional url pattern using the doc path codec.
        </documentation>
    
        <urlPattern enabled="true" name="id">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>docid</codecName>
          <actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.newDocumentView}
          </newDocumentViewBinding>
          <bindings>
            <binding callGetter="false" name="tabId">
              #{webActions.currentTabId}
            </binding>
            <binding callGetter="false" name="subTabId">
              #{webActions.currentSubTabId}
            </binding>
            <binding name="tabIds">#{webActions.currentTabIds}</binding>
            <binding callGetter="false" name="language">
              #{restHelper.localeString}
            </binding>
          </bindings>
        </urlPattern>
    
        <urlPattern enabled="true" name="default">
          <defaultURLPolicy>true</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>docpath</codecName>
          <actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.newDocumentView}
          </newDocumentViewBinding>
          <bindings>
            <binding callGetter="false" name="tabId">
              #{webActions.currentTabId}
            </binding>
            <binding callGetter="false" name="subTabId">
              #{webActions.currentSubTabId}
            </binding>
            <binding name="tabIds">#{webActions.currentTabIds}</binding>
            <binding callGetter="false" name="language">
              #{restHelper.localeString}
            </binding>
            <binding callGetter="false" name="mainTabId">
              #{webActions.currentTabIds}
            </binding>
          </bindings>
        </urlPattern>
    
      </extension>
  • nuxeo-platform-faceted-search-dm-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
    
        <urlPattern enabled="true" name="facetedSearch">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>facetedSearch</codecName>
          <actionBinding>
            #{facetedSearchPermanentLinkActions.loadPermanentLink}
          </actionBinding>
          <bindings>
            <binding name="contentViewName">
              #{facetedSearchActions.currentContentViewName}
            </binding>
            <binding name="values">#{facetedSearchActions.filterValues}</binding>
          </bindings>
        </urlPattern>
    
      </extension>
  • nuxeo-admin-center-5.4.2-HF05.jar
    <extension point="urlpatterns" target="org.nuxeo.ecm.platform.ui.web.rest.URLService">
    
        <urlPattern enabled="true" name="admin">
          <defaultURLPolicy>false</defaultURLPolicy>
          <needBaseURL>true</needBaseURL>
          <needRedirectFilter>true</needRedirectFilter>
          <needFilterPreprocessing>true</needFilterPreprocessing>
          <codecName>docpathadmin</codecName>
          <actionBinding>#{restHelper.initContextFromRestRequest}</actionBinding>
          <documentViewBindingApplies>
            #{mainTabsActions.isOnMainTab('admin')}
          </documentViewBindingApplies>
          <documentViewBinding>#{restHelper.documentView}</documentViewBinding>
          <newDocumentViewBinding>
            #{restHelper.getNewDocumentView(null)}
          </newDocumentViewBinding>
          <bindings>
            <binding callGetter="false" name="tabId">
              #{webActions.currentTabId}
            </binding>
            <binding callGetter="false" name="subTabId">
              #{webActions.currentSubTabId}
            </binding>
            <binding name="tabIds">#{webActions.currentTabIds}</binding>
            <binding callGetter="false" name="language">
              #{restHelper.localeString}
            </binding>
          </bindings>
        </urlPattern>
    
      </extension>