nl.nn.adapterframework.extensions.aspose.pipe

Class PdfPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.extensions.aspose.pipe.PdfPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PdfPipe.DocumentAction

Field Summary

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
PdfPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message input, PipeLineSession session) This is where the action takes place.
void	setAction(PdfPipe.DocumentAction action)
void	setCharset(String charset)
void	setFilenameToAttachSessionKey(String filenameToAttachSessionKey)
void	setFileNameToAttachSessionKey(String fileNameToAttachSessionKey) Deprecated.
void	setFontsDirectory(String fontsDirectory)
void	setLicense(String license)
void	setLoadExternalResources(boolean loadExternalResources)
void	setMainDocumentSessionKey(String mainDocumentSessionKey)
void	setPdfOutputLocation(String pdfOutputLocation)
void	setSaveSeparate(boolean saveSeparate)
void	setUnpackCommonFontsArchive(boolean unpackDefaultFonts)

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getLogPrefix, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.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 nl.nn.adapterframework.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

Methods inherited from interface nl.nn.adapterframework.core.IPipe

getMaxThreads

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface nl.nn.adapterframework.core.IForwardTarget

getName

Methods inherited from interface nl.nn.adapterframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

PdfPipe

public PdfPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

doPipe

public PipeRunResult doPipe(Message input,
                            PipeLineSession session)
                     throws PipeRunException

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

setAction

public void setAction(PdfPipe.DocumentAction action)

setMainDocumentSessionKey

@IbisDoc(value={"session key that contains the document that the attachments will be attached to. Only used when action is set to \'combine\'","defaultMainDocumentSessionKey"})
public void setMainDocumentSessionKey(String mainDocumentSessionKey)

setFileNameToAttachSessionKey

@Deprecated
 @ConfigurationWarning(value="attribute \'fileNameToAttachSessionKey\' is replaced with \'filenameToAttachSessionKey\'")
public void setFileNameToAttachSessionKey(String fileNameToAttachSessionKey)

Deprecated.

setFilenameToAttachSessionKey

@IbisDoc(value={"session key that contains the filename to be attached. Only used when the action is set to \'combine\' ","defaultFileNameToAttachSessionKey"})
public void setFilenameToAttachSessionKey(String filenameToAttachSessionKey)

setFontsDirectory

@IbisDoc(value={"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","null"})
public void setFontsDirectory(String fontsDirectory)

setUnpackCommonFontsArchive

public void setUnpackCommonFontsArchive(boolean unpackDefaultFonts)

setCharset

@IbisDoc(value={"charset to be used to decode the given input message in case the input is not binary but character stream","UTF-8"})
public void setCharset(String charset)

setLicense

@IbisDoc(value={"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",""})
public void setLicense(String license)

setSaveSeparate

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

setPdfOutputLocation

@IbisDoc(value={"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.","null"})
public void setPdfOutputLocation(String pdfOutputLocation)

setLoadExternalResources

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