Package org.alfresco.service.cmr.rendition

Interface RenditionService

All Superinterfaces:
RenditionDefinitionPersister
All Known Implementing Classes:
RenditionServiceImpl
@Deprecated @AlfrescoPublicApi public interface RenditionService extends RenditionDefinitionPersister
Deprecated.
The RenditionService is being replace by the simpler async RenditionService2.
The Rendition service.
Author:
Nick Smith, Neil McErlean

  • Field Details

    • PARAM_DESTINATION_NODE

      static final String PARAM_DESTINATION_NODE
      Deprecated.
      This optional NodeRef parameter specifies an existing NodeRef to use as the rendition node. Properties on this node (including the content property cm:content) will be updated as required but the location and name of the node will not change. This parameter takes precedence over PARAM_DESTINATION_PATH_TEMPLATE.
      See Also:

    • PARAM_DESTINATION_PATH_TEMPLATE

      static final String PARAM_DESTINATION_PATH_TEMPLATE
      Deprecated.
      This optional String parameter indicates where the rendition will be created. The parameter may specify either the actual file path to the rendition or it may specify a Freemarker template which can be resolved to a file path. In either case the path is relative to the root node of the store in which the source node exists. If the parameter PARAM_DESTINATION_NODE has been set then this parameter will be ignored.
      See Also:

    • PARAM_RENDITION_NODETYPE

      static final String PARAM_RENDITION_NODETYPE
      Deprecated.
      This optional QName parameter specifies what the node type of the created rendition will be. If no type is specified then this defaults to cm:content.
      See Also:

    • PARAM_ORPHAN_EXISTING_RENDITION

      static final String PARAM_ORPHAN_EXISTING_RENDITION
      Deprecated.
      This optional Boolean flag parameter determines whether an existing rendition is moved or orphaned. If the source node already has a rendition and this parameter is false the old rendition will be moved to the new destination location and updated appropriately. If this parameter is set to true then the old rendition will be left in its current location and the rold rendition association from the source node to the old rendition will be deleted.
      See Also:

    • PARAM_IS_COMPONENT_RENDITION

      static final String PARAM_IS_COMPONENT_RENDITION
      Deprecated.
      This optional boolean parameter specified whether the rendition is a component within a composite rendition. Such component renditions should not execute the standard pre- and post-rendition behaviour as it will be taken care of by the CompositeRenderingEngine's execution.
      See Also:

  • Method Details

    • getRenderingEngineDefinition

      @NotAuditable RenderingEngineDefinition getRenderingEngineDefinition(String name)
      Deprecated.
      Returns the RenderingEngineDefinition associated with the specified rendering engine name.
      Parameters:
      name - The rendering engine name.
      Returns:
      The RenderingEngineDefinition or null.

    • getRenderingEngineDefinitions

      @NotAuditable List<RenderingEngineDefinition> getRenderingEngineDefinitions()
      Deprecated.
      Returns:
      A List of all available RenderingEngineDefinition s.

    • createRenditionDefinition

      @NotAuditable RenditionDefinition createRenditionDefinition(QName renditionName, String renderingEngineName)
      Deprecated.
      Creates a new RenditionDefinition and sets the rendition name and the rendering engine name to the specified values.
      Parameters:
      renditionName - A unique identifier used to specify the created RenditionDefinition.
      renderingEngineName - The name of the rendering engine associated with this RenditionDefinition.
      Returns:
      the created RenditionDefinition.

    • createCompositeRenditionDefinition

      @NotAuditable CompositeRenditionDefinition createCompositeRenditionDefinition(QName renditionName)
      Deprecated.
      Creates a new CompositeRenditionDefinition and sets the rendition name and the rendering engine name to the specified values.
      Parameters:
      renditionName - A unique identifier used to specify the created RenditionDefinition.
      Returns:
      the created CompositeRenditionDefinition.

    • getRenditions

      @NotAuditable List<ChildAssociationRef> getRenditions(NodeRef node)
      Deprecated.
      This method gets all the renditions of the specified node.
      Returns:
      a list of ChildAssociationRefs which link the source node to the renditions.

    • getRenditions

      @NotAuditable List<ChildAssociationRef> getRenditions(NodeRef node, String mimeTypePrefix)
      Deprecated.
      This method gets all the renditions of the specified node filtered by MIME-type prefix. Renditions whose MIME-type string startsWith the prefix will be returned.
      Parameters:
      node - the source node for the renditions
      mimeTypePrefix - a prefix to check against the rendition MIME-types. This must not be null and must not be an empty String
      Returns:
      a list of ChildAssociationRefs which link the source node to the filtered renditions.

    • getRenditionByName

      @NotAuditable ChildAssociationRef getRenditionByName(NodeRef node, QName renditionName)
      Deprecated.
      This method gets the rendition of the specified node identified by the provided rendition name.
      Parameters:
      node - the source node for the renditions
      renditionName - the renditionName used to identify a rendition.
      Returns:
      the ChildAssociationRef which links the source node to the rendition or null if there is no such rendition.

    • isRendition

      @NotAuditable boolean isRendition(NodeRef node)
      Deprecated.
      This method returns true if the specified NodeRef is a valid rendition node, else false. A nodeRef is a rendition node if it has the rn:rendition aspect (or sub-aspect) applied.
      Parameters:
      node - NodeRef
      Returns:
      true if a rendition, else false

    • getSourceNode

      @NotAuditable ChildAssociationRef getSourceNode(NodeRef renditionNode)
      Deprecated.
      This method gets the source node for the specified rendition node. There should only be one source node for any given rendition node.
      Parameters:
      renditionNode - the nodeRef holding the rendition.
      Returns:
      the ChildAssociationRef whose parentNodeRef is the source node, or null if there is no source node.
      See Also:

    • render

      @NotAuditable ChildAssociationRef render(NodeRef sourceNode, RenditionDefinition renditionDefinition)
      Deprecated.
      This method synchronously renders content as specified by the given RenditionDefinition. The content to be rendered is provided by the specified source node.
      Parameters:
      sourceNode - the node from which the content is retrieved.
      renditionDefinition - this fully specifies the rendition which is to be performed.
      Returns:
      a child association reference which is the link from the source node to the newly rendered content.
      Throws:
      RenditionServiceException - if there is a problem in rendering the given sourceNode

    • render

      @NotAuditable void render(NodeRef sourceNode, RenditionDefinition renditionDefinition, RenderCallback callback)
      Deprecated.
      This method asynchronously renders content as specified by the given RenditionDefinition. The content to be rendered is provided by the specified source node.
      Parameters:
      sourceNode - the node from which the content is retrieved.
      renditionDefinition - this fully specifies the rendition which is to be performed.
      callback - a callback object to handle the ultimate result of the rendition.

    • render

      @NotAuditable ChildAssociationRef render(NodeRef sourceNode, QName renditionDefinitionQName)
      Deprecated.
      This method synchronously renders content as specified by the given rendition name. The content to be rendered is provided by the specified source node.

      The Rendition Definition will be loaded from the standard location as system thus allowing rendition definitions to be used even when the Data Dictionary has restricted read access.

      Parameters:
      sourceNode - the node from which the content is retrieved.
      renditionDefinitionQName - the rendition definition which is to be performed.
      Returns:
      a child association reference which is the link from the source node to the newly rendered content.
      Throws:
      RenditionServiceException - if there is a problem in rendering the given sourceNode
      Since:
      3.4.2

    • render

      @NotAuditable void render(NodeRef sourceNode, QName renditionDefinitionQName, RenderCallback callback)
      Deprecated.
      This method asynchronously renders content as specified by the given rendition definition name. The content to be rendered is provided by the specified source node.

      The Rendition Definition will be loaded from the standard location as system thus allowing rendition definitions to be used even when the Data Dictionary has restricted read access.

      Parameters:
      sourceNode - the node from which the content is retrieved.
      renditionDefinitionQName - the rendition definition which is to be performed.
      callback - a callback object to handle the ultimate result of the rendition.
      Since:
      3.4.2

    • cancelRenditions

      @NotAuditable void cancelRenditions(NodeRef sourceNode)
      Deprecated.
      Cancels all known cancellable running renditions for the given NodeRef via the ActionTrackingService.
      Parameters:
      sourceNode - the NodeRef the action is acting on
      Since:
      4.1.6

    • cancelRenditions

      @NotAuditable void cancelRenditions(NodeRef sourceNode, String type)
      Deprecated.
      Cancels all known cancellable running renditions for the given NodeRef and type via the ActionTrackingService.
      Parameters:
      sourceNode - the NodeRef the action is acting on
      type - the rendition type (rending engine name)
      Since:
      4.1.6

    • usingRenditionService2

      @NotAuditable boolean usingRenditionService2(NodeRef sourceNodeRef, RenditionDefinition rendDefn)
      Deprecated.
      If a rendition has been created by the newer RenditionService2, this method will return true. In this case the original RenditionService should not be used to update an existing rendition if the content changes. These renditions can be identified by the existence of the rendition2 aspect. RenditionService2 also listens for content changes and will perform the rendition.

      If RenditionService2 has a definition with the same name (matched on the local part of the supplied rendDef's name) and the target mimetype matches, RenditionService2 will also be used. This is being done to help with the conversion of custom transformers and renditions. The basic definitions (called "medium", "doclib", "imgpreview", "avatar", "avatar32", "webpreview", "pdf") already exist. Rather than writing a converter form one definition to the newer one, it is suggested that a newer RenditionDefinition2 is simply defined to avoid having to worry about any complexities in converting TransformationOptions into a simple flat Map structure.