Package org.frankframework.extensions.aspose.pipe

Class PdfPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.extensions.aspose.pipe.PdfPipe
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
public class PdfPipe extends FixedForwardPipe
Converts files to pdf type. This pipe has two actions convert and combine. With combine action you can attach files into main pdf file.

  • Constructor Details

    • PdfPipe

      public PdfPipe()

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class FixedForwardPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • doPipe

      public PipeRunResult doPipe(Message input, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Throws:
      PipeRunException

    • setAction

      public void setAction(PdfPipe.DocumentAction action)

    • setMainDocumentSessionKey

      public void setMainDocumentSessionKey(String mainDocumentSessionKey)
      session key that contains the document that the attachments will be attached to. Only used when action is set to 'combine'
      Default value
      defaultMainDocumentSessionKey

    • setConversionResultDocumentSessionKey

      public void setConversionResultDocumentSessionKey(String conversionResultDocumentSessionKey)
      The session key used to store the main conversion result document. Only to be used when action is set to 'convert'.
      Parameters:
      conversionResultDocumentSessionKey - Name of the session key.
      Default value
      documents

    • setConversionResultFilesSessionKey

      public void setConversionResultFilesSessionKey(String conversionResultFilesSessionKey)
      The session-key in which result files are stored when documents are converted to PDF.

      Conversion result files are stored as messages in the session, under keys numbered based on the value set here. If

      invalid reference 
      #isSaveSeparate()
      is false then only the main document is stored in the session, if it is true then each attachment is stored separately.

      For example, if a file is converted that has 2 attachments and setSaveSeparate(boolean) is set to true then there will be the following 3 session keys (assuming the default value is unchanged):

      1. pdfConversionResultFiles1
      2. pdfConversionResultFiles2
      3. pdfConversionResultFiles3
      Each session key will contain a FileMessage referencing the contents of that PDF.

      Parameters:
      conversionResultFilesSessionKey - The name of the session key under which PDF documents are stored.
      Default value
      pdfConversionResultFiles

    • setFilenameToAttachSessionKey

      public void setFilenameToAttachSessionKey(String filenameToAttachSessionKey)
      session key that contains the filename to be attached. Only used when the action is set to 'combine'
      Default value
      defaultFileNameToAttachSessionKey

    • setFontsDirectory

      public void setFontsDirectory(String fontsDirectory)
      fonts folder to load the fonts. If not set then a temporary folder will be created to extract fonts from fonts.zip everytime. Having fontsDirectory to be set will improve startup time
      Default value
      null

    • setUnpackCommonFontsArchive

      public void setUnpackCommonFontsArchive(boolean unpackDefaultFonts)

    • setCharset

      @Deprecated(since="9.3.0", forRemoval=true) @ConfigurationWarning("Charset property will be removed in a future version. ") public void setCharset(String charset)
      Deprecated, for removal: This API element is subject to removal in a future version.
      charset to be used to decode the given input message in case the input is not binary but character stream
      Default value
      UTF-8

    • setLicense

      public void setLicense(String license)
      aspose license location including the file name. It can also be used without license but there some restrictions on usage. If license is in resource, license attribute can be license file name. If the license is in somewhere in filesystem then it should be full path to file including filename and starting with file://// prefix. classloader.allowed.protocols property should contain 'file' protocol

    • setSaveSeparate

      public void setSaveSeparate(boolean saveSeparate)
      when sets to false, converts the file including the attachments attached to the main file. when it is true, saves each attachment separately
      Default value
      false

    • setPdfOutputLocation

      public void setPdfOutputLocation(String pdfOutputLocation)
      directory to save resulting pdf files after conversion. If not set then a temporary directory will be created and the conversion results will be stored in that directory.
      Default value
      null

    • setLoadExternalResources

      public void setLoadExternalResources(boolean loadExternalResources)
      when set to true, external resources, such as stylesheets and images found in HTML pages, will be loaded from the internet
      Default value
      false