Platform Explorer / Nuxeo Platform LTS 2015 7.10

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-rest-api-server-7.10-HF07.jar /OSGI-INF/docviewurl-service-contrib.xml
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
        <documentViewCodec class="org.nuxeo.ecm.restapi.server.jaxrs.RestDocumentViewCodec" default="false" enabled="true" name="restdocid"/>
      </extension>
  • nuxeo-template-rendering-web-7.10-HF02.jar /OSGI-INF/url-codec-contrib.xml
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
        <documentViewCodec class="org.nuxeo.template.web.url.TemplateRenderCodec" enabled="true" name="template" prefix="nxtemplate"/>
      </extension>
  • nuxeo-thumbnail-7.10.jar /OSGI-INF/thumbnail-codec-contrib.xml
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="downloadThumbnail" prefix="nxthumb"/>
      </extension>
  • nuxeo-search-ui-7.10-HF03.jar /OSGI-INF/search-url-service-contrib.xml
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentViewCodec class="org.nuxeo.search.ui.codec.SearchCodec" default="false" enabled="true" name="docpathsearch" prefix="nxsearch"/>
    
      </extension>
  • nuxeo-platform-preview-7.10-HF07.jar /OSGI-INF/docview-codec-contrib.xml
    <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-platform-url-core-7.10-HF01.jar /OSGI-INF/docviewurlservice-contrib.xml
    <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="editFile" prefix="nxeditfile"/>
        <documentViewCodec class="org.nuxeo.ecm.platform.url.codec.DocumentFileCodec" enabled="true" name="pdfFile" prefix="nxpdffile"/>
      </extension>
  • nuxeo-platform-imaging-jsf-7.10.jar /OSGI-INF/imaging-codec-contrib.xml
    <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-admin-center-7.10-HF07.jar /OSGI-INF/urlservice-contrib.xml
    <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-routing-dashboard-7.10.jar /OSGI-INF/document-routing-dashboard-urlservice-contrib.xml
    <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>
  • nuxeo-user-center-7.10-HF01.jar /OSGI-INF/urlservice-contrib.xml
    <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"/>
        <documentViewCodec class="org.nuxeo.ecm.user.center.GroupCodec" default="false" enabled="true" name="group" prefix="group"/>
    
      </extension>
  • nuxeo-platform-rendition-web-7.10.jar /OSGI-INF/url-codec-contrib.xml
    <extension point="codecs" target="org.nuxeo.ecm.platform.url.service.DocumentViewCodecService">
    
        <documentation>Declare codec for nxrendition urls</documentation>
    
        <documentViewCodec class="org.nuxeo.ecm.platform.rendition.url.DocumentRenditionCodec" enabled="true" name="rendition" prefix="nxrendition"/>
      </extension>