Package org.frankframework.core

Interface IBlockEnabledSender<H>

Type Parameters:

H - something shared for sending messages in a block, like a connection.

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters

All Known Implementing Classes:

BlockEnabledSenderBase, DirectQuerySender, FixedQuerySender, JdbcIteratingPipeBase.MixedQuerySender, JdbcQuerySenderBase, JdbcSenderBase, ResultSet2FileSender, StoredProcedureQuerySender, XmlQuerySender

public interface IBlockEnabledSender<H>
extends ISenderWithParameters

Allows to leverage sending messages in blocks.

Method Summary

Modifier and Type	Method	Description
void	closeBlock(H blockHandle, PipeLineSession session)	close the resource that is opened by openBlock(PipeLineSession).
H	openBlock(PipeLineSession session)	open a resource that can be used multiple times when sendMessage(Object, Message, PipeLineSession) is called.
SenderResult	sendMessage(H blockHandle, Message message, PipeLineSession session)

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

close, configure, isSynchronous, open, sendMessage, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface org.frankframework.core.IWithParameters

addParameter, getParameterList

Method Details

openBlock

H openBlock(PipeLineSession session)
     throws SenderException,
TimeoutException

open a resource that can be used multiple times when sendMessage(Object, Message, PipeLineSession) is called.

Throws:

SenderException

TimeoutException

closeBlock

void closeBlock(H blockHandle,
 PipeLineSession session)
         throws SenderException

close the resource that is opened by openBlock(PipeLineSession). It is important that this method is always called after processing with the blockHandle ends. It should effectively be called in a finally clause of a try around the openBlock.

Throws:

SenderException

sendMessage

SenderResult sendMessage(H blockHandle,
 Message message,
 PipeLineSession session)
                  throws SenderException,
TimeoutException

Throws:

SenderException

TimeoutException