Package org.alfresco.rest.api

Interface Renditions

All Known Implementing Classes:
RenditionsImpl
public interface Renditions
Renditions API
Author:
Jamal Kaabi-Mofrad, janv

  • Field Details

  • Method Details

    • getRenditions

      CollectionWithPagingInfo<Rendition> getRenditions(NodeRef nodeRef, Parameters parameters)
      Lists all available renditions includes those that have been created and those that are yet to be created.
      Parameters:
      nodeRef - the source/live nodeRef
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition results

    • getRenditions

      CollectionWithPagingInfo<Rendition> getRenditions(NodeRef nodeRef, String versionId, Parameters parameters)
      Lists all available renditions includes those that have been created and those that are yet to be created.
      Parameters:
      nodeRef - the source/live nodeRef
      versionId - the version id (aka version label)
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition results

    • getRendition

      Rendition getRendition(NodeRef nodeRef, String renditionId, Parameters parameters)
      Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the Rendition object

    • getRendition

      Rendition getRendition(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters)
      Gets information about a rendition of a node in the repository. If there is no rendition, then returns the available/registered rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the Rendition object

    • createRendition

      void createRendition(NodeRef nodeRef, Rendition rendition, Parameters parameters)
      Creates a rendition for the given node asynchronously.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      rendition - the Rendition request
      parameters - the Parameters object to get the parameters passed into the request

    • createRendition

      void createRendition(NodeRef nodeRef, Rendition rendition, boolean executeAsync, Parameters parameters)
      Creates a rendition for the given node - either async r sync
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      rendition - the Rendition request
      executeAsync -
      parameters -

    • createRendition

      void createRendition(NodeRef nodeRef, String versionId, Rendition rendition, boolean executeAsync, Parameters parameters)
      Creates a rendition for the given node - either async r sync
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      rendition - the Rendition request
      executeAsync -
      parameters -

    • createRenditions

      void createRenditions(NodeRef nodeRef, List<Rendition> renditions, Parameters parameters) throws NotFoundException, ConstraintViolatedException
      Creates renditions that don't already exist for the given node asynchronously.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      renditions - the list of Rendition requests
      parameters - the Parameters object to get the parameters passed into the request
      Throws:
      NotFoundException - if any of the rendition id do not exist.
      ConstraintViolatedException - if all of the renditions already exist.

    • createRenditions

      void createRenditions(NodeRef nodeRef, String versionId, List<Rendition> renditions, Parameters parameters) throws NotFoundException, ConstraintViolatedException
      Creates renditions that don't already exist for the given node asynchronously.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      renditions - the list of Rendition requests
      parameters - the Parameters object to get the parameters passed into the request
      Throws:
      NotFoundException - if any of the rendition id do not exist.
      ConstraintViolatedException - if all of the renditions already exist.

    • deleteRendition

      void deleteRendition(NodeRef nodeRef, String renditionId, Parameters parameters)
      Delete the rendition node.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request

    • deleteRendition

      void deleteRendition(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters)
      Delete the rendition node.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request

    • getContent

      BinaryResource getContent(NodeRef nodeRef, String renditionId, Parameters parameters)
      Downloads rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition stream

    • getContent

      BinaryResource getContent(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters)
      Downloads rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition stream

    • getContentNoValidation

      BinaryResource getContentNoValidation(NodeRef nodeRef, String renditionId, Parameters parameters)
      Downloads rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition stream

    • getContentNoValidation

      BinaryResource getContentNoValidation(NodeRef nodeRef, String versionId, String renditionId, Parameters parameters)
      Downloads rendition.
      Parameters:
      nodeRef - the source nodeRef, ie. live node
      versionId - the version id (aka version label)
      renditionId - the rendition id
      parameters - the Parameters object to get the parameters passed into the request
      Returns:
      the rendition stream

    • requestContentDirectUrl

      default DirectAccessUrl requestContentDirectUrl(String nodeId, String versionId, String renditionId, boolean attachment)
      Gets a presigned URL to directly access content.
      Parameters:
      nodeId - the node id for which to obtain the direct access URL
      versionId - the version id (aka version label)
      renditionId - the rendition id
      attachment - true if an attachment URL is requested, false for an embedded URL
      Returns:
      a direct access URL object for the content

    • requestContentDirectUrl

      default DirectAccessUrl requestContentDirectUrl(String nodeId, String versionId, String renditionId, boolean attachment, Long validFor)
      Gets a presigned URL to directly access content.
      Parameters:
      nodeId - the node id for which to obtain the direct access URL
      versionId - the version id (aka version label)
      renditionId - the rendition id
      attachment - true if an attachment URL is requested, false for an embedded URL
      validFor - the time at which the direct access URL will expire
      Returns:
      a direct access URL object for the content

    • requestContentDirectUrl

      default DirectAccessUrl requestContentDirectUrl(NodeRef nodeRef, String versionId, String renditionId, boolean attachment)
      Gets a presigned URL to directly access content.
      Parameters:
      nodeRef - the node reference for which to obtain the direct access URL
      versionId - the version id (aka version label)
      renditionId - the rendition id
      attachment - true if an attachment URL is requested, false for an embedded URL
      Returns:
      a direct access URL object for the content.

    • requestContentDirectUrl

      default DirectAccessUrl requestContentDirectUrl(NodeRef nodeRef, String versionId, String renditionId, boolean attachment, Long validFor)
      Parameters:
      nodeRef - the node reference for which to obtain the direct access URL
      versionId - the version id (aka version label)
      renditionId - the rendition id
      attachment - true if an attachment URL is requested, false for an embedded URL
      validFor - the time at which the direct access URL will expire
      Returns:
      a direct access URL object for the content.

    • requestContentDirectUrl

      DirectAccessUrl requestContentDirectUrl(NodeRef nodeRef, String versionId, String renditionId, boolean attachment, Long validFor, String fileName)
      Gets a presigned URL to directly access content.
      Parameters:
      nodeRef - the node reference for which to obtain the direct access URL
      versionId - the version id (aka version label)
      renditionId - the rendition id
      attachment - true if an attachment URL is requested, false for an embedded URL
      validFor - the time at which the direct access URL will expire
      fileName - optional name for the file when downloaded
      Returns:
      a direct access URL object for the content.