Package org.frankframework.jdbc

Class FixedQuerySender

java.lang.Object

org.frankframework.jdbc.JdbcFacade

org.frankframework.jdbc.AbstractJdbcSender<QueryExecutionContext>

org.frankframework.jdbc.AbstractJdbcQuerySender<QueryExecutionContext>

org.frankframework.jdbc.FixedQuerySender

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IBlockEnabledSender<QueryExecutionContext>, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IXAEnabled, NameAware, ConfigurableLifecycle, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

Direct Known Subclasses:

ResultSet2FileSender, StoredProcedureQuerySender

public class FixedQuerySender
extends AbstractJdbcQuerySender<QueryExecutionContext>

QuerySender that assumes a fixed query, possibly with attributes. Example of a XML result:

 <result>
     <fielddefinition>
         <field name="FIELDNAME"
             type="columnType"
             columnDisplaySize=""
             precision=""
             scale=""
             isCurrency=""
             columnTypeName=""
             columnClassName=""/>
         <field ...../>
     </fielddefinition>
     <rowset>
         <row number="1">
             <field name="FIELDNAME">value</field>
             <field name="FIELDNAME" null="true"></field>
             <field name="FIELDNAME">value</field>
             <field name="FIELDNAME">value</field>
         </row>
     </rowset>
 </result>
 

See DB2XMLWriter for more information about the 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 org.frankframework.jdbc.AbstractJdbcQuerySender

AbstractJdbcQuerySender.QueryType

Field Summary

Fields inherited from class org.frankframework.jdbc.AbstractJdbcQuerySender

UNP_END, UNP_START

Fields inherited from class org.frankframework.jdbc.AbstractJdbcSender

connection, paramList

Fields inherited from class org.frankframework.jdbc.JdbcFacade

log

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
FixedQuerySender()

Method Summary

Modifier and Type	Method	Description
void	closeBlock(QueryExecutionContext blockHandle, PipeLineSession session)	close the resource that is opened by IBlockEnabledSender.openBlock(PipeLineSession).
protected void	closeStatementSet(QueryExecutionContext statementSet)
void	configure()	Configure this component.
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.
SenderResult	sendMessage(QueryExecutionContext blockHandle, Message message, PipeLineSession session)
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 executed each time sendMessage() is called

Methods inherited from class org.frankframework.jdbc.AbstractJdbcQuerySender

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

Methods inherited from class org.frankframework.jdbc.AbstractJdbcSender

addParameter, getConnection, getParameterList, sendMessage, setTimeout, stop, toString

Methods inherited from class org.frankframework.jdbc.JdbcFacade

getConnectionWithTimeout, getDatasource, getDatasourceName, getDbmsSupport, getLogPrefix, getPassword, getPhysicalDestinationName, isConnectionsArePooled, isRunning, isTransacted, setAuthAlias, setConnectionsArePooled, setDatasourceName, setDbmsSupportFactory, setName, setPassword, setTransacted, setUsername

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle

getPhase, isAutoStartup, isConfigured

Methods inherited from interface org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface org.frankframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface org.frankframework.core.NameAware

setName

Methods inherited from interface org.springframework.context.SmartLifecycle

stop

Constructor Details

FixedQuerySender

public FixedQuerySender()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

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

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractJdbcQuerySender<QueryExecutionContext>

Throws:

ConfigurationException - in case it was not able to configure the component.

getQuery

protected String getQuery(Message message)

Description copied from class: AbstractJdbcQuerySender

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

Specified by:

getQuery in class AbstractJdbcQuerySender<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)

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.

closeStatementSet

protected void closeStatementSet(QueryExecutionContext statementSet)

Overrides:

closeStatementSet in class AbstractJdbcQuerySender<QueryExecutionContext>

sendMessage

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

Throws:

SenderException

TimeoutException

setQuery

public void setQuery(String query)

The SQL query text to be executed 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