nl.nn.adapterframework.jdbc

Class FixedQuerySender

java.lang.Object

nl.nn.adapterframework.jndi.JndiBase

nl.nn.adapterframework.jdbc.JdbcFacade

nl.nn.adapterframework.jdbc.JdbcSenderBase<H>

nl.nn.adapterframework.jdbc.JdbcQuerySenderBase<QueryExecutionContext>

nl.nn.adapterframework.jdbc.FixedQuerySender

All Implemented Interfaces:

HasPhysicalDestination, IBlockEnabledSender<QueryExecutionContext>, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IXAEnabled, HasStatistics, IOutputStreamingSupport, IStreamingSender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ResultSet2FileSender

public class FixedQuerySender
extends JdbcQuerySenderBase<QueryExecutionContext>

QuerySender that assumes a fixed query, possibly with attributes.

NOTE: See DB2XMLWriter for Resultset!

Since:

4.1

Author:

Gerrit van Brakel

Parameters

All parameters present are applied to the query to be executed.

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.jdbc.JdbcQuerySenderBase

JdbcQuerySenderBase.QueryType

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.jdbc.JdbcQuerySenderBase

UNP_END, UNP_START

Fields inherited from class nl.nn.adapterframework.jdbc.JdbcSenderBase

connection, paramList

Fields inherited from class nl.nn.adapterframework.jndi.JndiBase

log

Constructor Summary

Constructors

Constructor and Description
FixedQuerySender()

Method Summary

Modifier and Type	Method and Description
protected boolean	canProvideOutputStream()
void	closeBlock(QueryExecutionContext blockHandle, PipeLineSession session) close the resource that is opened by IBlockEnabledSender.openBlock(PipeLineSession).
protected void	closeStatementSet(QueryExecutionContext statementSet, PipeLineSession session)
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
protected String	getQuery(Message message) Obtain a query to be executed.
QueryExecutionContext	openBlock(PipeLineSession session) open a resource that can be used multiple times when IBlockEnabledSender.sendMessage(Object, Message, PipeLineSession) is called.
protected QueryExecutionContext	prepareStatementSet(QueryExecutionContext blockHandle, Connection connection, Message message, PipeLineSession session)
PipeRunResult	sendMessage(Message message, PipeLineSession session, IForwardTarget next)
SenderResult	sendMessage(QueryExecutionContext blockHandle, Message message, PipeLineSession session)
protected PipeRunResult	sendMessageOnConnection(Connection connection, Message message, PipeLineSession session, IForwardTarget next)
void	setBatchSize(int batchSize) When set larger than 0 and used as a child of an IteratingPipe, then the database calls are made in batches of this size.
void	setQuery(String query) The SQL query text to be excecuted each time sendMessage() is called

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcQuerySenderBase

adjustQueryAndParameterListForNamedParameters, closeConnectionForSendMessage, convertQuery, executeOtherQuery, executeOtherQuery, executePackageQuery, executeSelectQuery, executeSelectQuery, executeStatementSet, executeUpdateBlobQuery, executeUpdateClobQuery, fillParamArray, getBatchSize, getCallWithRowIdReturned, getConnectionForSendMessage, getQueryExecutionContext, getQueryTypeEnum, getResult, getResult, getResult, getReturnedColumns, getStatement, open, prepareQuery, provideOutputStream, setAvoidLocking, setBlobBase64Direction, setBlobCharset, setBlobColumn, setBlobsCompressed, setBlobSessionKey, setBlobSmartGet, setClobColumn, setClobSessionKey, setCloseInputstreamOnExit, setCloseOutputstreamOnExit, setColumnsReturned, setIncludeFieldDefinition, setLockRows, setLockWait, setMaxRows, setNullValue, setOutputFormat, setPackageContent, setPrettyPrint, setQueryType, setResultQuery, setRowIdSessionKey, setScalar, setScalarExtended, setSqlDialect, setStartRow, setStreamCharset, setStreamResultToServlet, setSynchronous, setTrimSpaces, setUseNamedParams, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcSenderBase

addParameter, close, getParameterList, getTimeout, sendMessage, setTimeout, toString

Methods inherited from class nl.nn.adapterframework.jdbc.JdbcFacade

getAuthAlias, getConnection, getConnectionWithTimeout, getDatasource, getDatasourceInfo, getDatasourceName, getDbmsSupport, getLogPrefix, getPassword, getPhysicalDestinationName, getUsername, isConnectionsArePooled, isTransacted, iterateOverStatistics, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setJmsRealm, setPassword, setTransacted, setUsername

Methods inherited from class nl.nn.adapterframework.jndi.JndiBase

getContext, getJndiEnv, setAuthentication, setCredentials, setInitialContextFactoryName, setJndiAuthAlias, setJndiContextPrefix, setJndiProperties, setName, setPrincipal, setProviderURL, setSecurityProtocol, setUrlPkgPrefixes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

consumesSessionVariable

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

isSynchronous, sendMessageOrThrow

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

getName, setName

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 org.springframework.context.ApplicationContextAware

setApplicationContext

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

getDomain

Constructor Detail

FixedQuerySender

public FixedQuerySender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

ConfigurationException

getQuery

protected String getQuery(Message message)

Description copied from class: JdbcQuerySenderBase

Obtain a query to be executed. Method-stub to be overridden in descender-classes.

Specified by:

getQuery in class JdbcQuerySenderBase<QueryExecutionContext>

canProvideOutputStream

protected boolean canProvideOutputStream()

Overrides:

canProvideOutputStream in class JdbcQuerySenderBase<QueryExecutionContext>

openBlock

public QueryExecutionContext openBlock(PipeLineSession session)
                                throws SenderException,
                                       TimeoutException

Description copied from interface: IBlockEnabledSender

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

Throws:

SenderException

TimeoutException

closeBlock

public void closeBlock(QueryExecutionContext blockHandle,
                       PipeLineSession session)
                throws SenderException

Description copied from interface: IBlockEnabledSender

close the resource that is opened by IBlockEnabledSender.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

prepareStatementSet

protected QueryExecutionContext prepareStatementSet(QueryExecutionContext blockHandle,
                                                    Connection connection,
                                                    Message message,
                                                    PipeLineSession session)
                                             throws SenderException

Overrides:

prepareStatementSet in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

SenderException

closeStatementSet

protected void closeStatementSet(QueryExecutionContext statementSet,
                                 PipeLineSession session)

Overrides:

closeStatementSet in class JdbcQuerySenderBase<QueryExecutionContext>

sendMessage

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

Throws:

SenderException

TimeoutException

sendMessage

public PipeRunResult sendMessage(Message message,
                                 PipeLineSession session,
                                 IForwardTarget next)
                          throws SenderException,
                                 TimeoutException

Throws:

SenderException

TimeoutException

sendMessageOnConnection

protected final PipeRunResult sendMessageOnConnection(Connection connection,
                                                      Message message,
                                                      PipeLineSession session,
                                                      IForwardTarget next)
                                               throws SenderException,
                                                      TimeoutException

Overrides:

sendMessageOnConnection in class JdbcQuerySenderBase<QueryExecutionContext>

Throws:

SenderException

TimeoutException

setQuery

public void setQuery(String query)

The SQL query text to be excecuted each time sendMessage() is called

setBatchSize

public void setBatchSize(int batchSize)

When set larger than 0 and used as a child of an IteratingPipe, then the database calls are made in batches of this size. Only for queryType=other.

Default value

0