@ElementType(value=TRANSLATOR) public class StreamTransformerPipe extends FixedForwardPipe
Modifier and Type | Field and Description |
---|---|
static String |
originalBlockKey |
parameterNamesMustBeUnique
log
LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT
Constructor and Description |
---|
StreamTransformerPipe() |
Modifier and Type | Method and Description |
---|---|
protected void |
closeAllBlocks(PipeLineSession session,
String streamId,
IResultHandler handler,
Map<String,Object> blocks) |
void |
configure()
checks for correct configuration of forward
|
PipeRunResult |
doPipe(Message input,
PipeLineSession session)
Open a reader for the file named according the input messsage and transform it.
|
protected InputStream |
getInputStream(String streamId,
Message input,
PipeLineSession session) |
IRecordHandlerManager |
getManager(String name) |
protected BufferedReader |
getReader(String streamId,
Message input,
PipeLineSession session) |
IRecordHandler |
getRecordHandler(String name) |
IResultHandler |
getResultHandler(String name) |
protected String |
getStreamId(Message input,
PipeLineSession session) |
void |
registerChild(IRecordHandler handler)
Deprecated.
please use registerRecordHandler()
|
void |
registerChild(IRecordHandlerManager manager)
Deprecated.
please use registerManager
|
void |
registerChild(IResultHandler handler)
Deprecated.
Please use registerResultHandler()
|
void |
registerChild(RecordHandlingFlow flowEl)
Deprecated.
please use manager.addFlow()
|
void |
registerManager(IRecordHandlerManager manager)
Manager determines which handlers are to be used for the current line.
|
void |
registerRecordHandler(IRecordHandler handler)
Handler for transforming records of a specific type
|
void |
registerResultHandler(IResultHandler handler)
Handler for processing transformed records
|
void |
setCharset(String string)
Characterset used for reading file or inputstream"
|
void |
setCloseInputstreamOnExit(boolean b)
If set to
false , the inputstream is not closed after it has been used. |
void |
setReaderFactory(IReaderFactory factory)
Factory for the
reader . |
void |
setStoreOriginalBlock(boolean b)
If set
true the original block is stored under the session key originalBlock . |
void |
start()
Perform necessary action to start the pipe.
|
void |
stop()
Perform necessary actions to stop the
Pipe .For instance, closing JMS connections, DBMS connections etc. |
getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe
addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, throwEvent
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine
getMaxThreads
getName
getApplicationContext, getName
getConfigurationClassLoader
getName
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
public static final String originalBlockKey
protected String getStreamId(Message input, PipeLineSession session)
protected InputStream getInputStream(String streamId, Message input, PipeLineSession session) throws PipeRunException
PipeRunException
protected BufferedReader getReader(String streamId, Message input, PipeLineSession session) throws PipeRunException
PipeRunException
public void configure() throws ConfigurationException
FixedForwardPipe
configure
in interface IConfigurable
configure
in interface IPipe
configure
in class FixedForwardPipe
ConfigurationException
public void start() throws PipeStartException
IPipe
IPipe.configure()
method, for each start and stop command of the
adapter.start
in interface IPipe
start
in class AbstractPipe
PipeStartException
public void stop()
IPipe
Pipe
.stop
in interface IPipe
stop
in class AbstractPipe
@Deprecated public void registerChild(IRecordHandlerManager manager) throws Exception
Exception
public void registerManager(IRecordHandlerManager manager) throws Exception
Exception
public IRecordHandlerManager getManager(String name)
@Deprecated public void registerChild(RecordHandlingFlow flowEl) throws Exception
Exception
@Deprecated public void registerChild(IRecordHandler handler) throws Exception
Exception
public void registerRecordHandler(IRecordHandler handler) throws Exception
Exception
public IRecordHandler getRecordHandler(String name)
@Deprecated public void registerChild(IResultHandler handler) throws Exception
Exception
public void registerResultHandler(IResultHandler handler) throws Exception
Exception
public IResultHandler getResultHandler(String name)
public PipeRunResult doPipe(Message input, PipeLineSession session) throws PipeRunException
doPipe
in interface IPipe
doPipe
in class AbstractPipe
PipeRunException
IPipe.doPipe(Message, PipeLineSession)
protected void closeAllBlocks(PipeLineSession session, String streamId, IResultHandler handler, Map<String,Object> blocks) throws Exception
Exception
public void setStoreOriginalBlock(boolean b)
true
the original block is stored under the session key originalBlock
.public void setCloseInputstreamOnExit(boolean b)
false
, the inputstream is not closed after it has been used.public void setCharset(String string)
public void setReaderFactory(IReaderFactory factory)
reader
. The default implementation InputStreamReaderFactory
converts using the specified character set.Copyright © 2023 Frank!Framework. All rights reserved.