Platform Explorer / Nuxeo Platform 5.6

Extension point codecs

Codecs perform the translation between a url and a document view that holds information about the document context as well as other parameters (current tab for instance).

Contribution Descriptor

Existing Contributions

  • nuxeo-social-workspace-web-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentation>
          Codec used for collaboration tab.
          Urls are of the form http://site/nuxeo/collaboration/path/to/doc@view?extraargs
        </documentation>
    
        <documentViewCodec class="org.nuxeo.ecm.social.workspace.CollaborationCodec" default="false" enabled="true" name="doccollaboration" prefix="collaboration"/>
    
      </extension>
  • nuxeo-platform-url-core-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
        <documentation>
          The docid codec uses the document uid to resolve the context. Urls are of
          the form http://site/nuxeo/nxdoc/demo/docuid/view.
    
          The docpath codec uses the document path to resolve the context. Urls are
          of the form http://site/nuxeo/nxpath/demo/path/to/my/doc@view.
    
          The document file codec uses the document uid to resolve the document
          model and extract a file held in its properties. Urls are of the form
          http://site/nuxeo/nxfile/demo/docuid/file:content/mydoc.odt.
    
          We declare three codecs using this same class but different prefixes
          (nxfile, nxeditfile,...) so that we can define several url patterns,
          performing different actions, but still using the same syntax.
        </documentation>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentIdCodec" default="true" enabled="true" name="docid" prefix="nxdoc"/>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpath" prefix="nxpath"/>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="downloadFile" prefix="nxfile"/>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="editFile" prefix="nxeditfile"/>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="pdfFile" prefix="nxpdffile"/>
      </extension>
  • nuxeo-platform-faceted-search-dm-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.ecm.platform.faceted.search.dm.codec.FacetedSearchViewCodec" enabled="true" name="facetedSearch" prefix="nxsrch"/>
    
      </extension>
  • nuxeo-platform-imaging-jsf-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="downloadPicture" prefix="nxpicsfile"/>
      </extension>
  • nuxeo-user-center-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathhome" prefix="nxhome"/>
    
        <documentation>
          The user codec uses the given username to select and display a user.
          Urls are of the form http://site/nuxeo/user/username(/view).
    
          The view is optional, and defaults to view_home if not present.
        </documentation>
        <documentViewCodec class="org.nuxeo.ecm.user.center.UserCodec" default="false" enabled="true" name="user" prefix="user"/>
    
      </extension>
  • nuxeo-platform-preview-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
          
          <documentViewCodec class="org.nuxeo.ecm.platform.preview.codec.DocumentPreviewCodec" enabled="true" name="preview" prefix="restAPI/preview"/>
        </extension>
  • nuxeo-admin-center-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathadmin" prefix="nxadmin"/>
    
      </extension>
  • nuxeo-dam-web-5.6-RC3.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathdam" prefix="nxdam"/>
    
      </extension>
  • nuxeo-platform-document-routing-dashboard-5.6.jar
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentPathCodec" default="false" enabled="true" name="docpathworkflow" prefix="nxworkflow"/>
    
      </extension>