Package com.saperion.connector.render.engine

Interface RenderEngine

  • All Known Implementing Classes:
    BaseRenderEngine, ISYSRenderEngine
    public interface RenderEngine
    Interface which is used by the ServiceLoader to determine Render Engines.

    • Method Detail

      • render

        java.util.List<Rendition> render​(InputStreamDescriptor content,
                                 Options options)
                          throws java.util.concurrent.TimeoutException,
                                 RenderingException
        Loads the content that should be rendered with the specified options and creates the list containing the renditions.
        Parameters:
        content - Content as InputStreamDescriptor which should be rendered incl. filename
        options - Options which are describing how to render the content
        Returns:
        the collection of Rendition instances which represent rendered content incl. informations
        Throws:
        java.util.concurrent.TimeoutException - if a timeout was specified and it was reached
        RenderingException - if engine is not available or internal initialization failures

      • supportsSourceFormat

        boolean supportsSourceFormat​(SourceFormat format)
        Checks if the source format is supported.
        Parameters:
        format - the source format to be checked
        Returns:
        true if the SourceFormat which was recognized from the content filename is supported

      • supportsTargetFormat

        boolean supportsTargetFormat​(TargetFormat format)
        Checks if the target format is supported.
        Parameters:
        format - the target format to be checked
        Returns:
        true if the TargetFormat which specifies how to render is supported

      • getSupportedSourceFormats

        java.util.Set<SourceFormat> getSupportedSourceFormats()
        Gets the supported source formats.
        Returns:
        returns all SourceFormat supported by the render engine

      • getSupportedTargetFormats

        java.util.Set<TargetFormat> getSupportedTargetFormats()
        Gets the supported target formats.
        Returns:
        returns all TargetFormat supported by the render engine

      • configure

        void configure​(java.util.Map<java.lang.String,​java.lang.String> properties)
        Configures the rendering engine with the specified properties.
        Parameters:
        properties - Configuration for the Render Engine