Package com.saperion.connector.renditions.isys

Class ISYSRenderEngine

java.lang.Object

com.saperion.connector.render.engine.BaseRenderEngine

com.saperion.connector.renditions.isys.ISYSRenderEngine

All Implemented Interfaces:

RenderEngine

public class ISYSRenderEngine
extends BaseRenderEngine

The ISYSRenderEngine uses the ISYS executable for rendering.

The following additional options are required:

• externalApplicationPath: Absolute path to the ISYS executable used for rendering.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	EXTERNAL_APPLICATION_PATH	Property used to define the absolute path of the external rendering-application.

Fields inherited from class com.saperion.connector.render.engine.BaseRenderEngine

DEFAULT_EXTENSION

Constructor Summary

Constructors

Constructor	Description
ISYSRenderEngine()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getPathToExecutable(Options options)
java.util.Set<SourceFormat>	getSupportedSourceFormats()	Gets the supported source formats.
java.util.Set<TargetFormat>	getSupportedTargetFormats()	Gets the supported target formats.
java.util.List<Rendition>	safeRender(InputStreamDescriptor content, SourceFormat format, Options options)	Creates the collection of Rendition instances which represent rendered content incl.

Methods inherited from class com.saperion.connector.render.engine.BaseRenderEngine

configure, createInputStreamDescriptor, createInputStreamDescriptor, getFileFromUrl, getProperties, parseExtension, render, supportsSourceFormat, supportsTargetFormat

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EXTERNAL_APPLICATION_PATH

public static final java.lang.String EXTERNAL_APPLICATION_PATH

Property used to define the absolute path of the external rendering-application.

See Also:

Constant Field Values

Constructor Detail

ISYSRenderEngine

public ISYSRenderEngine()

Method Detail

getSupportedSourceFormats

public java.util.Set<SourceFormat> getSupportedSourceFormats()

Description copied from interface: RenderEngine

Gets the supported source formats.

Returns:

returns all SourceFormat supported by the render engine

getSupportedTargetFormats

public java.util.Set<TargetFormat> getSupportedTargetFormats()

Description copied from interface: RenderEngine

Gets the supported target formats.

Returns:

returns all TargetFormat supported by the render engine

safeRender

public java.util.List<Rendition> safeRender(InputStreamDescriptor content,
                                            SourceFormat format,
                                            Options options)
                                     throws java.util.concurrent.TimeoutException,
                                            RenderingException

Description copied from class: BaseRenderEngine

Creates the collection of Rendition instances which represent rendered content incl. information.

Method to be implemented by the specific render engine.

Specified by:

safeRender in class BaseRenderEngine

Parameters:

content - Content as InputStreamDescriptor which should be rendered incl. filename

format - SourceFormat determined by the file extension

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

FormatNotSupportedException - if the input or output format is not supported

PreconditionFailedException - if parts of the options are missing

RenderingException - if engine is not available or internal initialization failures

getPathToExecutable

public static java.lang.String getPathToExecutable(Options options)
                                            throws PreconditionFailedException

Throws:

PreconditionFailedException