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
Converts files to pdf type. This pipe has two actions convert and combine.
With combine action you can attach files into main pdf file.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from class org.frankframework.pipes.AbstractPipe
parameterNamesMustBeUnique
Fields inherited from class org.frankframework.core.TransactionAttributes
log
Fields inherited from interface org.frankframework.core.IPipe
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Checks for correct configuration of forward.doPipe
(Message input, PipeLineSession session) This is where the action takes place.void
setAction
(PdfPipe.DocumentAction action) void
setCharset
(String charset) charset to be used to decode the given input message in case the input is not binary but character streamvoid
setConversionResultDocumentSessionKey
(String conversionResultDocumentSessionKey) The session key used to store the main conversion result document.void
setConversionResultFilesSessionKey
(String conversionResultFilesSessionKey) The session-key in which result files are stored when documents are converted to PDF.void
setFilenameToAttachSessionKey
(String filenameToAttachSessionKey) session key that contains the filename to be attached.void
setFontsDirectory
(String fontsDirectory) fonts folder to load the fonts.void
setLicense
(String license) aspose license location including the file name.void
setLoadExternalResources
(boolean loadExternalResources) when set to true, external resources, such as stylesheets and images found in HTML pages, will be loaded from the internetvoid
setMainDocumentSessionKey
(String mainDocumentSessionKey) session key that contains the document that the attachments will be attached to.void
setPdfOutputLocation
(String pdfOutputLocation) directory to save resulting pdf files after conversion.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 separatelyvoid
setUnpackCommonFontsArchive
(boolean unpackDefaultFonts) Methods inherited from class org.frankframework.pipes.FixedForwardPipe
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
Methods inherited from class org.frankframework.pipes.AbstractPipe
addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, start, stop, throwEvent
Methods inherited from class org.frankframework.core.TransactionAttributes
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.frankframework.core.HasApplicationContext
getApplicationContext, getConfigurationClassLoader
Methods inherited from interface org.frankframework.core.HasTransactionAttribute
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
Methods inherited from interface org.frankframework.core.IForwardTarget
getName
Methods inherited from interface org.frankframework.core.IPipe
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getHideRegex, getLocker, getLogIntermediaryResults, getMaxThreads, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine, throwEvent
-
Constructor Details
-
PdfPipe
public PdfPipe()
-
-
Method Details
-
configure
Description copied from class:FixedForwardPipe
Checks for correct configuration of forward.- Specified by:
configure
in interfaceIConfigurable
- Overrides:
configure
in classFixedForwardPipe
- Throws:
ConfigurationException
- in case it was not able to configure the component.
-
doPipe
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. If the result of the Pipe does not depend on the input, like for theFixedResultPipe
, the Pipe can schedule the input to be closed at session exit, by callingMessage.closeOnCloseOf(PipeLineSession)
This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.- Throws:
PipeRunException
-
setAction
-
setMainDocumentSessionKey
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
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
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()
false
then only the main document is stored in the session, if it istrue
then each attachment is stored separately.For example, if a file is converted that has 2 attachments and
setSaveSeparate(boolean)
is set totrue
then there will be the following 3 session keys (assuming the default value is unchanged):pdfConversionResultFiles1
pdfConversionResultFiles2
pdfConversionResultFiles3
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
session key that contains the filename to be attached. Only used when the action is set to 'combine'- Default value
- defaultFileNameToAttachSessionKey
-
setFontsDirectory
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
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
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
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
-